Repository files navigation

Choose your path to get started with Tux:

Tux is a feature-rich Discord bot originally built for theAll 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

• 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

Visittux.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

Want to contribute? Assuming you have the basics like Docker and a Discord bot for testing, you can get started in minutes:

# For org members: Clone directlygit clone https://github.com/allthingslinux/tux.git&&cd tux# For external contributors: Fork on GitHub first, then:git clone https://github.com/YOUR_USERNAME/tux.git&&cd tuxgit remote add upstream https://github.com/allthingslinux/tux.git# Install dependenciesuv sync# Install pre-commit hooksuv run pre-commit installgit config blame.ignoreRevsFile .git-blame-ignore-revs# Generate and edit configuration filesuv run config generatecp .env.example .env&& cp config/config.toml.example config/config.toml# Setup databaseuv run docker up -d tux-postgresuv run db push# Develop, run, lint, and testgit checkout -b feature/your-feature-name# ... make changes ...uv run tux start --debuguv run dev allgit commit -m"feat(command): add new command"# ... repeat until you are ready ...git push origin feature/your-feature-name

Developer Resources:

Tux is free and open source software licensed under theGNU General Public License v3.0.

Founded by@kzndotsh • Maintained by theAll Things Linux community