1**************************************************************************
2* For the impatient (try this first, then come back if it doesn't work)  *
3**************************************************************************
40. "make"
51. "./xtux"
62. Select "play", then "Start New Game" in the menu.
7
8****************
9* REQUIREMENTS *
10****************
11To run XTux (client) you will need:
12
13* X11 libraries
14* Xpm libraries
15
16Most Linux and FreeBSD distributions have both of these libraries already
17present. The latest Xpm libraries can be obtained from ftp://ftp.x.org/contrib
18in the libraries directory.
19
20The server doesn't use X and just needs the c/unix/socket libraries.
21
22****************
23* INSTALLATION *
24****************
25
261. Put the data directory where you want it to go (or just leave it)
272. Edit the toplevel Makefile and change DATADIR to the FULL path of the
28   data directory. (default is "data", which should be ok unless you move it)
293. Change the Makefile(s) to suit your system. Probably the only one you'll
30   have to change is the X11_PATH variable in "src/client/Makefile". Solaris
31   users will have to add -lsocket and -lnsl (from memory) because the network
32   libraries are not linked against by default. Sun also puts X in weird places.
334. Type "make". This will build the common libraries then the client and server
34   binaries.
35
36********************
37* Playing the game *
38********************
39
40You can configure the controls to be the same as most first person shooters.
41Remember to turn mouse-mode on in the menu.
42
43If you wish to run the server on your machine, start a server with the
44command "tux_serv" or "tux_serv -m MAP_NAME.map" to specify a specific map.
45(for more info on the server, type "tux_serv -h")
46The default frames per second is 40, this may be too high for interet play
47on slow connections, try "tux_serv -f 15"
48
49*************************
50* HACKING/ CONTRIBUTING *
51*************************
52
53Changing how the weapons or entities work is pretty easy. For example, edit
54the "data/weapons" file, and scroll down until you see the [RAILGUN] section.
55Remove the "#" that is infront of the lines "number", "spread" and "reload_time"
56at the end of the entry.
57
58Try changing around some of the other variables and see what they do.
59Stupidly high values are often quite fun. Add the lines "number 50" and
60"spread 255" to the end of the [EGUN] entry for a ridiculously powerful weapon.
61
62Now load the slashdot map and see how the new weapons behave.
63You will need to close and reload the program for the new values to have an
64effect. Have fun!
65
66A link to the XTux-devel mailing list is on http://xtux.sourceforge.net
67
68