Mercurial > xib

comparison README @ 14:1a1f2a0d35c7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fixed bug that prevented the bot from connecting to freenode and all other servers that don't send "umode" Signed-off-by: Charly COSTE <changaco@changaco.net>
author Charly COSTE <changaco@changaco.net>
date Mon, 17 Aug 2009 13:20:25 +0200
parents 1463f4620fca
children 32a35f7eff70
comparison
equal deleted inserted replaced
13:a9077fa9cac9 14:1a1f2a0d35c7
1 > Introduction
2
1 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 ! 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 !
2 4
3 Here is the list of the important things that still need to be implemented: 5 Here is the list of the important things that still need to be implemented:
4 - handle kicks 6 - handle kicks
5 - handle multiple bridges without risk of resource conflict 7 - handle multiple bridges without risk of resource conflict
9 - handle password-protected rooms 11 - handle password-protected rooms
10 - handle room deletion and muc server reboot 12 - handle room deletion and muc server reboot
11 13
12 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 14 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
13 15
14 xib depends on: 16
17 > xib dependencies:
15 - python 2.6 18 - python 2.6
16 - xmppony 0.1 19 - xmppony 0.1
17 20
18 21
19 How to install and run xib bots: 22 > Contributors:
23 Changaco <changaco@changaco.net>
24
25
26 > Changelog:
27 0.1.1:
28 - fixed bug that prevented the bot from connecting to freenode and all other servers that don't send "umode"
29 - added optional parameter to start_bots_from_xml_config.py
30 0.1: Initial release
31
32
33 > How to install and run xib bots:
20 34
21 If you are not installing xib from a package manager I suggest you put the files in /usr/local/share/xib 35 If you are not installing xib from a package manager I suggest you put the files in /usr/local/share/xib
22 To start xib bots just execute start_bots_from_xml_config.py, this script will search the *current* directory for a file named "config.xml" which must have the same schema as "example_config.xml". 36 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".
23 37
24 How to log xib bots output: 38
39 > How to write a configuration file understandable by "start_bots_from_xml_config.py":
40
41 Copy "example_config.xml" and modify it to fit your needs.
42
43
44 > How to log xib bots output:
25 45
26 xib does not directly handle logging for now so you have to do it the old school way, for example: 46 xib does not directly handle logging for now so you have to do it the old school way, for example:
27 mkdir /var/log/xib 47 mkdir /var/log/xib
28 touch /var/log/xib/1.log 48 touch /var/log/xib/1.log
29 cd /usr/local/share/xib && ./start_bots_from_xml_config.py 1>/var/log/xib/log 2>&1 & 49 cd /usr/local/share/xib && ./start_bots_from_xml_config.py 1>/var/log/xib/log 2>&1 &