Plugins are python files which are located in one of the plugin folders specified in the PLUGINPATH in your config.
They must end in _plugin.py to be recognized by the bot.
Each plugin must contain a global HELP_DESC variable with a short string
explaining the plugin.
Furthermore, an asyncio function register_to(plugin) has to be defined.
The plugin argument exposes a lot of functionality via helper-functions, e.g.:
- Handler Constructors
- room interaction (
send_text,send_image, ...) - a persistent key-value store
- functions for creating asyncio task
For more information look into the file cyberbot/plugin.py.
Plugins operate on a room level, meaning that each room that adds your plugin will load an own instance of your plugin's module. This has the consequence that the key-value store is module-instance specific and other ways of storing persistant data need to be protected from sharing between the instances (except that's the goal).
As the bot heavily uses python's asyncio, most functions create coroutines which
must be awaited.
Example:
HELP_DESC = "!echo\t\t\t-\tEcho back the given string\n"
async def register_to(plugin):
# Echo back the given command
async def echo_callback(room, event):
args = plugin.extract_args(event)
args.pop(0)
await plugin.send_html(
await plugin.format_user_highlight(event.sender) + ": " + " ".join(args)
)
# Add a command handler waiting for the echo command
echo_handler = plugin.CommandHandler("echo", echo_callback)
plugin.add_handler(echo_handler)