Tux

Getting Started User Guide Admin Guide Developer Guide Reference Community

Index

Getting Started

Development Setup
Project Structure
First Contribution
Code Standards

Architecture

Overview
Bot Lifecycle
Cog System
Command System
Permission System
Configuration System
Database Architecture
Service Layer

Core Systems

Hot Reload
Error Handling
Sentry Integration
Task Monitor
Logging
Prefix Manager
Emoji Manager
Plugin System

Patterns

Database Patterns
Error Patterns
Async Patterns
Caching
Service Wrappers

Guides

Creating a Cog
Creating Commands
Database Operations
UI Components
External APIs
Adding Features
Config Options

Modules

Index
Moderation System
Levels System
Snippets System
Code Execution
Config Wizard

Database

Models
Controllers
Base Controllers
Migrations
Testing

Testing

Overview
Unit Tests
Integration Tests
E2E Tests
Fixtures
CI Pipeline

CLI Tools

Index
Overview
Extending CLI

UI System

Embeds
Views
Modals
Buttons
Onboarding Wizard

Contributing

Git Workflow
Code Review
Documentation
Versioning
Design Decisions

CI Pipeline

Previous Next

GitHub Actions workflow.

Full documentation in progress.

Menu

Getting Started

Index For Users For Self-Hosters For Developers

User Guide

Index Inviting Tux Permissions

Admin Guide

Developer Guide

Reference

Index CLI Reference Configuration

Community

Index Changelog FAQ Support Contributing

On This Page

shadcn theme provided by @asiffer