README.md

commanderbot-py

A collection of utilities and extensions for discord.py bots.

Requirements

• Python 3.10+
• discord.py 2.0+

Running your bot

You can run your own bot without writing any code.

You will need the following:

1. Your own Discord Application with a bot token.
2. A configuration file for the bot.
3. A Python 3.10+ environment.
   • It is recommended to use a virtual environment for this.
   • You can use pyenv to build and run Python 3.10.
4. If you have poetry, you can poetry install instead of using pip. (Just make sure that dev dependencies are also installed.) Otherwise, you need to install a few packages with pip:
   • Run pip install commanderbot to install the bot core package.
   • Run pip install git+https://github.com/Rapptz/discord.py.git@848d752 to install the latest (and final) version of the discord.py 2.0 beta from GitHub.

The first thing you should do is check the CLI help menu:

python -m commanderbot --help

There are three ways to provide your bot token:

1. (Recommended) As the BOT_TOKEN environment variable: BOT_TOKEN=put_your_bot_token_here
2. As a CLI option: --token put_your_bot_token_here
3. Manually, when prompted during start-up

Here's an example that provides the bot token as an argument:

python -m commanderbot bot.json --token put_your_bot_token_here

Configuring your bot

The current set of configuration options is limited. Following is an example configuration that sets the command prefix and loads the status and faq extensions.

Note that with this configuration, the faq extension will require read-write access to faq.json in the working directory.

{
  "command_prefix": ">",
  "extensions": [
    "commanderbot.ext.status",
    {
      "name": "commanderbot.ext.faq",
      "enabled": true,
      "options": {
        "database": "faq.json",
        "prefix": "?"
      }
    }
  ]
}