]> git.pond.sub.org Git - empserver/blob - README
COPYING duplicates information from README. Remove. Move GPL from
[empserver] / README
1 Welcome to Empire 4, codenamed Wolfpack.  Congratulations on your choice!
2
3 See files README, COPYING and CREDITS in the root of the source
4 tree for related information and legal notices.  It is expected
5 that future projects/authors will amend these files as needed.
6
7 For questions and comments, please contact "wolfpack@wolfpackempire.com".
8
9 If you want to build the server, follow the few simple steps below.  If
10 you are looking for more information on the files here, options for
11 the server, etc. take a look in the "doc" directory, then follow the steps
12 below to build and start the server.
13
14 (1) Unpacking the server
15   If you're building from a tarball, unpack it.
16   If you're building from CVS, check out and run bootstrap.  This
17   requires Autoconf and Automake to be installed.
18
19 (2) Building a server
20   Note that you may not have to build a server.  If you received the
21   server in binary format, go to the next step, "Creating the world."
22
23   To build the server, you need to do the following steps:
24 FIXME needs work
25
26   1) Get a copy of the source.  Since you're reading this, we assume
27      you have done that. 
28   2) Gunzip the source.  Again, since you're reading this . . . ;-)
29   3) Run configure.
30   4) Run make.  You need GNU make.
31
32 (3) Creating the world
33   (NOTE: If you received a binary, you must edit the included data/econfig
34    file to represent the paths where your data and info directories are.)
35   1) First, pick the world size you want to use.  Once you have chosen
36      a world size, edit the "data/econfig" file (it was either created
37      at build time, or shipped with the binary) and change the WORLD_X
38      and WORLD_Y to be the sizes you want. The default world size is 64x32.
39      IMPORTANT: WORLD_X *MUST* be divisible by 2.  In addition, if you
40      change the world size later, you *MUST* re-create the world by
41      running "bin/files" again.
42   2) Go into the "bin" directory, and run "./files".
43   3) If you want to create a new world, run "./fairland 10 30" to create
44      a sample world (read the documentation for fairland for more info on
45      it's arguments.)
46   Note that "files" and "fairland" use the world size in the econfig file
47   if it exists in the data directory.  If this file doesn't exist, and you
48   don't specify one, it will use the default world size the server was
49   compiled with (Wolfpack binaries ship with a 64x32 world size)  You can
50   create an econfig file with default values using the "bin/pconfig"
51   executable.
52
53 (4) Running the server
54   1) Run the bin/emp_server executable to start the server.
55
56 That's it.  Once running, you can log on to the server using the emp_client
57 program found in the "bin" directory.  The initial deity country name/password
58 is POGO/peter.
59
60 If you get a "You're not a deity!" message and logged off, check the
61 "data/server.log" file and look at the end for a "NON-AUTH" entry.
62 There should be a "user@host" message in there that failed to log in.
63 Enter this user and host in the auth file, and you should be able to
64 log into the server as a deity now.
65
66 For more information on options, programs, files and other general hints
67 look in the "doc" directory.  The README there describes the files there and
68 what they talk about.
69
70 For more information or help, send e-mail to "wolfpack@wolfpackempire.com" and
71 we'll try to answer if we can.  Also check out our web site at
72 "http://www.wolfpackempire.com"
73
74 Have fun!
75
76  -- The Wolfpack development team...