Git Product home page Git Product logo

rubbergod's Introduction

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 discord.py documentation

While creating discord appilication one more step is required. Since discord.py v. 1.5 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.

rubbergod's People

Contributors

toaster192 avatar peterdragun avatar misha12 avatar ondryaso avatar thegreatfpmk avatar sinus-x avatar wereii avatar urumasi avatar kuba314 avatar matesxs avatar georgjr2 avatar adrijaned avatar koscicz avatar jogme avatar radluy avatar frnecas avatar solumath avatar tomaskender avatar michkot avatar alpatron avatar betsst avatar dajvid avatar cernyd avatar preclaa avatar redak37 avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.