view README @ 8:1463f4620fca

Added some help in README Signed-off-by: Charly COSTE <changaco@changaco.net>
author Charly COSTE <changaco@changaco.net>
date Sun, 16 Aug 2009 22:04:06 +0200
parents 7d1745ca1dc2
children 1a1f2a0d35c7
line wrap: on
line source

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 !

Here is the list of the important things that still need to be implemented:
- handle kicks
- handle multiple bridges without risk of resource conflict

and a list of features that should be implemented but are not critical for usual use case:
- split logs into multiple files
- handle password-protected rooms
- handle room deletion and muc server reboot

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

xib depends on:
- python 2.6
- xmppony 0.1


How to install and run xib bots:

If you are not installing xib from a package manager I suggest you put the files in /usr/local/share/xib
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".

How to log xib bots output:

xib does not directly handle logging for now so you have to do it the old school way, for example:
mkdir /var/log/xib
touch /var/log/xib/1.log
cd /usr/local/share/xib && ./start_bots_from_xml_config.py 1>/var/log/xib/log 2>&1 &