This is the Open-Source Discord-Bot used for the central cordactyl.com panel. It can be used for individual tenants.
- Python 3.8 or higher
The Python dependencies are listed in the requirements.txt
.
Go to the discord developer portal and create a Discord-Bot. The Discord Bot needs at least the Server Members intent along with the following permissions:
- Send Messages
- Embed Links
For the discord Oauth2 login to work, you need to configure the following Oauth2 authentication redirect: https://cordactyl.com/discord-login
in the "OAuth2" section.
- Clone the project and go into the project directory.
- Rename the example config
.env.example
to.env
and configure it with your Discord-Bot token and the Api-Token. - Install the Python dependencies in a virtual environment:
# setup virtual environment python3 -m venv venv # install python packages into the virtual environment ./venv/bin/pip3 install -r requirements.txt
- Congratulations. You can now start the discord bot using:
./venv/bin/python3 bot.py
On a linux server, you can use the following service file to run the bot in a systemd daemon.
[Unit]
Description=Cordactyl Discord-Bot
After=network.target
[Service]
WorkingDirectory=/path_to_project
ExecStart=/path_to_project/venv/bin/python3 bot.py
Type=simple
Restart=always
# User=discord # If you have setup a custom user for the discord-bot
[Install]
WantedBy=multi-user.target
Translations are stored in the lang
directory.
Each language file is named by the IETF language tag.
If you want to contribute, just get in touch via our Discord Server.
- Implementing a ticket system
- Adding a social score system
Contributions, issues and feature requests are welcome.
This project is licensed under the Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License (CC BY-NC-ND 4.0).
- Attribution (BY): You must give appropriate credit when using or referencing this work.
- NonCommercial (NC): You may not use this work for commercial purposes.
- NoDerivatives (ND): You may not distribute modified versions of this work.
You are free to:
- View, download, and use the source code for personal and non-commercial purposes.
- You may not modify and redistribute this project or any derivatives.
- Commercial use is strictly prohibited.
For more details, see the full license at: https://creativecommons.org/licenses/by-nc-nd/4.0/.