GZRBOT README

GZRBOT is a general purpose bot for wave, web and xmpp. It uses a plugin structure to provide easy programming of commands and callbacks, allowing you to implement your own "killer plugin".

GZRBOT comes with some plugins provided, for example:

Hubbub plugin that uses superfeedr.com to get RSS feed pushed instead of pulling them ourselves. This lowers the load on the bot considerably. A max of 1000 feeds is for free.

Watcher plugin that let you watch waves, get notified in jabber when your waves updates. (the bots sends the updated txt)

- Wave plugin that provides help with wave management. I'm working on wave cloning after say x blips, so that larger conversations can be reated in google wave.

- This is mostly needed for the last plugin i want to mention and that is the gozernet plugin. The plugin allows for relaying of events between GZRBOT (Wave/Web/XMPP) and GOZERBOT (IRC/Jabber). IRC and Wave can be bridged this way.

GZRBOT is free code (BSD) and can be cloned as needed ;]

note: as of 0.2 GZRBOT uses the new v2 Wave API and thus needs registration with google.

install ~

best is to install the bot from the mercurial repo as it will allow for easy updating of the bot.

::

hg clone http://gzrbot.googlecode.com/hg

otherwise you can also download the tarball at http://gzrbot.googlecode.com.

cloning ~

To clone this bot into a bot you can upload yourself to the GAE use the bin/gzrbot-clone script. Copy this script to 1 dir above the gzrbot directory and run: ::

gzrbot-clone gzrbot yourbotname

This will create a directory that you can then upload to your own GAE account.

owner ~

Dont forget to edit the bot owner in the mainconfig file and copy the credentials.py.example to credentials.py and edit them.

admin-init

After you have added your plugin to the waveplugs dir run !admin-init to refresh the command -> plugin index needed for "plugin loading on demand".