joinsparts.pl plugin update by merlijn
[divverent/nexuiz.git] / server / readme.txt
1 This subdirectory contains scripts and a config file that can be used\r
2 to start a dedicated Nexuiz (default) or Nexuiz Havoc server (differs\r
3 in movement, weapon and other settings) on linux, mac or windows\r
4 systems and also some tools that help with maintaining your server.\r
5 \r
6 You will need to copy the right script into your Nexuiz main\r
7 directory, where the normal binaries are.  There are two scrips for\r
8 each sytems, one to start a normal Nexuiz server and one to start a\r
9 Nexuiz 'Havoc' server.  You then need to copy and ADJUST the config\r
10 file which is called server.cfg.  You can copy it either into the\r
11 Nexuiz/data directory where the big data*.pk3 file is or when running\r
12 on linux or mac you can as well copy it into a special directory\r
13 called '~/.nexuiz/data'.  After you have setup everything and have\r
14 adjusted the config file you can start the server by running the\r
15 server script.\r
16 \r
17 Please make sure your server is always uptodate!  Just signup the\r
18 Nexuiz release mailinglist to get informed about new releases.\r
19 https://lists.sourceforge.net/lists/listinfo/nexuiz-releases\r
20 \r
21 An important thing is to make sure that your firewall does allow\r
22 players to connect to your server.  This typicly means you will have\r
23 to open or forward the port (see the line that sets the variable port\r
24 in your config.cfg for the right port number, default is 26000) to the\r
25 computer running your server.  How to do this does depend on your\r
26 computer and network setup.\r
27 \r
28 If you plan to install custom maps on your server you should read the\r
29 file Nexuiz/Docs/mapdownload.txt to learn how to setup automatic map\r
30 download.\r
31 \r
32 In case you want to rename the server.cfg file, e.g. because you want\r
33 to run several servers on one machine, you have to edit the script and\r
34 change the name there too.\r
35 \r
36 A very useful tool for running and controlling a server is the\r
37 application 'gnu screen'.  It should be available for all usual\r
38 operating systems.  You can find some hints about its usage here:\r
39 http://jmcpherson.org/screen.html\r
40 \r
41 The options in the config file are only the most interesting and\r
42 important ones.  You can get a list of all available commands and\r
43 variables with 'cmdlist' and 'cvarlist' in the server console.\r
44 \r
45 rcon.pl is a perl script that implements rcon which can be used to\r
46 remotely control your server.\r
47 \r
48 rcon2irc is a Nexuiz server to irc gateway.  It allows you to watch\r
49 and communicate with active players on your server via irc.  Read its\r
50 rcon2irc.txt to learn how to setup and use it!\r
51 \r
52 help.cfg is a Nexuiz config file providing a simple help message\r
53 system.  It prints all the messages from a list, one after the other\r
54 with an configureable delay between them.  Great to provide beginners\r
55 with some hints.\r