]> git.pond.sub.org Git - empserver/blob - README
Rewrite top-level README for new build process. Merge information
[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 Autoconf and Automake to be installed.
25
26 (2) Building a server
27
28     Requirements: GNU make and GNU troff (`groff'), ANSI C, Perl,
29     Bourne Shell and the common utilities.
30
31     See file `INSTALL' for detailed compilation and installation
32     instructions.  Quick guide for the impatient: run configure; make;
33     make install.  The last step is optional; everything runs fine
34     right from the build tree.
35
36 (3) Creating a game
37
38     * Create a configuration for your game.  make install installs one
39       in $prefix/etc/empire/econfig ($prefix is /usr/local unless you
40       chose something else with configure).  You can use pconfig to
41       create another one.
42
43     * Edit your configuration file.  See doc/econfig for more
44       information.
45
46       Unless you put your configuration file in the default location
47       (where make install installs it), you have to use -e with all
48       programs to make them use your configuration.
49
50     * Run files to set up your data directory.
51
52     * Run fairland to create a world.  For a sample world, try
53       `fairland 10 30'.  This creates file ./newcap_script, which will
54       be used below.  You can edit it to change country names and
55       passwords.
56
57       Check out fairland's manual page for more information.
58
59     * Start the server.  For development, you want to run it with -d
60       in a debugger, see doc/debugging.  Do not use -d for a real
61       game!
62
63     * Log in as deity POGO with password peter.  This guide assumes
64       you use the included client `empire', but other clients should
65       work as well.
66
67       For help, try `info'.
68
69       To change the deity password, use `change re <password>'.
70
71       FIXME auth
72
73     * Create countries with `exec newcap_script'.
74
75     Your game is now up!
76
77 Naturally, there's more to running a real game than that, but that's
78 beyond the scope of this file.
79
80 Please report bugs to <wolfpack@wolfpackempire.com> or via SourceForge
81 http://sourceforge.net/projects/empserver (registration required).
82
83 For more information or help, try rec.games.empire on Usenet, or send
84 e-mail to <wolfpack@wolfpackempire.com> and we'll try to answer if we
85 can.  Also check out our web site at "http://www.wolfpackempire.com".
86
87 Have fun!
88
89 Wolfpack!