Update cvars in mapdownload.txt
[xonotic/xonotic.git] / server / readme.txt
1 This subdirectory contains scripts and a config file that can be used\r
2 to start a dedicated Xonotic server on Linux, Mac and Windows systems\r
3 and also some tools that help with maintaining your server.\r
4 \r
5 You will need to copy the right server_* script for your system into\r
6 your Xonotic main directory, where the normal binaries are. \r
7 You should then COPY the provided server.cfg to user's game directory\r
8 (Linux: '~/.xonotic/data'\r
9  Mac: '~/Library/Application Support/xonotic/data'\r
10  Windows: '%UserProfile%\Saved Games\xonotic\data')\r
11 \r
12 After you have setup everything and have adjusted the config file \r
13 you can start the server by running the server script.\r
14 \r
15 An important thing is to make sure that your firewall allows\r
16 players to connect to your server.  This typically means you will have\r
17 to open or forward the port (see the line that sets the variable port\r
18 in your server.cfg for the right port number, default is 26000) to the\r
19 computer running your server.  How to do this does depend on your\r
20 computer and network setup.\r
21 \r
22 If you plan to install custom maps on your server you should read the\r
23 file Xonotic/Docs/mapdownload.txt to learn how to setup automatic map\r
24 downloads.\r
25 \r
26 In case you want to rename the server.cfg file (e.g. because you want\r
27 to run several servers on one machine), you have to edit the script and\r
28 change the name there too.\r
29 \r
30 A very useful tool for running and controlling a server is the\r
31 application 'gnu screen'.  It should be available for all usual\r
32 operating systems.  You can find some hints about its usage here:\r
33 http://www.gnu.org/software/screen/manual/screen.html\r
34 \r
35 The options in the config file are only the most interesting and\r
36 important ones.  You can get a list of all available commands and\r
37 variables with 'cmdlist' and 'cvarlist' in the server console.\r
38 \r
39 rcon.pl is a perl script that implements rcon which can be used to\r
40 remotely control your server.  Refer to the file itself for usage.\r
41 \r
42 rcon2irc is a Xonotic server to irc gateway.  It allows you to watch\r
43 and communicate with active players on your server via irc.\r
44 Refer to rcon2irc.txt for usage and instructions.\r
45 \r
46 help.cfg is a Xonotic config file providing a simple help message\r
47 system.  It prints all the messages from a list, one after the other\r
48 with an configureable delay between them.  Great to provide beginners\r
49 with some hints.\r