info/retreat info/lretreat: Fix truncated glossary list items
[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-2017, Dave Pare, Jeff Bailey, Thomas Ruschak,
5 Ken Stevens, Steve McClure, Markus Armbruster
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 3 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 cloned a git repository, run bootstrap.  This requires
24     recent versions of Autoconf and Automake to be installed.  See
25     also doc/contributing.
26
27 (2) Building a server
28
29     Prerequisites: IEEE Std 1003.1-2001 (POSIX.1-2001), GNU make, a
30     curses library, Perl, and either nroff or GNU troff (`groff').
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 configure reports "readline: no" in its configuration summary,
38     fancy line editing doesn't work in the client.  Commonly caused by
39     not having development libraries installed.  On Linux, try
40     installing readline-devel.
41
42     If configure reports "terminfo: no" in its configuration summary,
43     highlighting doesn't work in the client.  Commonly caused by not
44     having development libraries installed.  On Linux, try installing
45     ncurses-devel.
46
47     If make fails without doing anything, you're probably not using
48     GNU make.  Some systems have it installed as `gmake'.
49
50     Solaris supports POSIX.1-2001, but you need to set up your
51     environment for that.  Try passing
52         SHELL=/usr/xpg4/bin/sh PATH=/usr/xpg6/bin:/usr/xpg4/bin:$PATH
53     to make.  See standards(5) for details.
54
55 (3) Creating a game
56
57     * Create a configuration for your game.  make install installs one
58       in $prefix/etc/empire/econfig ($prefix is /usr/local unless you
59       chose something else with configure).  You can use pconfig to
60       create another one.
61
62     * Edit your configuration file.  See doc/econfig for more
63       information.
64
65       Unless you put your configuration file in the default location
66       (where make install installs it), you have to use -e with all
67       programs to make them use your configuration.
68
69     * Run files to set up your data directory.
70
71     * Run fairland to create a world.  For a sample world, try
72       `fairland 10 30'.  This creates file ./newcap_script, which will
73       be used below.  You can edit it to change country names and
74       passwords.
75
76       Check out fairland's manual page for more information.
77
78     * Start the server.  For development, you want to run it with -d
79       in a debugger, see doc/debugging.  Do not use -d for a real
80       game!
81
82     * Log in as deity POGO with password peter.  This guide assumes
83       you use the included client `empire', but other clients should
84       work as well.
85
86       For help, try `info'.
87
88       To change the deity password, use `change re <password>'.
89
90     * Create countries with `exec newcap_script'.
91
92     Your game is now up!
93
94 Naturally, there's more to running a real game than that, but that's
95 beyond the scope of this file.
96
97 Please report bugs to <wolfpack@wolfpackempire.com> or via SourceForge
98 <http://sourceforge.net/projects/empserver/> (registration required).
99
100 For more information or help, try rec.games.empire on Usenet, or send
101 e-mail to <wolfpack@wolfpackempire.com> and we'll try to answer if we
102 can.  Also check out our web site at <http://www.wolfpackempire.com/>.
103
104 Have fun!
105
106 Wolfpack!