changed icon for carrying flag + psd
[divverent/nexuiz.git] / server / rcon2irc / rcon2irc.txt
1 rcon2irc - IRC gateway for Nexuiz servers, using rcon authorization
2
3
4 Quick installation guide:
5
6 1. Set up rcon access on your Nexuiz server, by adding some line like
7      rcon_password hackme
8    in your server.cfg. This password gives anyone FULL access to your server,
9    so do not give it away! This IRC gateway does not work with a
10    rcon_restricted_password.
11
12 2. Copy rcon2irc-example.conf to another name (e.g. rcon2irc.conf), and edit
13    the settings to match your setup. At the very least:
14    - change dp_server to the IP (or IP:port) of your Nexuiz server
15    - change dp_password to the rcon password set above
16    - change irc_server to the IRC server to connect to
17    - change irc_nick to the nick name to use
18    - change irc_channel to the channel to join
19    
20 3. Run it:
21      perl rcon2irc.pl rcon2irc.conf
22    You may possibly want to run it in nohup so you can disconnect from your ssh
23    connection, like this:
24      nohup perl rcon2irc.pl rcon2irc.conf &
25    Logging will then go to a file nohup.out in the same directory. Another way
26    to run it permanently and to see its output is to run it inside a screen(1).
27
28
29 Features:
30
31 - Show results of matches in the IRC channel
32
33 - Act as a gateway to allow chat between Nexuiz server and IRC users, useful
34   for making the server more interesting to the public, but also useful as a
35   mere helper for the server admin to watch what's happening in game (like, if
36   people complain about a problem):
37   - Any line written in game using say (not say_team) goes to the IRC channel.
38   - Any line written in the channel, prefixed by the bot's nick name and a :,
39     goes into the Nexuiz game.
40   - Example:
41     View in game:
42       XSAX LTU: GREAT WIN AHAHAHAHAHAHAHAHAH))
43       (RedAlert) stop teamkilling!
44       .ThreeHeadedMonkey.: I am behind you!
45     View on IRC, assuming the IRC gateway has the nick noobNex and is voiced:
46       <+noobNex> <XSAX LTU> GREAT WIN AHAHAHAHAHAHAHAHAH))
47       <+noobNex> <.ThreeHeadedMonkey.> I am behind you!
48
49 - Notify about free slots on the server. Example:
50     * noobNex is full!
51     * noobNex can be joined again (2 free slots); join now: nexuiz +connect 172.23.42.54!
52     <+noobNex> ctf_capturecity_v2r1 has begun (2 free slots); join now: nexuiz +connect 172.23.42.54
53
54 - Display scores at the end of a match in the IRC channel. Example:
55     <+noobNex> ctf_capturecity_v2r1 ended: 301:78 Nicole 115, elsteer BLD {Y} 77,
56                CensoredNickname 57, 0grueN# 29, Bigus 23, ZeroA 36, ricer 22,
57                Treey@suse8 12, cZaR6RUSS7 8, BrightDev1l 0
58
59 - Authenticate to the IRC services by Nickserv or Quakenet protocol, so the
60   server bot can be set up to always get voice when entering the channel, and
61   in case of Nickserv, make sure nobody else prevents it from using its
62   configured nick. Other authentication protocols can often be set up using
63   configuration, and if not, as plugin.
64
65 - Support for /whois queries: the server hostname is put into the real name
66   field for /whois, so people can see how to find the server in the server
67   list.
68
69 - Plugin interface for plugins written in Perl. See included rbiserver.pl for
70   an example.
71
72
73 License:
74
75 Copyright (c) 2008 Rudolf "divVerent" Polzer
76
77 Permission is hereby granted, free of charge, to any person
78 obtaining a copy of this software and associated documentation
79 files (the "Software"), to deal in the Software without
80 restriction, including without limitation the rights to use,
81 copy, modify, merge, publish, distribute, sublicense, and/or sell
82 copies of the Software, and to permit persons to whom the
83 Software is furnished to do so, subject to the following
84 conditions:
85
86 The above copyright notice and this permission notice shall be
87 included in all copies or substantial portions of the Software.
88
89 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
90 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
91 OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
92 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
93 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
94 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
95 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
96 OTHER DEALINGS IN THE SOFTWARE.