TheAlot

Lightweight python IRC Bot

Requirements:

• python3.3 (not tested with older version)
• virtualenv (optional)
• irc
• sqlalchemy

Installation

1. Install and source the virtualenv:

   virtualenv3 VENV
   source VENV/bin/activate

2. Install the package:

   pip install thealot

Configuration

1. Copy the default config file:

   cp VENV/lib/python<VERSION>/site-packages/thealot/config.json .

2. Edit configuration to fit your needs:

   server

   IRC server address that bot should connect to

   port

   Port that the bot should use to connect to the server

   channel

   IRC channel that the bot should join after connecting to the server

   nickname

   Nickname that the bot should attempt to use (if it's taken and underscore is appended until available nickname is found.

   prefix

   Prefix to be used to invoke bot commands

   database

   Database URL string acceptable by sqlalchemy.create_engine() to be used by the bot and plugins.

   reconnection_interval

   Amount of seconds to wait before attempting to reconnect after a timeout or a lost connetion

   plugins

   a comma separated list of plugin module names to be loaded when bot is started. Example: To run the AlotPlugin install thealot-alot package with:

   pip install thealot-alot

   and enable the plugin in the config:

   "plgins" : [
       "alot"
   ]

Running

1. Source the virtualenv:

   source VENV/bin/activate

2. Run the bot:

   python -m thealot.thealot

   or

   from thealot import TheAlot
   
   if __name__ == "__main__":
       bot = TheAlot()
       bor.start()

Available plugins

• thealot-alot
• thealot-excuse
• thealot-links
• thealot-quote