X-Git-Url: https://git.xonotic.org/?p=xonotic%2Fxonotic.git;a=blobdiff_plain;f=server%2Freadme.txt;h=50b44c17de80e32fe2f57c02ab662b14bc00552b;hp=27ebc1cb2fe0559fb29e1ce1908920a7013ba36d;hb=731e4a4f460f11c87d562f30b5d43a953a9c96bb;hpb=37578b037035324f40447e45eb8ae2dc7585c837;ds=sidebyside diff --git a/server/readme.txt b/server/readme.txt index 27ebc1cb..50b44c17 100644 --- a/server/readme.txt +++ b/server/readme.txt @@ -1,52 +1,52 @@ -This subdirectory contains scripts and a config file that can be used -to start a dedicated Nexuiz on linux, mac or windows systems and also -some tools that help with maintaining your server. - -You will need to copy the right script into your Nexuiz 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 Nexuiz/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 called '~/.nexuiz/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 -Nexuiz release mailinglist to get informed about new releases. -https://lists.sourceforge.net/lists/listinfo/nexuiz-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 Nexuiz/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 Nexuiz 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 Nexuiz 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 +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.