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
Dynamic role-based (access level) permission system

Installation

Prerequisites

Python 3.12
Poetry
Optional: Docker if you want to run the bot in a container.
Optional: Docker Compose if you want to define the container environment in a docker-compose.yml file.
Optional: Just if you want to use the Justfile for easy CLI commands.

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 values
```
cp .env.example .env
```
Copy the config/settings.json.example file to config/settings.json and fill in the required values
```
cp config/settings.json.example config/settings.json
```
Run the bot
```
poetry run python tux/main.py
```
Run the sync command in the server to sync the slash command tree.
```
{prefix}dev sync <server id>
```

Development Notes

Note

Make sure to add your discord ID to the sys admin list if you are testing locally.

Note

Make sure to set the prisma schema database ENV variable to the DEV database URL.

License

This project is licensed under the terms of the The GNU General Public License v3.0. See the LICENSE file for details.

Izder456/tux

Tux