Permalink
Browse files

still learning the ropes of rst markup.

  • Loading branch information...
1 parent 85b5fff commit 3bbf717cc7f6d846d59d3faff295fa8fcbef0007 @Ferus committed Mar 14, 2012
Showing with 8 additions and 7 deletions.
  1. +8 −7 README.rst
View
@@ -4,42 +4,43 @@ A Python 2.7/3.x IRC bot based on the blackbox IRC module
Official IRC help channel can be found at http://webirc.datnode.net/ or irc.datnode.net (Port 6667) in #hacking
Dependencies
-------------
+============
Python 2.7.2 or 3.x
blackbox IRC Macros `(Develop Branch) <https://github.com/proxypoke/blackbox_IRC-macros/>`_
blackBox is a great module that's built over the IRC protocol. It's used here to manage connections to an IRC server.
Optional Dependencies
----------------------
+=====================
`requests <https://github.com/kennethreitz/requests/>`_
+
Requests is a very nice 'frontend' to urllib2 and is used widely across WhergBot plugins.
`wordnik <https://github.com/wordnik/wordnik-python/>`_
+
We use the wordnik API in ./Plugins/Dictionary.py
`python-mpd <http://pypi.python.org/pypi/python-mpd/>`_
+
For all you MPD users, there is a working mpd plugin.
All of these can be installed with Pip, and is probably the easiest way.
Running
--------
+=======
Simply run "python WhergBot.py -n" to generate a new configuration file.
WhergBot will then run with that configuration.
Plugins
--------
+=======
I have *NOT* tested WhergBot on all platforms, therefore some plugins may not work.
Each plugin requires a 'hooks' dictionary attribute, which contains a regex of the
command as a key and a list containing the command to call, access level required,
and a bool for hostchecking.
For example:
- hooks = {
- "^@Hi" : [HelloWorld, 5, False]
- }
+ hooks = { "^@Hi" : [HelloWorld, 5, False] }
Will hook a "@Hi" command that calls HelloWorld (example below) only
if the user has level 5 or higher access.

0 comments on commit 3bbf717

Please sign in to comment.