README.md

Alphabet Discord Bot

Requirements

• docker-ce 17.12.0+
• docker-compose 1.18+

You must install these first before you can use the bot as intended

Steps to get the bot up and running on your local machine

1. Clone this repo:

   • git clone https://github.com/AAADevs/alpha-bot.git

2. Navigate into the project directory:

   • cd alpha-bot

3. Copy the config.json.sample to config.json:

   • cp config.json.sample config.json

4. Edit the config file and add your own bot token, admin roles etc.

5. To run the bot use either of the following:

   • Foreground:
     • docker-compose up
   • Background (daemon):
     • docker-compose up -d

TODOs

• Upgrade to Python 3.9
• Change cheese cog to not expect a config from the client, have parameters passed in