]> git.pond.sub.org Git - empserver/blob - README
Simplify recvclient() to return -1 for all failures
[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-2011, 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.
25
26 (2) Building a server
27
28     Prerequisites: IEEE Std 1003.1-2001 (POSIX.1-2001), GNU make, a
29     curses library, Perl, and either nroff or GNU troff (`groff').
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     If make fails without doing anything, you're probably not using
37     GNU make.  Some systems have it installed as `gmake'.
38
39     Solaris supports POSIX.1-2001, but you need to set up your
40     environment for that.  Try passing
41         SHELL=/usr/xpg4/bin/sh PATH=/usr/xpg6/bin:/usr/xpg4/bin:$PATH
42     to make.  See standards(5) for details.
43
44 (3) Creating a game
45
46     * Create a configuration for your game.  make install installs one
47       in $prefix/etc/empire/econfig ($prefix is /usr/local unless you
48       chose something else with configure).  You can use pconfig to
49       create another one.
50
51     * Edit your configuration file.  See doc/econfig for more
52       information.
53
54       Unless you put your configuration file in the default location
55       (where make install installs it), you have to use -e with all
56       programs to make them use your configuration.
57
58     * Run files to set up your data directory.
59
60     * Run fairland to create a world.  For a sample world, try
61       `fairland 10 30'.  This creates file ./newcap_script, which will
62       be used below.  You can edit it to change country names and
63       passwords.
64
65       Check out fairland's manual page for more information.
66
67     * Start the server.  For development, you want to run it with -d
68       in a debugger, see doc/debugging.  Do not use -d for a real
69       game!
70
71     * Log in as deity POGO with password peter.  This guide assumes
72       you use the included client `empire', but other clients should
73       work as well.
74
75       For help, try `info'.
76
77       To change the deity password, use `change re <password>'.
78
79     * Create countries with `exec newcap_script'.
80
81     Your game is now up!
82
83 Naturally, there's more to running a real game than that, but that's
84 beyond the scope of this file.
85
86 Please report bugs to <wolfpack@wolfpackempire.com> or via SourceForge
87 http://sourceforge.net/projects/empserver (registration required).
88
89 For more information or help, try rec.games.empire on Usenet, or send
90 e-mail to <wolfpack@wolfpackempire.com> and we'll try to answer if we
91 can.  Also check out our web site at "http://www.wolfpackempire.com".
92
93 Have fun!
94
95 Wolfpack!