Tux

A Discord bot for the All Things Linux Discord server

Warning

This bot (without plenty of tweaking) is not ready for production use, we suggest against using it until announced. Join our support server: atl.dev for more info!

About

Tux is an all in one 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.

Tech Stack

Python 3.12 alongside the Discord.py library
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
Request handling with HTTPX

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
Supabase
Optional: Docker
Optional: Docker Compose (see the development notes for more information)
Optional: Just

Steps to Install

Assuming you have the prerequisites installed, follow these steps to get started with the development of the project:

Further detailed instructions can be found in the development guide.

Clone the repository

git clone https://github.com/allthingslinux/tux && cd tux

Install the project's dependencies
```
poetry install
```
Activate the virtual environment
```
poetry shell
```
Install the pre-commit hooks
```
pre-commit install
```
Generate the prisma client
```
prisma generate
```
Currently, you will need to have a Supabase database set up and the URL set in the DATABASE_URL environment variable.

In the future, we will provide a way to use a local database. We can provide a dev database on request.
Copy the .env.example file to .env and fill in the required values.
```
cp .env.example .env
```
You'll need to fill in your Discord bot token here, as well as the Sentry DSN if you want to use Sentry for error tracking.

We offer dev tokens on request in our Discord server.
Copy the config/settings.yml.example file to config/settings.yml and fill in the required values.
```
cp config/settings.yml.example config/settings.yml
```
Be sure to add your Discord user ID to the BOT_OWNER key in the settings file.

You can also add your custom prefix here.
Start 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.

Note

If you want to develop Tux using Docker Compose, we recommend using docker compose up --watch for hot reloading.

License

This project is licensed under the terms of the The GNU General Public License v3.0.

See LICENSE for details.

Metrics

_{Made with Repobeats.}

Contributors

_{Made with contrib.rocks.}