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

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
• scan env variables for a more customizable behaviour
• overwrite on_ready() function for information at startup
• make bot react to custom prefix and mention
• add more advanced help command
• register example cog with b!ping command
• util functions for easy embed creation, id extraction and more

Note:
The bot uses all intents by default, those are required for such simple things like 'display member-count at startup'.
You need to enable those intents in the discord developers portal under "Application/Bot/Privileged Gateway Intents".
It's possible reconfigure the requested intents in main.py if you don't need them.
But I'd suggest using them all for the beginning, especially if you're relatively new to discord.py.

about

This repository contains code that was written by me across various bot-projects, like:
https://github.com/nonchris/discord-fury
https://github.com/nonchris/quiz-bot
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