This repository was archived by the owner on May 14, 2026. It is now read-only.

Name		Name	Last commit message	Last commit date
.agents		.agents
.cursor		.cursor
.devcontainer		.devcontainer
.github		.github
.vscode		.vscode
assets		assets
config		config
docker		docker
docs		docs
scripts		scripts
src/tux		src/tux
tests		tests
typings		typings
.commitlintrc.json		.commitlintrc.json
.cursorignore		.cursorignore
.dockerignore		.dockerignore
.docstr.yaml		.docstr.yaml
.editorconfig		.editorconfig
.env.example		.env.example
.git-blame-ignore-revs		.git-blame-ignore-revs
.gitignore		.gitignore
.markdownlint.yaml		.markdownlint.yaml
.markdownlintignore		.markdownlintignore
.pre-commit-config.yaml		.pre-commit-config.yaml
.python-version		.python-version
.yamllint.yml		.yamllint.yml
AGENTS.md		AGENTS.md
CHANGELOG.md		CHANGELOG.md
Containerfile		Containerfile
LICENSE		LICENSE
README.md		README.md
ROADMAP.md		ROADMAP.md
TODO.md		TODO.md
alembic.ini		alembic.ini
codecov.yml		codecov.yml
compose.yaml		compose.yaml
flake.lock		flake.lock
flake.nix		flake.nix
mise.toml		mise.toml
pyproject.toml		pyproject.toml
shell.nix		shell.nix
uv.lock		uv.lock
wrangler.toml		wrangler.toml
zensical.toml		zensical.toml

Repository files navigation

Tux

The all-in-one open source Discord bot

📚 Docs • ❓ FAQ • 💬 Discord • 🗺️ Roadmap

Warning

This codebase is under heavy development and subject to breaking changes. APIs, configurations, and features may change without notice. Documentation is not guaranteed to be accurate or up to date. Use at your own risk in production environments.

Quick Start

Choose your path to get started with Tux:

Role	Get Started
👤 Users	Get Started
⚙️ Admins	Get Started
🐳 Self-Hosters	Get Started
💻 Developers	Get Started

About

Tux is a feature-rich Discord bot originally built for the All Things Linux community. It provides moderation tools, leveling systems, snippets, utilities, and fun commands - all in one package.

Key Features:

Moderation - Comprehensive moderation tools with case management
Leveling - XP and ranking system to reward active members
Snippets - Quick text responses and custom commands
Utilities - Server management and utility commands
Fun - Entertainment commands and interactive features
Plugin System - Extensible architecture for custom functionality
Caching - Optional Valkey (Redis-compatible) cache for guild config, jail status, and permissions; falls back to in-memory TTL when Valkey is not configured

Why Tux?

Modern tech stack - Type-safe, async-first, powered by Python 3.13+ and discord.py
Production-ready - Battle-tested in large communities with comprehensive error handling
Developer-friendly - Clean architecture, extensive docs, and active development
Free and open source - Free to use, modify, and contribute under GPL-3.0

Tech Stack

Component	Technology
Runtime	Python 3.13+ with discord.py
Package Manager	uv for fast dependency management
Database	PostgreSQL with SQLModel (SQLAlchemy + Pydantic)
Type Safety	basedpyright with strict type hints
Code Quality	ruff for linting and formatting
Testing	pytest with async support
CLI	typer with custom command scripts
Logging	loguru for structured logging
Monitoring	sentry-sdk for error tracking
HTTP Client	httpx for async requests
Configuration	pydantic-settings with json/env support
Containers	Docker & Docker Compose
Cache	valkey with in-memory fallback