= ImBotShell =

version 0.1
http://decafbad.com/trac/wiki/ImBotShell
l.m.orchard@pobox.com 
Share and Enjoy

== Overview ==

I'd like an instant messaging bot that's about as easy to extend as dropping a
CGI script into a web server directory.  Maybe this bot will do that.

If you check at just the right times, `decafbot@jabber.org` may be running a
version of this bot.

== Requirements ==

Here's what you need to run this beast:

 * A UNIX-ish OS (I use OS X and Debian)
 * Python 2.4.3 (mine came from DarwinPorts under OS X)

== Dependencies ==

Code from the following projects is used in this beast:

 * simplejson - http://undefined.org/python/#simplejson
 * xmpppy - http://xmpppy.sourceforge.net/
 * toc.py - http://www.jamwt.com/Py-TOC/

There's no need to download these packages at present, since they are bundled
under the `lib/` directory.

== Configuration ==

In the `conf/` directory, find `imbotshell.conf`.  Someday, this file will
have proper documentation - but for now, you can supply a JID / username and
password for Jabber and AIM transports in the appropriate locations.

You can also disable the Jabber or AIM transport by taking one or the other out
of the `transports` list in the `[main]` section.

== Running ==

You should be able to start this thing up simply by running the `run.py` script
in the root of the package, like so:
{{{
    python run.py
}}}

== Built-In Commands ==

TODO

== Extending Commands ==

TODO