This repository is a template that everyone can use for the start of their discord bot.
When I first started creating my discord bot it took me a while to get everything setup and working with cogs and more. I would've been happy if there were any template existing. However, there wasn't any existing template. That's why I decided to create my own template to let you guys create your discord bot easily.
Please note that this template is not supposed to be the best template, but a good template to start learning how discord.py works and to make your own bot easily.
If you plan to use this template to make your own template or bot, you have to:
- Keep the credits, and a link to this repository in all the files that contains my code
- Keep the same license for unchanged code
See the license file for more information, I reserve the right to take down any repository that does not meet these requirements.
Before requesting support, you should know that this template requires you to have at least a basic knowledge of Python and the library is made for advanced users. Do not use this template if you don't know the basics or some advanced topics such as OOP or async. Here's a link for resources to learn python.
If you need some help for something, do not hesitate to join my discord server here.
All the updates of the template are available here.
Slash commands can take some time to get registered globally, so if you want to test a command you should use
the @app_commands.guilds() decorator so that it gets registered instantly. Example:
@commands.hybrid_command(
name="command",
description="Command description",
)
@app_commands.guilds(discord.Object(id=GUILD_ID)) # Place your guild ID hereWhen using the template you confirm that you have read the license and comprehend that I can take down your repository if you do not meet these requirements.
This repository is now a template, on the top left you can simply click on "Use this template" to create a GitHub repository based on this template.
Alternatively you can do the following:
- Clone/Download the repository
- To clone it and get the updates you can definitely use the command
git clone
- To clone it and get the updates you can definitely use the command
- Create a discord bot here
- Get your bot token
- Invite your bot on servers using the following invite:
https://discord.com/oauth2/authorize?&client_id=YOUR_APPLICATION_ID_HERE&scope=bot+applications.commands&permissions=PERMISSIONS (
Replace
YOUR_APPLICATION_ID_HEREwith the application ID and replacePERMISSIONSwith the required permissions your bot needs that it can be get at the bottom of a this page https://discord.com/developers/applications/YOUR_APPLICATION_ID_HERE/bot)
To set up the bot it was made as simple as possible.
There is config.json file where you can put the
needed things to edit.
Here is an explanation of what everything is:
| Variable | What it is |
|---|---|
| YOUR_BOT_PREFIX_HERE | The prefix you want to use for normal commands |
| YOUR_BOT_INVITE_LINK_HERE | The link to invite the bot |
To set up the token you will have to make use of the .env.example file, you should rename it to .env and replace YOUR_BOT_TOKEN_HERE with your actual bot's token.
Alternatively you can simply create an environment variable named TOKEN.
To start the bot you simply need to launch, either your terminal (Linux, Mac & Windows), or your Command Prompt ( Windows) .
Before running the bot you will need to install all the requirements with this command:
python -m pip install -r requirements.txt
After that you can start it with
python bot.py
Note You may need to replace
pythonwithpy,python3,python3.11, etc. depending on what Python versions you have installed on the machine.
If you have any issues or questions of how to code a specific command, you can:
Me or other people will take their time to answer and help you.
We use SemVer for versioning. For the versions available, see the tags on this repository.
This project is licensed under the Apache License 2.0 - see the LICENSE.md file for details