Skip to content

Latest commit

 

History

History
40 lines (32 loc) · 1.4 KB

README.md

File metadata and controls

40 lines (32 loc) · 1.4 KB

discord-bot-template

Generic, functional bot based on discord.py
Including a custom help command and ping command, utils for easy embed creation, logging configuration, and a general bot setup

setup

pip install -r requirements.txt
export TOKEN="your-key"
python3 main.py
Remember using a virtual environment!

optional env variables

parameter description
export Prefix="b!" Command prefix
export VERSION="unknown" Version the bot is running
export OWNER_NAME="unknwon" Name of the bot owner
export OWNER_ID="100000000000000000" ID of the bot owner

The shown values are the default values that will be loaded if nothing else is specified.

features

This bot does 'nothing' but is completely functional!
What is does:

  • setup logging
  • overwrite on_ready() function for information at startup
  • register example cog with b!ping command
  • util function for easy embed creation

about

This repository contains code that was written by me across various bot-projects, like:
https://github.com/nonchris/discord-fury
https://github.com/Info-Bonn/poll-bot

I collected the most useful and generic functions to save me some time when starting the next bot-project.

dependencies

This project is based on discord.py V1.x minimum required: V1.5.1

documentation

In order to render this documentation, just call doxygen