From a4ba6c74613e8726a306b2aed54b79a8ab41b5ec Mon Sep 17 00:00:00 2001 From: Rudolf Polzer Date: Wed, 24 Aug 2011 23:07:50 +0200 Subject: [PATCH 1/1] do the same in the server directory too --- server/.gitattributes | 1 + server/rcon2irc/rcon2irc.txt | 192 +++++++++++++++++------------------ server/readme.txt | 104 +++++++++---------- 3 files changed, 149 insertions(+), 148 deletions(-) create mode 100644 server/.gitattributes diff --git a/server/.gitattributes b/server/.gitattributes new file mode 100644 index 00000000..f96575f2 --- /dev/null +++ b/server/.gitattributes @@ -0,0 +1 @@ +*.txt -crlf diff --git a/server/rcon2irc/rcon2irc.txt b/server/rcon2irc/rcon2irc.txt index 4625aaa1..245bd9ec 100644 --- a/server/rcon2irc/rcon2irc.txt +++ b/server/rcon2irc/rcon2irc.txt @@ -1,96 +1,96 @@ -rcon2irc - IRC gateway for Xonotic servers, using rcon authorization - - -Quick installation guide: - -1. Set up rcon access on your Xonotic server, by adding some line like - rcon_password hackme - in your server.cfg. This password gives anyone FULL access to your server, - so do not give it away! This IRC gateway does not work with a - rcon_restricted_password. - -2. Copy rcon2irc-example.conf to another name (e.g. rcon2irc.conf), and edit - the settings to match your setup. At the very least: - - change dp_server to the IP (or IP:port) of your Xonotic server - - change dp_password to the rcon password set above - - change irc_server to the IRC server to connect to - - change irc_nick to the nick name to use - - change irc_channel to the channel to join - -3. Run it: - perl rcon2irc.pl rcon2irc.conf - You may possibly want to run it in nohup so you can disconnect from your ssh - connection, like this: - nohup perl rcon2irc.pl rcon2irc.conf & - Logging will then go to a file nohup.out in the same directory. Another way - to run it permanently and to see its output is to run it inside a screen(1). - - -Features: - -- Show results of matches in the IRC channel - -- Act as a gateway to allow chat between Xonotic server and IRC users, useful - for making the server more interesting to the public, but also useful as a - mere helper for the server admin to watch what's happening in game (like, if - people complain about a problem): - - Any line written in game using say (not say_team) goes to the IRC channel. - - Any line written in the channel, prefixed by the bot's nick name and a :, - goes into the Xonotic game. - - Example: - View in game: - XSAX LTU: GREAT WIN AHAHAHAHAHAHAHAHAH)) - (RedAlert) stop teamkilling! - .ThreeHeadedMonkey.: I am behind you! - View on IRC, assuming the IRC gateway has the nick noobXon and is voiced: - <+noobXon> GREAT WIN AHAHAHAHAHAHAHAHAH)) - <+noobXon> <.ThreeHeadedMonkey.> I am behind you! - -- Notify about free slots on the server. Example: - * noobXon is full! - * noobXon can be joined again (2 free slots); join now: xonotic +connect 172.23.42.54! - <+noobXon> ctf_capturecity_v2r1 has begun (2 free slots); join now: xonotic +connect 172.23.42.54 - -- Display scores at the end of a match in the IRC channel. Example: - <+noobXon> ctf_capturecity_v2r1 ended: 301:78 Nicole 115, elsteer BLD {Y} 77, - CensoredNickname 57, 0grueN# 29, Bigus 23, ZeroA 36, ricer 22, - Treey@suse8 12, cZaR6RUSS7 8, BrightDev1l 0 - -- Authenticate to the IRC services by Nickserv or Quakenet protocol, so the - server bot can be set up to always get voice when entering the channel, and - in case of Nickserv, make sure nobody else prevents it from using its - configured nick. Other authentication protocols can often be set up using - configuration, and if not, as plugin. - -- Support for /whois queries: the server hostname is put into the real name - field for /whois, so people can see how to find the server in the server - list. - -- Plugin interface for plugins written in Perl. See included rbiserver.pl for - an example. - - -License: - -Copyright (c) 2008 Rudolf "divVerent" Polzer - -Permission is hereby granted, free of charge, to any person -obtaining a copy of this software and associated documentation -files (the "Software"), to deal in the Software without -restriction, including without limitation the rights to use, -copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the -Software is furnished to do so, subject to the following -conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES -OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT -HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, -WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR -OTHER DEALINGS IN THE SOFTWARE. +rcon2irc - IRC gateway for Xonotic servers, using rcon authorization + + +Quick installation guide: + +1. Set up rcon access on your Xonotic server, by adding some line like + rcon_password hackme + in your server.cfg. This password gives anyone FULL access to your server, + so do not give it away! This IRC gateway does not work with a + rcon_restricted_password. + +2. Copy rcon2irc-example.conf to another name (e.g. rcon2irc.conf), and edit + the settings to match your setup. At the very least: + - change dp_server to the IP (or IP:port) of your Xonotic server + - change dp_password to the rcon password set above + - change irc_server to the IRC server to connect to + - change irc_nick to the nick name to use + - change irc_channel to the channel to join + +3. Run it: + perl rcon2irc.pl rcon2irc.conf + You may possibly want to run it in nohup so you can disconnect from your ssh + connection, like this: + nohup perl rcon2irc.pl rcon2irc.conf & + Logging will then go to a file nohup.out in the same directory. Another way + to run it permanently and to see its output is to run it inside a screen(1). + + +Features: + +- Show results of matches in the IRC channel + +- Act as a gateway to allow chat between Xonotic server and IRC users, useful + for making the server more interesting to the public, but also useful as a + mere helper for the server admin to watch what's happening in game (like, if + people complain about a problem): + - Any line written in game using say (not say_team) goes to the IRC channel. + - Any line written in the channel, prefixed by the bot's nick name and a :, + goes into the Xonotic game. + - Example: + View in game: + XSAX LTU: GREAT WIN AHAHAHAHAHAHAHAHAH)) + (RedAlert) stop teamkilling! + .ThreeHeadedMonkey.: I am behind you! + View on IRC, assuming the IRC gateway has the nick noobXon and is voiced: + <+noobXon> GREAT WIN AHAHAHAHAHAHAHAHAH)) + <+noobXon> <.ThreeHeadedMonkey.> I am behind you! + +- Notify about free slots on the server. Example: + * noobXon is full! + * noobXon can be joined again (2 free slots); join now: xonotic +connect 172.23.42.54! + <+noobXon> ctf_capturecity_v2r1 has begun (2 free slots); join now: xonotic +connect 172.23.42.54 + +- Display scores at the end of a match in the IRC channel. Example: + <+noobXon> ctf_capturecity_v2r1 ended: 301:78 Nicole 115, elsteer BLD {Y} 77, + CensoredNickname 57, 0grueN# 29, Bigus 23, ZeroA 36, ricer 22, + Treey@suse8 12, cZaR6RUSS7 8, BrightDev1l 0 + +- Authenticate to the IRC services by Nickserv or Quakenet protocol, so the + server bot can be set up to always get voice when entering the channel, and + in case of Nickserv, make sure nobody else prevents it from using its + configured nick. Other authentication protocols can often be set up using + configuration, and if not, as plugin. + +- Support for /whois queries: the server hostname is put into the real name + field for /whois, so people can see how to find the server in the server + list. + +- Plugin interface for plugins written in Perl. See included rbiserver.pl for + an example. + + +License: + +Copyright (c) 2008 Rudolf "divVerent" Polzer + +Permission is hereby granted, free of charge, to any person +obtaining a copy of this software and associated documentation +files (the "Software"), to deal in the Software without +restriction, including without limitation the rights to use, +copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the +Software is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +OTHER DEALINGS IN THE SOFTWARE. diff --git a/server/readme.txt b/server/readme.txt index 50b44c17..7fdc1a9e 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 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 +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. -- 2.39.2