Clarify prerequisites.
[empserver] / README
1 Welcome to Empire 4, code-named Wolfpack.
2
3 Empire is a multi-player, client/server Internet based war game.
4 Copyright (C) 1986-2006, Dave Pare, Jeff Bailey, Thomas Ruschak, Ken
5 Stevens, Steve McClure
6
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License (in file
10 `COPYING'), or (at your option) any later version.
11
12 See file `CREDITS' for a list of contributors.
13
14 Directory `doc' has additional information.  File `doc/README'
15 describes the files there and what they talk about.
16
17 To build the server and set up a game, follow the steps below.
18
19 (1) Unpacking the source tree
20
21     If you downloaded a tarball, unpack it.
22
23     If you're pulling from CVS, check out and run bootstrap.  This
24     requires recent versions of Autoconf and Automake to be installed.
25
26 (2) Building a server
27
28     Prerequisites: GNU make and, ANSI C, a curses library, Perl, nroff
29     or GNU troff (`groff'), Bourne Shell and the common utilities,
30     conforming to the Single UNIX Specification Version 2.
31
32     See file `INSTALL' for detailed compilation and installation
33     instructions.  Quick guide for the impatient: run configure; make;
34     make install.  The last step is optional; everything runs fine
35     right from the build tree.
36
37     If make fails without doing anything, you're probably not using
38     GNU make.  Some systems have it installed as `gmake'.
39
40     Solaris supports SUSv2, but you need to set up your environment
41     for that.  Try passing
42         SHELL=/usr/xpg4/bin/sh PATH=/usr/xpg4/bin:$PATH
43     to make.  See standards(5) for details.
44
45 (3) Creating a game
46
47     * Create a configuration for your game.  make install installs one
48       in $prefix/etc/empire/econfig ($prefix is /usr/local unless you
49       chose something else with configure).  You can use pconfig to
50       create another one.
51
52     * Edit your configuration file.  See doc/econfig for more
53       information.
54
55       Unless you put your configuration file in the default location
56       (where make install installs it), you have to use -e with all
57       programs to make them use your configuration.
58
59     * Run files to set up your data directory.
60
61     * Run fairland to create a world.  For a sample world, try
62       `fairland 10 30'.  This creates file ./newcap_script, which will
63       be used below.  You can edit it to change country names and
64       passwords.
65
66       Check out fairland's manual page for more information.
67
68     * Start the server.  For development, you want to run it with -d
69       in a debugger, see doc/debugging.  Do not use -d for a real
70       game!
71
72     * Log in as deity POGO with password peter.  This guide assumes
73       you use the included client `empire', but other clients should
74       work as well.
75
76       For help, try `info'.
77
78       To change the deity password, use `change re <password>'.
79
80     * Create countries with `exec newcap_script'.
81
82     Your game is now up!
83
84 Naturally, there's more to running a real game than that, but that's
85 beyond the scope of this file.
86
87 Please report bugs to <wolfpack@wolfpackempire.com> or via SourceForge
88 http://sourceforge.net/projects/empserver (registration required).
89
90 For more information or help, try rec.games.empire on Usenet, or send
91 e-mail to <wolfpack@wolfpackempire.com> and we'll try to answer if we
92 can.  Also check out our web site at "http://www.wolfpackempire.com".
93
94 Have fun!
95
96 Wolfpack!