IRC bot for meetings and logging channels
Go to file
Richard Darst 5b5bdfa0f1 add license note to readme.txt
darcs-hash:20090607141213-82ea9-5a0e53389828b695b33bdf572494d3c0d8317e7f.gz
2009-06-07 07:12:13 -07:00
README.txt add license note to readme.txt 2009-06-07 07:12:13 -07:00
__init__.py Renaming: MeatBot->MeetBot 2009-05-07 16:17:02 -07:00
config.py Renaming: MeatBot->MeetBot 2009-05-07 16:17:02 -07:00
meeting.py split out action-line matching regexp 2009-05-27 16:13:23 -07:00
plugin.py default to not writing rawlog in Meeting object 2009-05-27 16:01:51 -07:00
test.py Renaming: MeatBot->MeetBot 2009-05-07 16:17:02 -07:00

README.txt

USAGE
~~~~~
http://wiki.debian.org/MeetBot

Inspired by the original MeetBot, by Holger Levsen, which was itself a
derivative of Mootbot (https://wiki.ubuntu.com/ScribesTeam/MootBot),
by the Ubuntu Scribes team.

/usr/share/doc/supybot/GETTING_STARTED.gz (on Debian systems) provides
information on configuring supybot the first time, including taking
ownership the first time.



INSTALLATION
~~~~~~~~~~~~

Requirements: 
* pygments (debian package python-pygments) (for pretty IRC logs).

* Install supybot.  You can use supybot-wizard to make a bot 
  configuration.

  * Don't use a prefix character.  (disable this:
      supybot.reply.whenAddressedBy.chars: 
    in the config file - leave it blank afterwards.)

* Move the MeetBot directory into your plugins directory of Supybot.

* Make supybot join any channels you are interested in.  The wizard
  handles this for the first part.  After that, I guess you have to
  learn about supybot (I don't know enough yet...).  If the plugin is
  loaded, it is active on ALL channels the bot is on.  You can also
  command the bot after it's online.

* Make sure the plugin is loaded.
    supybot.plugins: Admin Misc User MeetBot Owner Config Channel
  (can also control loading after the bot is started)

Supybot does a lot, but I don't know much about it.  Hopefully Supybot
expert users can enlighten me as to better ways to do things.

In particular, supybot has a large configuration system, which I know
nothing about.  It may be worth hooking MeetBot into that system.



LICENSE
~~~~~~~
The MeetBot plugin is under the same license as supybot is, a 3-clause
BSD.  The license is documented in each code file (and also applies to
this README file).