Skip to content

Yamen-Malik/PCC-Bot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

45 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PCC Discord Bot

GNU GPL v3.0 Python v3.10 discord.py supports slash commands
black code style github actions


AboutInstallationContributing

About

Open-source discord bot with slash commands support, mainly developed to automate and manage a discord server for a university student club.

The project is designed to be self-documented and easily customizable.

Installation And Development Setup

Requirements

  1. Python 3 - Follow instructions to install the latest version of python for your platform in the python docs.
  2. PIP Dependencies - install dependencies by running the following command in the project directory:
    $ pip install -r requirements.txt
    This will install all of the required packages within the requirements.txt file.

Authorization Setup

Create an environment variable called BOT_TOKEN and assign it's value to your bot secret token.

Database Setup

The bot is hosted on replit and therefore is using replit's free key-value database.

A quick and easy workaround for local testing is to create a file called replit.py and adding an empty dictionary variable called db.

The file will look like this:

db = {}

Using this setup will cause the data to be cleared each time you restart the bot while testing locally.

Alternatively, if you're building your own bot and you're not going to use replit, you may want to consider choosing another database.

Running The Bot

To run the bot you need to run main.py file by executing the following command:

$ python3 main.py

Contributing

Please refer to the contributing guide to learn more about how to contribute to the project.

Releases

No releases published

Languages