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.
Choose your path to get started with Tux:
| Role | Get Started |
|---|---|
| 👤 Users | Get Started |
| ⚙️ Admins | Get Started |
| 🐳 Self-Hosters | Get Started |
| 💻 Developers | Get Started |
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
- 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
| 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 |
Visit tux.atl.dev for complete documentation including:
- User Guide - Commands, features, and usage
- Admin Guide - Configuration and server setup
- Self-Hosting - Installation and deployment
- Developer Guide - Architecture and contributing
- API Reference - CLI tools and codebase reference
- FAQ - Common questions and answers
- Discord Server - Get help, report issues, and discuss features
- GitHub Issues - Bug reports and feature requests
Developer Resources:
| Getting Started | Development Workflow | Quality & Standards |
|---|---|---|
| Developer Setup | Git Best Practices | Testing Guide |
| First Contribution | Branch Naming | Code Review |
| Project Structure | Creating Commands | Error Handling |
Tux is free and open source software licensed under the GNU General Public License v3.0.
Created by @kzndotsh • Maintained by the All Things Linux community