Discord bot for the VUT FIT discord server

About

This bot manages the verification process, karma and a bunch of simple commands on our VUT FIT discord server. Since most of the features are custom-made I wouldn't recommend using it for different servers.

Rubbergoddess is a Rubbergod-based bot used on VUT FEKT discord server.

Creating discord application

Before first run of bot you need to create discord application. Guide for creating new application and adding bot to your server can be found at disnake documentation

While creating discord appilication one more step is required. You will also need to enable SERVER MEMBERS INTENT in Bot tab.

Installing and running the bot

Prerequisites:

Postgresql
Python3.8+

Start by cloning the repo:

git clone https://github.com/toaster192/rubbergod.git
cd rubbergod

Docker compose setup (recomended)

Install docker and docker-compose for your system (will vary from system to system) and run docker (systemctl start docker.service)

To run docker user needs to be in docker group. (eg. sudo usermod -aG docker $USER).

docker build .

and then everytime you want to run the app

docker-compose down && docker-compose up --build

Local setup (not recommended)

Install the required python modules (venv / --user flag recommended):

pip3 install -r requirements.txt

Run the bot (might want to use nohup or something):

python3 rubbergod.py

Required/recommended packages (apt)

git
python3.8
python3.8-dev
python3-pip
postgresql
postgresql-contrib
libpq-dev

Auto help generation

We are using custom auto help function for our commands. Help is generated from command brief (used in help summary) and command description (used in command help). If group of commands is working without invoked subcommand, command usage should be specified to include in help function. (e.g. karma, reviews)

Authors

Pull requests, issues or tips for new features are very much welcome!

License

This project is licensed under the GNU GPL v.3 License.

averevki/rubbergod