annotate README @ 150:e0eea72ea493

new bridge attribute "irc_connection_interval" (in seconds) Signed-off-by: Charly COSTE <changaco@changaco.net>
author Charly COSTE <changaco@changaco.net>
date Sun, 17 Jan 2010 21:14:23 +0100
parents b29fd5696a78
children 17305e57f71d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14
1a1f2a0d35c7 Fixed bug that prevented the bot from connecting to freenode and all other servers that don't send "umode"
Charly COSTE <changaco@changaco.net>
parents: 8
diff changeset
1 > Introduction
1a1f2a0d35c7 Fixed bug that prevented the bot from connecting to freenode and all other servers that don't send "umode"
Charly COSTE <changaco@changaco.net>
parents: 8
diff changeset
2
0
4c842d23d4ce Initial commit, version 0.1
Charly COSTE <changaco@changaco.net>
parents:
diff changeset
3 This is the first release of xib so some things are not implemented yet, if you want/need an error-safe bot, don't use this one !
4c842d23d4ce Initial commit, version 0.1
Charly COSTE <changaco@changaco.net>
parents:
diff changeset
4
107
b9263a9aaa34 Updated README for 0.2
Charly COSTE <changaco@changaco.net>
parents: 36
diff changeset
5 Here is the list of things that still need to be implemented:
b9263a9aaa34 Updated README for 0.2
Charly COSTE <changaco@changaco.net>
parents: 36
diff changeset
6 - handle cross-protocol kicks
0
4c842d23d4ce Initial commit, version 0.1
Charly COSTE <changaco@changaco.net>
parents:
diff changeset
7 - split logs into multiple files
4c842d23d4ce Initial commit, version 0.1
Charly COSTE <changaco@changaco.net>
parents:
diff changeset
8 - handle password-protected rooms
4c842d23d4ce Initial commit, version 0.1
Charly COSTE <changaco@changaco.net>
parents:
diff changeset
9
4c842d23d4ce Initial commit, version 0.1
Charly COSTE <changaco@changaco.net>
parents:
diff changeset
10 xib includes its own version of the old irclib.py <http://python-irclib.sourceforge.net/> because this library doesn't correctly handle the different character encodings, I'm sorry about it but I don't have time to contribute to the upstream version right now, I don't know if it still has developers anyway
1
7d1745ca1dc2 Add dependencies to README
Charly COSTE <changaco@changaco.net>
parents: 0
diff changeset
11
14
1a1f2a0d35c7 Fixed bug that prevented the bot from connecting to freenode and all other servers that don't send "umode"
Charly COSTE <changaco@changaco.net>
parents: 8
diff changeset
12
1a1f2a0d35c7 Fixed bug that prevented the bot from connecting to freenode and all other servers that don't send "umode"
Charly COSTE <changaco@changaco.net>
parents: 8
diff changeset
13 > xib dependencies:
1
7d1745ca1dc2 Add dependencies to README
Charly COSTE <changaco@changaco.net>
parents: 0
diff changeset
14 - python 2.6
8
1463f4620fca Added some help in README
Charly COSTE <changaco@changaco.net>
parents: 1
diff changeset
15 - xmppony 0.1
107
b9263a9aaa34 Updated README for 0.2
Charly COSTE <changaco@changaco.net>
parents: 36
diff changeset
16 - argparse (added in xib 0.2 for the new command system)
8
1463f4620fca Added some help in README
Charly COSTE <changaco@changaco.net>
parents: 1
diff changeset
17
1463f4620fca Added some help in README
Charly COSTE <changaco@changaco.net>
parents: 1
diff changeset
18
14
1a1f2a0d35c7 Fixed bug that prevented the bot from connecting to freenode and all other servers that don't send "umode"
Charly COSTE <changaco@changaco.net>
parents: 8
diff changeset
19 > Contributors:
1a1f2a0d35c7 Fixed bug that prevented the bot from connecting to freenode and all other servers that don't send "umode"
Charly COSTE <changaco@changaco.net>
parents: 8
diff changeset
20 Changaco <changaco@changaco.net>
1a1f2a0d35c7 Fixed bug that prevented the bot from connecting to freenode and all other servers that don't send "umode"
Charly COSTE <changaco@changaco.net>
parents: 8
diff changeset
21
1a1f2a0d35c7 Fixed bug that prevented the bot from connecting to freenode and all other servers that don't send "umode"
Charly COSTE <changaco@changaco.net>
parents: 8
diff changeset
22
1a1f2a0d35c7 Fixed bug that prevented the bot from connecting to freenode and all other servers that don't send "umode"
Charly COSTE <changaco@changaco.net>
parents: 8
diff changeset
23 > Changelog:
118
b29fd5696a78 new mode bypass and new method bridge.changeMode
Charly COSTE <changaco@changaco.net>
parents: 116
diff changeset
24 0.3:
b29fd5696a78 new mode bypass and new method bridge.changeMode
Charly COSTE <changaco@changaco.net>
parents: 116
diff changeset
25 - new mode "bypass", this allows to connect more than one bot for each IRC server without having so many nickname conflicts that the bot looks like it is in limited mode
150
e0eea72ea493 new bridge attribute "irc_connection_interval" (in seconds)
Charly COSTE <changaco@changaco.net>
parents: 118
diff changeset
26 - new bridge attribute "irc_connection_interval" (in seconds)
107
b9263a9aaa34 Updated README for 0.2
Charly COSTE <changaco@changaco.net>
parents: 36
diff changeset
27 0.2:
b9263a9aaa34 Updated README for 0.2
Charly COSTE <changaco@changaco.net>
parents: 36
diff changeset
28 - fixed many many bugs
b9263a9aaa34 Updated README for 0.2
Charly COSTE <changaco@changaco.net>
parents: 36
diff changeset
29 - new command system
b9263a9aaa34 Updated README for 0.2
Charly COSTE <changaco@changaco.net>
parents: 36
diff changeset
30 - rejoin on kick and leave on ban
b9263a9aaa34 Updated README for 0.2
Charly COSTE <changaco@changaco.net>
parents: 36
diff changeset
31 - added an ugly ping mechanism to keep the connections open
b9263a9aaa34 Updated README for 0.2
Charly COSTE <changaco@changaco.net>
parents: 36
diff changeset
32 - don't create an XMPP duplicate of ChanServ
b9263a9aaa34 Updated README for 0.2
Charly COSTE <changaco@changaco.net>
parents: 36
diff changeset
33 - "/me" handling
116
49d305b0bd9b REAME update
Charly COSTE <changaco@changaco.net>
parents: 107
diff changeset
34 - split long messages when sending on IRC
14
1a1f2a0d35c7 Fixed bug that prevented the bot from connecting to freenode and all other servers that don't send "umode"
Charly COSTE <changaco@changaco.net>
parents: 8
diff changeset
35 0.1.1:
1a1f2a0d35c7 Fixed bug that prevented the bot from connecting to freenode and all other servers that don't send "umode"
Charly COSTE <changaco@changaco.net>
parents: 8
diff changeset
36 - fixed bug that prevented the bot from connecting to freenode and all other servers that don't send "umode"
1a1f2a0d35c7 Fixed bug that prevented the bot from connecting to freenode and all other servers that don't send "umode"
Charly COSTE <changaco@changaco.net>
parents: 8
diff changeset
37 - added optional parameter to start_bots_from_xml_config.py
1a1f2a0d35c7 Fixed bug that prevented the bot from connecting to freenode and all other servers that don't send "umode"
Charly COSTE <changaco@changaco.net>
parents: 8
diff changeset
38 0.1: Initial release
1a1f2a0d35c7 Fixed bug that prevented the bot from connecting to freenode and all other servers that don't send "umode"
Charly COSTE <changaco@changaco.net>
parents: 8
diff changeset
39
1a1f2a0d35c7 Fixed bug that prevented the bot from connecting to freenode and all other servers that don't send "umode"
Charly COSTE <changaco@changaco.net>
parents: 8
diff changeset
40
1a1f2a0d35c7 Fixed bug that prevented the bot from connecting to freenode and all other servers that don't send "umode"
Charly COSTE <changaco@changaco.net>
parents: 8
diff changeset
41 > How to install and run xib bots:
8
1463f4620fca Added some help in README
Charly COSTE <changaco@changaco.net>
parents: 1
diff changeset
42
1463f4620fca Added some help in README
Charly COSTE <changaco@changaco.net>
parents: 1
diff changeset
43 If you are not installing xib from a package manager I suggest you put the files in /usr/local/share/xib
14
1a1f2a0d35c7 Fixed bug that prevented the bot from connecting to freenode and all other servers that don't send "umode"
Charly COSTE <changaco@changaco.net>
parents: 8
diff changeset
44 To start xib bots just execute "start_bots_from_xml_config.py", this script takes the path to a configuration file as optional first parameter, if no such parameter is given it will search the *current* directory for a file named "config.xml".
1a1f2a0d35c7 Fixed bug that prevented the bot from connecting to freenode and all other servers that don't send "umode"
Charly COSTE <changaco@changaco.net>
parents: 8
diff changeset
45
1a1f2a0d35c7 Fixed bug that prevented the bot from connecting to freenode and all other servers that don't send "umode"
Charly COSTE <changaco@changaco.net>
parents: 8
diff changeset
46
1a1f2a0d35c7 Fixed bug that prevented the bot from connecting to freenode and all other servers that don't send "umode"
Charly COSTE <changaco@changaco.net>
parents: 8
diff changeset
47 > How to write a configuration file understandable by "start_bots_from_xml_config.py":
8
1463f4620fca Added some help in README
Charly COSTE <changaco@changaco.net>
parents: 1
diff changeset
48
14
1a1f2a0d35c7 Fixed bug that prevented the bot from connecting to freenode and all other servers that don't send "umode"
Charly COSTE <changaco@changaco.net>
parents: 8
diff changeset
49 Copy "example_config.xml" and modify it to fit your needs.
1a1f2a0d35c7 Fixed bug that prevented the bot from connecting to freenode and all other servers that don't send "umode"
Charly COSTE <changaco@changaco.net>
parents: 8
diff changeset
50
1a1f2a0d35c7 Fixed bug that prevented the bot from connecting to freenode and all other servers that don't send "umode"
Charly COSTE <changaco@changaco.net>
parents: 8
diff changeset
51
17
32a35f7eff70 Rewrote/modified many things, multiple bridges should now work and are preferred over multiple bots.
Charly COSTE <changaco@changaco.net>
parents: 14
diff changeset
52 > The different modes of the xib bots:
32a35f7eff70 Rewrote/modified many things, multiple bridges should now work and are preferred over multiple bots.
Charly COSTE <changaco@changaco.net>
parents: 14
diff changeset
53
28
6481b9bb95aa Added documentation for the "say_level" attribute.
Charly COSTE <changaco@changaco.net>
parents: 17
diff changeset
54 "mode" is a per-bridge attribute, it can take three values:
17
32a35f7eff70 Rewrote/modified many things, multiple bridges should now work and are preferred over multiple bots.
Charly COSTE <changaco@changaco.net>
parents: 14
diff changeset
55 - 'normal':
32a35f7eff70 Rewrote/modified many things, multiple bridges should now work and are preferred over multiple bots.
Charly COSTE <changaco@changaco.net>
parents: 14
diff changeset
56 The bot connects on IRC on behalf of XMPP users and connects on XMPP on behalf of IRC users.
32a35f7eff70 Rewrote/modified many things, multiple bridges should now work and are preferred over multiple bots.
Charly COSTE <changaco@changaco.net>
parents: 14
diff changeset
57 In this mode the bot automatically switches from normal to limited mode and back again when the IRC server clones limit is crossed.
118
b29fd5696a78 new mode bypass and new method bridge.changeMode
Charly COSTE <changaco@changaco.net>
parents: 116
diff changeset
58 - 'bypass':
b29fd5696a78 new mode bypass and new method bridge.changeMode
Charly COSTE <changaco@changaco.net>
parents: 116
diff changeset
59 The bot connects on IRC on behalf of XMPP users and connects on XMPP on behalf of IRC users.
b29fd5696a78 new mode bypass and new method bridge.changeMode
Charly COSTE <changaco@changaco.net>
parents: 116
diff changeset
60 If a nickname is already used the bot tries to connect with a slightly different nickname, adding a "_" to the original nickname.
b29fd5696a78 new mode bypass and new method bridge.changeMode
Charly COSTE <changaco@changaco.net>
parents: 116
diff changeset
61 In this mode the bot automatically switches to limited mode and back again when the IRC server clones limit is crossed.
17
32a35f7eff70 Rewrote/modified many things, multiple bridges should now work and are preferred over multiple bots.
Charly COSTE <changaco@changaco.net>
parents: 14
diff changeset
62 - 'limited':
32a35f7eff70 Rewrote/modified many things, multiple bridges should now work and are preferred over multiple bots.
Charly COSTE <changaco@changaco.net>
parents: 14
diff changeset
63 The bot only connects on XMPP on behalf of IRC users but NOT on IRC on behalf of XMPP.
32a35f7eff70 Rewrote/modified many things, multiple bridges should now work and are preferred over multiple bots.
Charly COSTE <changaco@changaco.net>
parents: 14
diff changeset
64 - 'minimal':
32a35f7eff70 Rewrote/modified many things, multiple bridges should now work and are preferred over multiple bots.
Charly COSTE <changaco@changaco.net>
parents: 14
diff changeset
65 The bot does not connect on behalf of the participants.
32a35f7eff70 Rewrote/modified many things, multiple bridges should now work and are preferred over multiple bots.
Charly COSTE <changaco@changaco.net>
parents: 14
diff changeset
66
32a35f7eff70 Rewrote/modified many things, multiple bridges should now work and are preferred over multiple bots.
Charly COSTE <changaco@changaco.net>
parents: 14
diff changeset
67
28
6481b9bb95aa Added documentation for the "say_level" attribute.
Charly COSTE <changaco@changaco.net>
parents: 17
diff changeset
68 > Configure what the bot says on rooms:
6481b9bb95aa Added documentation for the "say_level" attribute.
Charly COSTE <changaco@changaco.net>
parents: 17
diff changeset
69
6481b9bb95aa Added documentation for the "say_level" attribute.
Charly COSTE <changaco@changaco.net>
parents: 17
diff changeset
70 "say_level" is a per-bridge attribute, it can take 6 values, each value contains the ones below itself:
6481b9bb95aa Added documentation for the "say_level" attribute.
Charly COSTE <changaco@changaco.net>
parents: 17
diff changeset
71 - 'all', default value, say everything
6481b9bb95aa Added documentation for the "say_level" attribute.
Charly COSTE <changaco@changaco.net>
parents: 17
diff changeset
72 - 'info', contains participants' joining and leaving events in limited and minimal modes
6481b9bb95aa Added documentation for the "say_level" attribute.
Charly COSTE <changaco@changaco.net>
parents: 17
diff changeset
73 - 'notice'
6481b9bb95aa Added documentation for the "say_level" attribute.
Charly COSTE <changaco@changaco.net>
parents: 17
diff changeset
74 - 'warning', contains nickname conflicts and everything that is not fatal to the bridge
6481b9bb95aa Added documentation for the "say_level" attribute.
Charly COSTE <changaco@changaco.net>
parents: 17
diff changeset
75 - 'error'
6481b9bb95aa Added documentation for the "say_level" attribute.
Charly COSTE <changaco@changaco.net>
parents: 17
diff changeset
76 - 'nothing', don't say a word
6481b9bb95aa Added documentation for the "say_level" attribute.
Charly COSTE <changaco@changaco.net>
parents: 17
diff changeset
77
6481b9bb95aa Added documentation for the "say_level" attribute.
Charly COSTE <changaco@changaco.net>
parents: 17
diff changeset
78
14
1a1f2a0d35c7 Fixed bug that prevented the bot from connecting to freenode and all other servers that don't send "umode"
Charly COSTE <changaco@changaco.net>
parents: 8
diff changeset
79 > How to log xib bots output:
8
1463f4620fca Added some help in README
Charly COSTE <changaco@changaco.net>
parents: 1
diff changeset
80
1463f4620fca Added some help in README
Charly COSTE <changaco@changaco.net>
parents: 1
diff changeset
81 xib does not directly handle logging for now so you have to do it the old school way, for example:
1463f4620fca Added some help in README
Charly COSTE <changaco@changaco.net>
parents: 1
diff changeset
82 mkdir /var/log/xib
1463f4620fca Added some help in README
Charly COSTE <changaco@changaco.net>
parents: 1
diff changeset
83 touch /var/log/xib/1.log
1463f4620fca Added some help in README
Charly COSTE <changaco@changaco.net>
parents: 1
diff changeset
84 cd /usr/local/share/xib && ./start_bots_from_xml_config.py 1>/var/log/xib/log 2>&1 &