Sheffield-Discord-Bot

Discord bot created for the (unofficial) University of Sheffield Computer Science server.

Main Author:

• Felix Randle

Contributors:

• William Lee

Requirements

Python 3.6 or higher is required.

A complete description of Python package requirements can be found in requirements.txt.

The recommended method of installing all the requirements is using pip:

pip install -r requirements.txt

Additionally, you have two other requirements:

• MySQL server, version 8.0 or higher. Download MySQL server from here
• A Discord bot token. You can create a bot application here

Setup

Configuring environment variables

You must configure your environment variables such that the program is able to connect to your database, and connect Discord. The recommended way is to write your environment variables into a file called .env. This file is loaded automatically by the bot.

See .env_example for a template of a .env file.

Running the bot

Simply execute main.py:

python3 main.py

Contributing

Pull requests are welcome. Please make sure to test major updates before submitting a pull request.

License

GNU GPLv3