]> git.xonotic.org Git - xonotic/xonotic.git/blobdiff - server/readme.txt
Update cvars in mapdownload.txt
[xonotic/xonotic.git] / server / readme.txt
index 50b44c17de80e32fe2f57c02ab662b14bc00552b..7c71d6173d624387a1e29341504239175d0a35b0 100644 (file)
@@ -1,52 +1,49 @@
-This subdirectory contains scripts and a config file that can be used
-to start a dedicated Xonotic server on linux, mac or windows systems
-and also some tools that help with maintaining your server.
-
-You will need to copy the right script for your system into your
-Xonotic main directory, where the normal binaries are.  You then need
-to copy and ADJUST the config file which is called server.cfg.  You
-can copy it either into the Xonotic/data directory where the big
-data*.pk3 file is or when running on linux or mac you can as well copy
-it into a special directory named '~/.xonotic/data'.  After you have
-setup everything and have adjusted the config file you can start the
-server by running the server script.
-
-Please make sure your server is always uptodate!  Just signup the
-Xonotic release mailinglist to get informed about new releases.
-https://lists.sourceforge.net/lists/listinfo/xonotic-releases
-
-An important thing is to make sure that your firewall does allow
-players to connect to your server.  This typicly means you will have
-to open or forward the port (see the line that sets the variable port
-in your config.cfg for the right port number, default is 26000) to the
-computer running your server.  How to do this does depend on your
-computer and network setup.
-
-If you plan to install custom maps on your server you should read the
-file Xonotic/Docs/mapdownload.txt to learn how to setup automatic map
-download.
-
-In case you want to rename the server.cfg file, e.g. because you want
-to run several servers on one machine, you have to edit the script and
-change the name there too.
-
-A very useful tool for running and controlling a server is the
-application 'gnu screen'.  It should be available for all usual
-operating systems.  You can find some hints about its usage here:
-http://jmcpherson.org/screen.html
-
-The options in the config file are only the most interesting and
-important ones.  You can get a list of all available commands and
-variables with 'cmdlist' and 'cvarlist' in the server console.
-
-rcon.pl is a perl script that implements rcon which can be used to
-remotely control your server.
-
-rcon2irc is a Xonotic server to irc gateway.  It allows you to watch
-and communicate with active players on your server via irc.  Read its
-rcon2irc.txt to learn how to setup and use it!
-
-help.cfg is a Xonotic config file providing a simple help message
-system.  It prints all the messages from a list, one after the other
-with an configureable delay between them.  Great to provide beginners
-with some hints.
+This subdirectory contains scripts and a config file that can be used\r
+to start a dedicated Xonotic server on Linux, Mac and Windows systems\r
+and also some tools that help with maintaining your server.\r
+\r
+You will need to copy the right server_* script for your system into\r
+your Xonotic main directory, where the normal binaries are. \r
+You should then COPY the provided server.cfg to user's game directory\r
+(Linux: '~/.xonotic/data'\r
+ Mac: '~/Library/Application Support/xonotic/data'\r
+ Windows: '%UserProfile%\Saved Games\xonotic\data')\r
+\r
+After you have setup everything and have adjusted the config file \r
+you can start the server by running the server script.\r
+\r
+An important thing is to make sure that your firewall allows\r
+players to connect to your server.  This typically means you will have\r
+to open or forward the port (see the line that sets the variable port\r
+in your server.cfg for the right port number, default is 26000) to the\r
+computer running your server.  How to do this does depend on your\r
+computer and network setup.\r
+\r
+If you plan to install custom maps on your server you should read the\r
+file Xonotic/Docs/mapdownload.txt to learn how to setup automatic map\r
+downloads.\r
+\r
+In case you want to rename the server.cfg file (e.g. because you want\r
+to run several servers on one machine), you have to edit the script and\r
+change the name there too.\r
+\r
+A very useful tool for running and controlling a server is the\r
+application 'gnu screen'.  It should be available for all usual\r
+operating systems.  You can find some hints about its usage here:\r
+http://www.gnu.org/software/screen/manual/screen.html\r
+\r
+The options in the config file are only the most interesting and\r
+important ones.  You can get a list of all available commands and\r
+variables with 'cmdlist' and 'cvarlist' in the server console.\r
+\r
+rcon.pl is a perl script that implements rcon which can be used to\r
+remotely control your server.  Refer to the file itself for usage.\r
+\r
+rcon2irc is a Xonotic server to irc gateway.  It allows you to watch\r
+and communicate with active players on your server via irc.\r
+Refer to rcon2irc.txt for usage and instructions.\r
+\r
+help.cfg is a Xonotic config file providing a simple help message\r
+system.  It prints all the messages from a list, one after the other\r
+with an configureable delay between them.  Great to provide beginners\r
+with some hints.\r