Mercurial > xib

annotate README @ 15:5aa4399c0530

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fixed a "copy/paste" bug Signed-off-by: Charly COSTE <changaco@changaco.net>
author Charly COSTE <changaco@changaco.net>
date Mon, 17 Aug 2009 14:36:43 +0200
parents 1a1f2a0d35c7
children 32a35f7eff70
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
4c842d23d4ce Initial commit, version 0.1
Charly COSTE <changaco@changaco.net>
parents:
diff changeset
5 Here is the list of the important things that still need to be implemented:
4c842d23d4ce Initial commit, version 0.1
Charly COSTE <changaco@changaco.net>
parents:
diff changeset
6 - handle kicks
4c842d23d4ce Initial commit, version 0.1
Charly COSTE <changaco@changaco.net>
parents:
diff changeset
7 - handle multiple bridges without risk of resource conflict
4c842d23d4ce Initial commit, version 0.1
Charly COSTE <changaco@changaco.net>
parents:
diff changeset
8
4c842d23d4ce Initial commit, version 0.1
Charly COSTE <changaco@changaco.net>
parents:
diff changeset
9 and a list of features that should be implemented but are not critical for usual use case:
4c842d23d4ce Initial commit, version 0.1
Charly COSTE <changaco@changaco.net>
parents:
diff changeset
10 - split logs into multiple files
4c842d23d4ce Initial commit, version 0.1
Charly COSTE <changaco@changaco.net>
parents:
diff changeset
11 - handle password-protected rooms
4c842d23d4ce Initial commit, version 0.1
Charly COSTE <changaco@changaco.net>
parents:
diff changeset
12 - handle room deletion and muc server reboot
4c842d23d4ce Initial commit, version 0.1
Charly COSTE <changaco@changaco.net>
parents:
diff changeset
13
4c842d23d4ce Initial commit, version 0.1
Charly COSTE <changaco@changaco.net>
parents:
diff changeset
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
1
7d1745ca1dc2 Add dependencies to README
Charly COSTE <changaco@changaco.net>
parents: 0
diff changeset
15
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
16
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
17 > xib dependencies:
1
7d1745ca1dc2 Add dependencies to README
Charly COSTE <changaco@changaco.net>
parents: 0
diff changeset
18 - python 2.6
8
1463f4620fca Added some help in README
Charly COSTE <changaco@changaco.net>
parents: 1
diff changeset
19 - xmppony 0.1
1463f4620fca Added some help in README
Charly COSTE <changaco@changaco.net>
parents: 1
diff changeset
20
1463f4620fca Added some help in README
Charly COSTE <changaco@changaco.net>
parents: 1
diff changeset
21
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
22 > 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
23 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
24
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
25
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
26 > Changelog:
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
27 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
28 - 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
29 - 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
30 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
31
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
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 > How to install and run xib bots:
8
1463f4620fca Added some help in README
Charly COSTE <changaco@changaco.net>
parents: 1
diff changeset
34
1463f4620fca Added some help in README
Charly COSTE <changaco@changaco.net>
parents: 1
diff changeset
35 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
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".
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
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 > 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
40
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 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
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 log xib bots output:
8
1463f4620fca Added some help in README
Charly COSTE <changaco@changaco.net>
parents: 1
diff changeset
45
1463f4620fca Added some help in README
Charly COSTE <changaco@changaco.net>
parents: 1
diff changeset
46 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
47 mkdir /var/log/xib
1463f4620fca Added some help in README
Charly COSTE <changaco@changaco.net>
parents: 1
diff changeset
48 touch /var/log/xib/1.log
1463f4620fca Added some help in README
Charly COSTE <changaco@changaco.net>
parents: 1
diff changeset
49 cd /usr/local/share/xib && ./start_bots_from_xml_config.py 1>/var/log/xib/log 2>&1 &