jdloft / bot24-irc

Does stuff on IRC

bot24-irc

Bot24-irc is the IRC component of the Bot24 framework. It doesn't do much at the moment. It relies on roles, just pieces of functionality built into modules and then translated through a class or just built into the class itself.

Installation

1. Run sqlinit.py to generate the database file
2. Copy sample-config.yaml to config.yaml and fill in with your details

IRC commands

Mentioning for commands

The bot can be controlled by mentioning it at the beginning of the message with or without a colon. For example, a bot with the nick bot24 (I'm creative) can be mentioned with bot24: command and bot24 command.

Main bot control

• stop disconnects from server, cleans up, and exits
• restart stops and then restarts the script

Role control

• role precedes all role control commmands
  • role ROLE status checks the state of ROLE
  • role ROLE start starts ROLE
  • role ROLE stop stops ROLE
  • role ROLE reload reloads ROLE if it is a module

Flags

• --debug outputs all raw IRC messages
• --plain doesn't output any ANSI control characters (color and screen clearing)

Roles

The roles phablookup and keywords come installed (but phablookup disabled). phablookup looks up any Phabricator Maniphest Task number such as T##### or http://url.something.com/T####. keywords looks up keywords that are defined in its module.