Read Me

This is the readme for sonicbot.
sonicbot is an IRC bot that accepts plugins so it can do practically anything.
The format of the plugins can be determined by looking at the source code and
at the included plugins (there are lots of them).  Documentation for making
plugins will be released sometime soon at http://sonicbot.sourceforge.net
sonicbot was written by Westly Ward (sonicrules1234) under the BSD license,
which is included in sonicbot-v2.3.1.py

The sourceforge page is :https://sourceforge.net/projects/sonicbot/
My homepage (at the time of this release (it changes hosts sometimes)) is : http://pyramid.cluenet.org/~sonicrules1234/
You can get help for sonicbot by joining #sonicbot on irc.cluenet.org
(be careful to obey the network rules!) or by emailing sonicrules1234 [at] gmail [dot] com
You can also come into #sonicbot on Freenode

Note that sonicmail is included in this version.  Please come into #sonicbot on cluenet or freenode for help setting up
the web interface.

Here is a list of commands included:
execos, wikinotifier, lurk, kick, gdefine, topic, up, raw, randfact, violence, mcheck, google, timedban, help, join, op, mood, pluginlist, dns, voiceme, register, bday, context, voice, choose, timeddevoice, action, devoice, notifyme, mail, part, dns6, restart, ban, mailman, say, unban, deop, feednotifier

The syntax for the above commands can be found by using help <plugin>

The following commands are built in and therefore not listed by the pluginlist command:

add <factoid name> is <factoid definition>
	Adds a factoid that can be retrieved by <prefix><factoid name>
	Example : ;add sonicbot is Sonicbot is cool!
		;sonicbot

remove <factoid name>
	Removes a factoid
	Example : ;remove sonicbot

eval <python statement>
	Runs the eval() function
	Example: ;eval 1 + 1

connect <host> <port> [<channels seperated by spaces>]
	Connects to another network
	Example: ;connect irc.freenode.net 6667 #sonicbot

reload
	Reloads the plugins and config file
	Example: ;reload

+ai
	Enables the AI, which can be used by addressing the bot by "<nick>: "
	sonicbot: How are you?
	Example: ;+ai
-ai
	Disable the AI
	Example: ;-ai

+relay
	Tells sonicbot to relay all messages in the channel to that channel on all the networks sonicbot is connected to.
	Example: ;+relay

-relay
	Tells sonicbot to stop relaying messages for the current channel
	Example: ;-relay

quit
	Tells sonicbot to shut down
	Example: ;quit

+ignore <nick>
	Tells sonicbot to ignore all messages from that nick.
	Example: ;+ignore foo

-ignore <nick>
	Tells sonicbot to stop ignoring messages from that nick
	Example: ;-ignore foo