Mercurial > xib
annotate README @ 215:b900585bdbbb
minor fix in bridge.py, the "reconnecting" attribute is declared in "init2", no need to do so in "__init__" too
Signed-off-by: Charly COSTE <changaco@changaco.net>
| author | Charly COSTE <changaco@changaco.net> |
|---|---|
| date | Sat, 06 Mar 2010 19:58:28 +0100 |
| parents | 7af07b7bf6fd |
| children | 8d01d0597950 |
| 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 | 5 Here is the list of things that still need to be implemented: |
|
154
25f6778b8841
updated README for 0.3
Charly COSTE <changaco@changaco.net>
parents:
152
diff
changeset
|
6 - internationalization |
| 107 | 7 - handle cross-protocol kicks |
|
0
4c842d23d4ce
Initial commit, version 0.1
Charly COSTE <changaco@changaco.net>
parents:
diff
changeset
|
8 - split logs into multiple files |
|
4c842d23d4ce
Initial commit, version 0.1
Charly COSTE <changaco@changaco.net>
parents:
diff
changeset
|
9 - handle password-protected rooms |
|
4c842d23d4ce
Initial commit, version 0.1
Charly COSTE <changaco@changaco.net>
parents:
diff
changeset
|
10 |
|
4c842d23d4ce
Initial commit, version 0.1
Charly COSTE <changaco@changaco.net>
parents:
diff
changeset
|
11 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
|
12 |
|
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
|
13 |
|
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
|
14 > xib dependencies: |
|
1
7d1745ca1dc2
Add dependencies to README
Charly COSTE <changaco@changaco.net>
parents:
0
diff
changeset
|
15 - python 2.6 |
|
8
1463f4620fca
Added some help in README
Charly COSTE <changaco@changaco.net>
parents:
1
diff
changeset
|
16 - xmppony 0.1 |
| 107 | 17 - 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
|
18 |
|
1463f4620fca
Added some help in README
Charly COSTE <changaco@changaco.net>
parents:
1
diff
changeset
|
19 |
|
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
|
20 > 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
|
21 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
|
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 |
|
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
|
24 > Changelog: |
|
118
b29fd5696a78
new mode bypass and new method bridge.changeMode
Charly COSTE <changaco@changaco.net>
parents:
116
diff
changeset
|
25 0.3: |
|
b29fd5696a78
new mode bypass and new method bridge.changeMode
Charly COSTE <changaco@changaco.net>
parents:
116
diff
changeset
|
26 - 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
|
27 - new bridge attribute "irc_connection_interval" (in seconds) |
|
152
17305e57f71d
removed automatic switching to limited mode (created Bridge.show_participants_list_on())
Charly COSTE <changaco@changaco.net>
parents:
150
diff
changeset
|
28 - removed automatic switching to limited mode |
| 162 | 29 - fixed the "halt" command |
| 30 - created 6 commands: | |
| 31 - change-bridges-mode | |
|
154
25f6778b8841
updated README for 0.3
Charly COSTE <changaco@changaco.net>
parents:
152
diff
changeset
|
32 - connections |
|
25f6778b8841
updated README for 0.3
Charly COSTE <changaco@changaco.net>
parents:
152
diff
changeset
|
33 - irc-connections |
|
25f6778b8841
updated README for 0.3
Charly COSTE <changaco@changaco.net>
parents:
152
diff
changeset
|
34 - xmpp-connections |
|
25f6778b8841
updated README for 0.3
Charly COSTE <changaco@changaco.net>
parents:
152
diff
changeset
|
35 - debug |
| 162 | 36 - stop-bot |
| 37 - renamed and modified 3 commands: | |
| 38 - remove-bridge → remove-bridges | |
| 39 - restart-bridge → restart-bridges | |
| 40 - stop-bridge → stop-bridges | |
|
154
25f6778b8841
updated README for 0.3
Charly COSTE <changaco@changaco.net>
parents:
152
diff
changeset
|
41 - improved the quality of the code |
|
25f6778b8841
updated README for 0.3
Charly COSTE <changaco@changaco.net>
parents:
152
diff
changeset
|
42 - finally, as usual, fixed many bugs and introduced new ones |
| 107 | 43 0.2: |
| 44 - fixed many many bugs | |
| 45 - new command system | |
| 46 - rejoin on kick and leave on ban | |
| 47 - added an ugly ping mechanism to keep the connections open | |
| 48 - don't create an XMPP duplicate of ChanServ | |
| 49 - "/me" handling | |
| 116 | 50 - 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
|
51 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
|
52 - 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
|
53 - 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
|
54 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
|
55 |
|
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
|
56 |
|
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
|
57 > How to install and run xib bots: |
|
8
1463f4620fca
Added some help in README
Charly COSTE <changaco@changaco.net>
parents:
1
diff
changeset
|
58 |
|
1463f4620fca
Added some help in README
Charly COSTE <changaco@changaco.net>
parents:
1
diff
changeset
|
59 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
|
60 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
|
61 |
|
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
|
62 |
|
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
|
63 > 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
|
64 |
|
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
|
65 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
|
66 |
|
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
|
67 |
|
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
|
68 > 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
|
69 |
|
28
6481b9bb95aa
Added documentation for the "say_level" attribute.
Charly COSTE <changaco@changaco.net>
parents:
17
diff
changeset
|
70 "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
|
71 - '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
|
72 The bot connects on IRC on behalf of XMPP users and connects on XMPP on behalf of IRC users. |
|
118
b29fd5696a78
new mode bypass and new method bridge.changeMode
Charly COSTE <changaco@changaco.net>
parents:
116
diff
changeset
|
73 - 'bypass': |
|
b29fd5696a78
new mode bypass and new method bridge.changeMode
Charly COSTE <changaco@changaco.net>
parents:
116
diff
changeset
|
74 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
|
75 If a nickname is already used the bot tries to connect with a slightly different nickname, adding a "_" to the original nickname. |
|
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
|
76 - '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
|
77 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
|
78 - '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
|
79 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
|
80 |
|
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
|
81 |
|
28
6481b9bb95aa
Added documentation for the "say_level" attribute.
Charly COSTE <changaco@changaco.net>
parents:
17
diff
changeset
|
82 > Configure what the bot says on rooms: |
|
6481b9bb95aa
Added documentation for the "say_level" attribute.
Charly COSTE <changaco@changaco.net>
parents:
17
diff
changeset
|
83 |
|
6481b9bb95aa
Added documentation for the "say_level" attribute.
Charly COSTE <changaco@changaco.net>
parents:
17
diff
changeset
|
84 "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
|
85 - 'all', default value, say everything |
|
6481b9bb95aa
Added documentation for the "say_level" attribute.
Charly COSTE <changaco@changaco.net>
parents:
17
diff
changeset
|
86 - '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
|
87 - 'notice' |
|
6481b9bb95aa
Added documentation for the "say_level" attribute.
Charly COSTE <changaco@changaco.net>
parents:
17
diff
changeset
|
88 - '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
|
89 - 'error' |
|
6481b9bb95aa
Added documentation for the "say_level" attribute.
Charly COSTE <changaco@changaco.net>
parents:
17
diff
changeset
|
90 - 'nothing', don't say a word |
|
6481b9bb95aa
Added documentation for the "say_level" attribute.
Charly COSTE <changaco@changaco.net>
parents:
17
diff
changeset
|
91 |
|
6481b9bb95aa
Added documentation for the "say_level" attribute.
Charly COSTE <changaco@changaco.net>
parents:
17
diff
changeset
|
92 |
|
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
|
93 > How to log xib bots output: |
|
8
1463f4620fca
Added some help in README
Charly COSTE <changaco@changaco.net>
parents:
1
diff
changeset
|
94 |
|
1463f4620fca
Added some help in README
Charly COSTE <changaco@changaco.net>
parents:
1
diff
changeset
|
95 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
|
96 mkdir /var/log/xib |
|
1463f4620fca
Added some help in README
Charly COSTE <changaco@changaco.net>
parents:
1
diff
changeset
|
97 touch /var/log/xib/1.log |
|
1463f4620fca
Added some help in README
Charly COSTE <changaco@changaco.net>
parents:
1
diff
changeset
|
98 cd /usr/local/share/xib && ./start_bots_from_xml_config.py 1>/var/log/xib/log 2>&1 & |