Skip to content

Commit

Permalink
README changes
Browse files Browse the repository at this point in the history
  • Loading branch information
uberj committed May 8, 2011
1 parent 2ee19f4 commit 87c0e55
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions README.mkd
Expand Up @@ -18,9 +18,7 @@ The an actual plug-in is instance of classe implementing ICommand. This means th
Don't do it yet. Let me make the bot more stable so you don't have to re-write anything later down the road.

When you implement the ICommand interface the bot will attempt to load your plug-in. If your plug-in is loaded (right now you need to check the logging output) it will receive a “bundle” of resources that your plug-in has access to. All the resources are mapped by keys in a dictionary. The actual resources it get's are in brain.py in the function contemplate(). The resources are:
- mouth - This is the instance of the underlying protocol class. You can use this to write to the wire. For example,
bundle['mouth'].msg(“#osu-lug”,”ponies”)
will send the message “ponies” to the channel “osu-lug”.
- mouth - This is the instance of the underlying protocol class. You can use this to write to the wire. For example, bundle['mouth'].msg(“#osu-lug”,”ponies”) will send the message “ponies” to the channel “osu-lug”.
- user - This is the user that triggered your plug-in to be called.
- channel - The channel in which your plug-in is being called from.
- msg - The full message that the user said when activating your plug-in. For example “!someplugin perameter1 perameter2” would be in the bundle.
Expand Down

0 comments on commit 87c0e55

Please sign in to comment.