Mercurial > xib
annotate README @ 117:d062efcfbe9d 0.2
minor fix
Signed-off-by: Charly COSTE <changaco@changaco.net>
| author | Charly COSTE <changaco@changaco.net> |
|---|---|
| date | Sat, 28 Nov 2009 23:55:47 +0100 |
| parents | 49d305b0bd9b |
| children | b29fd5696a78 |
| 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: |
| 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 | 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: |
| 107 | 24 0.2: |
| 25 - fixed many many bugs | |
| 26 - new command system | |
| 27 - rejoin on kick and leave on ban | |
| 28 - added an ugly ping mechanism to keep the connections open | |
| 29 - don't create an XMPP duplicate of ChanServ | |
| 30 - "/me" handling | |
| 116 | 31 - 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
|
32 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
|
33 - 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
|
34 - 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
|
35 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
|
36 |
|
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 |
|
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 > How to install and run xib bots: |
|
8
1463f4620fca
Added some help in README
Charly COSTE <changaco@changaco.net>
parents:
1
diff
changeset
|
39 |
|
1463f4620fca
Added some help in README
Charly COSTE <changaco@changaco.net>
parents:
1
diff
changeset
|
40 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
|
41 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
|
42 |
|
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
|
43 |
|
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 > 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
|
45 |
|
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
|
46 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
|
47 |
|
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
|
48 |
|
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
|
49 > 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
|
50 |
|
28
6481b9bb95aa
Added documentation for the "say_level" attribute.
Charly COSTE <changaco@changaco.net>
parents:
17
diff
changeset
|
51 "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
|
52 - '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
|
53 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
|
54 In this mode the bot automatically switches from normal to limited mode and back again when the IRC server clones limit is crossed. |
|
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 - '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
|
56 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
|
57 - '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
|
58 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
|
59 |
|
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
|
60 |
|
28
6481b9bb95aa
Added documentation for the "say_level" attribute.
Charly COSTE <changaco@changaco.net>
parents:
17
diff
changeset
|
61 > Configure what the bot says on rooms: |
|
6481b9bb95aa
Added documentation for the "say_level" attribute.
Charly COSTE <changaco@changaco.net>
parents:
17
diff
changeset
|
62 |
|
6481b9bb95aa
Added documentation for the "say_level" attribute.
Charly COSTE <changaco@changaco.net>
parents:
17
diff
changeset
|
63 "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
|
64 - 'all', default value, say everything |
|
6481b9bb95aa
Added documentation for the "say_level" attribute.
Charly COSTE <changaco@changaco.net>
parents:
17
diff
changeset
|
65 - '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
|
66 - 'notice' |
|
6481b9bb95aa
Added documentation for the "say_level" attribute.
Charly COSTE <changaco@changaco.net>
parents:
17
diff
changeset
|
67 - '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
|
68 - 'error' |
|
6481b9bb95aa
Added documentation for the "say_level" attribute.
Charly COSTE <changaco@changaco.net>
parents:
17
diff
changeset
|
69 - 'nothing', don't say a word |
|
6481b9bb95aa
Added documentation for the "say_level" attribute.
Charly COSTE <changaco@changaco.net>
parents:
17
diff
changeset
|
70 |
|
6481b9bb95aa
Added documentation for the "say_level" attribute.
Charly COSTE <changaco@changaco.net>
parents:
17
diff
changeset
|
71 |
|
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
|
72 > How to log xib bots output: |
|
8
1463f4620fca
Added some help in README
Charly COSTE <changaco@changaco.net>
parents:
1
diff
changeset
|
73 |
|
1463f4620fca
Added some help in README
Charly COSTE <changaco@changaco.net>
parents:
1
diff
changeset
|
74 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
|
75 mkdir /var/log/xib |
|
1463f4620fca
Added some help in README
Charly COSTE <changaco@changaco.net>
parents:
1
diff
changeset
|
76 touch /var/log/xib/1.log |
|
1463f4620fca
Added some help in README
Charly COSTE <changaco@changaco.net>
parents:
1
diff
changeset
|
77 cd /usr/local/share/xib && ./start_bots_from_xml_config.py 1>/var/log/xib/log 2>&1 & |