Mozbot/Documentation/Modules

From MozillaWiki
Jump to: navigation, search

Installing a new mozbot module is quite easy. First, copy the .bm file (e.g. Foo.bm) into the BotModule/ directory. Next, on IRC, authenticate with your bot as its administrator (the installation instructions walk you through this), and tell it to load the module using the load command.

<IRCMonkey> <kbd>auth IRCMonkey password</kbd>
<mozbot> Hi IRCMonkey!
<IRCMonkey> <kbd>load Foo</kbd>
<mozbot> Loaded module 'Foo'.

You can then find out more about the module using the help command.

<IRCMonkey> <kbd>help</kbd>
<mozbot> Help topics for mozbot 2.2 (see http://www.mozilla.org/projects/mozbot/):
<mozbot>   Admin: bless cycle join load part reload restart shutdown shutup unbless unload vars
<mozbot>   Foo: bar baz;  ...
<mozbot> For help on a particular topic, type 'help <topic>'. Note that some commands may be disabled in certain channels.
<IRCMonkey> <kbd>help Foo</kbd>
<mozbot> Foo: This module does this that and the other.
<IRCMonkey> <kbd>help bar</kbd>
<mozbot> bar: Uses the bar algorithm. Syntax: bar some text