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