Welcome to Tux! This guide will help you get started based on what you want to do.
Choose Your Path
👥 I Want to Use Tux
You're a Discord server admin or user who wants to use Tux's features.
You'll learn:
- How to invite Tux to your server
- Available commands and how to use them
- Permission ranks and how they work
- Features like XP system, starboard, and snippets
🚀 I Want to Run My Own Tux
You want to self-host Tux for your community.
You'll learn:
- How to deploy Tux (Docker, VPS, cloud platforms)
- Database setup and migrations
- Configuration options
- Operations and maintenance
💻 I Want to Contribute to Tux
You're a developer who wants to contribute code or build features.
You'll learn:
- Development environment setup
- Codebase architecture
- Testing and CI/CD
- Contributing guidelines
Quick Start by Role
| I Am... | I Want To... | Start Here |
|---|---|---|
| Server Admin | Add Tux to my server | User Guide |
| Server Moderator | Learn moderation commands | Moderation Commands |
| Self-Hoster | Deploy with Docker | Docker Deployment |
| System Administrator | Set up on VPS | VPS Deployment |
| Developer | Set up dev environment | Development Setup |
| Contributor | Make first PR | First Contribution |
Need Help?
- Discord Support - Join our community for help
- GitHub Issues - Report bugs or request features
- FAQ - Common questions and answers
Choose your path above to continue!