aquabot/README.md

AquaBot

This bot is my first personal project so expect some minor (or bigger) problems here and there.

Support and report requests are handled via Discord (Link above).

Installation - pip

• Clone this repository with git clone https://github.com/CramMK/aquabot

• Create a virtual environment (e.g with python3 -m venv virtual)

• Use pip install -r requirements.txt to install all dependencies needed for the bot

• Create a config file as described below

• Finally, run python3 aquabot

Commands

The following commands assume that . is your prefix.

There are currently two command, which help the user to naviagte the bot's commands:

• .aquabot shows a short introduction
• .help shows a list of all commands (A custom help message is WIP)

Config

To use the bot you need to add a config/config.yml file. For reference, see config/config_example.yml.

Requirements

• python>=3.6.0