Curator

Curator is a discord bot written by Ruukas and RJTimmerman. It is currently early in development, and we still have many ideas that we want to implement.

Requirements

• Python 3 (Windows Download. Linux: sudo apt install python3)
• Python PIP (Included in Windows python installer. Linux: sudo apt install python3-pip)
• Virtualenv (included in Windows python installer. Linux: sudo pip3 install virtualenv)
• PostgreSQL Database (Download or setup for free on ElephantSQL)

Setup

Install the Dependencies

For ease of use, you can also run the bot with Docker. There is another repository for that.

Windows:

python -m venv venv
CALL venv/Scripts/activate.bat
pip install -r requirements.txt

Linux:

virtualenv venv
source venv/bin/activate
pip install -r requirements.txt

Discord Bot Account

Have a bot account on Discord Developer Portal.

Configuration

Create a file called curator.conf and fill in the credentials:

[Default]
# Client ID from 'General Information' tab of your Discord Application
ClientId=<client_id>
# Token from 'Bot' tab of your Discord Application
Token=<bot_token>
# List of Discord IDs of people with access to the admin commands (including your own), seperated by a comma with no spaces
Admins=314792415733088260,261156531989512192
# PostgreSQL URI to connect to a database the bot can use
PostgreSQL=postgres://<username>:<password>@<server>:<port>/<database>
# The size of the pool, the bot will use to communicate with the database
PoolSize=3
# The prefix that the bot will use for commands
CommandPrefix=!
# The id of the channel used to forward received DMs to
DMDump=<channel_id>

Be very careful with who you give admin access, as this is very powerful.

Initialize the database

Run init_db.py, in some cases you will need to run it several times, as some tables depend upon others.

Run

Linux users might need to replace python with python3.

python bot.py

Contact

If you have any questions, or would like to discuss the bot, you can find me on Discord: Ruukas#9050.