Skip to content

Latest commit

 

History

History
32 lines (26 loc) · 1.46 KB

README.md

File metadata and controls

32 lines (26 loc) · 1.46 KB
Raw

GorillaBot

GorillaBot is an easily-extensible IRC bot written in Python. GorillaBot is no longer actively maintained.

Author: Molly White
License: MIT
Status: Stable
Version: 3.0
Python version: 3.4+

Installation

Download code from the master branch. Code in the development or other branches is often incomplete and nonfunctional.

The bot is available on PyPI, so it can be installed with pip install gorillabot or easy_install gorillabot.

Alternatively, install the bot from source:

  1. Run python3 bot.py from the source directory.
  2. Configure the bot when prompted. If you already have already configured the bot, you can use that configuration or create a new one.
  3. Once the bot has successfully connected, command the bot via IRC. A number of commands are marked as admin-only, and are only available to bot operators. All commands are outlined in the documentation.

Documentation

GorillaBot generates its own plugin documentation. If you add a plugin, please document it by writing usage notes in comments beginning with #-. You can see an example in the link command. Note that you do not need to specify if a command is admin-only or not; this is determined from the decorator.