.archive | ||
.github | ||
assets | ||
config | ||
docs | ||
prisma | ||
tux | ||
.editorconfig | ||
.env.example | ||
.gitignore | ||
.mise.toml | ||
.pre-commit-config.yaml | ||
docker-compose.yml | ||
Dockerfile | ||
justfile | ||
LICENSE.md | ||
poetry.lock | ||
poetry.toml | ||
pyproject.toml | ||
README.md | ||
renovate.json |
Tux
A Discord bot for the All Things Linux Discord server
NOTE: This bot (without plenty of tweaking) is not ready for multi-server use, we recommend against using it until it is more complete
About
Tux is a Discord bot for the All Things Linux Discord server. It is designed to provide a variety of features to the server, including moderation, support, utility, and various fun commands. The bot is written in Python using the discord.py library.
Tech Stack
- Poetry for dependency management
- Docker and Docker Compose for development and deployment
- Strict typing with Pyright and type hints
- Type safe ORM using Prisma
- PostgreSQL database with Supabase
- Linting and formatting via Ruff and Pre-commit
- Justfile for easy CLI commands
- Beautiful logging with Loguru
- Exception handling with Sentry
Bot Features
- Asynchronous codebase
- Hybrid command system with both slash commands and traditional commands
- Cog loading system with hot reloading
- Branded embeds and messages
- Robust error handling
- Activity rotation
- Custom help command
- Configuration system
Installation
Prerequisites
- Python 3.12
- Poetry
- Optional: Docker
- Optional: Docker Compose
- Optional: Just
Steps
-
Clone the repository
git clone https://github.com/allthingslinux/tux && cd tux
-
Install the dependencies
poetry install
-
Activate the virtual environment
poetry shell
-
Install the pre-commit hooks
pre-commit install
-
Generate the prisma client
prisma generate
-
Copy the
.env.example
file to.env
and fill in the required valuescp .env.example .env
-
Copy the
config/settings.json.example
file toconfig/settings.json
and fill in the required valuescp config/settings.json.example config/settings.json
-
Run the sync command in the server to sync the slash command tree.
{prefix}dev sync <server id>
-
Review all useful CLI commands by visiting the useful CLI commands file.
License
This project is licensed under the terms of the The GNU General Public License v3.0. See the LICENSE file for details.