_   _        _         _        
 _ __   __ _  _ __ _| |_(_)  ___ (_) _ __  | |  ___  
| '_ \ |__' || '__|\_ _/| | / __|| || '_ \ | | / _ \ 
| |_) || __ || |    | | | || |__ | || |_) || ||  __/ 
| .__/ |____||_|    |_| |_| \___||_|| .__/ |_| \___| 
|_|                                 |_|       

Welcome to participle

For information on modifying and extending participle see README.md inside the /ext directory.

Run start.rb. In Windows, this consists of double-clicking it. On Linux/OSX, this consists of running ruby path/to/participle/start.rb.

Setup

participle's configuration is in conf/bot.yaml. The syntax should be very easy to read and change for yourself. Possible keys:

  • admin: owner of the bot
  • channels: list of channels that the bot should autojoin
  • extensions: a list of extensions that the bot should load; see ext/README.md for more information
  • logging: true or false. Sets whether participle should log or not.
  • nick: the bot's nick
  • password: the bot's password
  • pretty_display: true or false. whether the bot's command line display should use colors
  • trigger: the character(s) that should prefix bot commands

Caveats

If you're on Windows, read this.

Common Questions

  • Why do I have to capitalize the names of my extensions?
    • Extensions are loaded as Ruby classes, which are always defined as constants; Ruby constants must be capitalized. Also, since there's no way to figure out the name of an arbitrary class defined by a file, the extension name is checked against the Participle::Extension constants list.