Index

Previous Next

Welcome to the Tux User Guide! This section covers everything you need to know to use Tux in your Discord server.

What is Tux?

Tux is a comprehensive Discord bot built for Linux communities, offering powerful moderation tools, community engagement features, and utility commands.

Quick Navigation

🚀 Getting Started

New to Tux? Start here:

📋 Commands by Category

Explore all available commands:

  • Moderation - Ban, kick, jail, timeout, warn, and case management
  • Utility - Ping, polls, reminders, AFK, timezone tools
  • Info - User, server, and channel information
  • Snippets - Create and manage text snippets
  • Levels - View and manage XP/levels
  • Fun - Random commands and XKCD comics
  • Tools - TLDR pages, Wolfram Alpha, Wikipedia
  • Code Execution - Run code with Godbolt/Wandbox
  • Config - Server configuration commands
  • Admin/Dev - Administrative and development commands

🎮 Features

Discover Tux's powerful features:

Common Tasks

First-Time Setup

  1. Invite Tux to your server
  2. Run /config wizard to set up basic configuration
  3. Configure permissions for your moderators
  4. Set up your channels and roles

Moderation

  • Timeout a user: /timeout @user 10m Spam
  • Ban a user: /ban @user Violated rules
  • View cases: /cases view or /cases view 123
  • Manage jail: /jail @user and /unjail @user

Community Engagement

  • Check XP: /level or /level @user
  • Create poll: /poll "Question?" "Option 1" "Option 2"
  • Set reminder: /remindme 1h Check something
  • View starboard: Messages with ⭐ reactions

Server Management

  • Create snippet: /createsnippet rules Server rules text...
  • Use snippet: /snippet rules
  • Set AFK: /afk Going to lunch
  • Get info: /info @user or /info #channel

Permission System

Tux uses a rank-based permission system with levels 0-7:

Rank Name Typical Use
0 Member Basic server member
1 Trusted Trusted members
2 Junior Moderator Can warn, timeout
3 Moderator Can kick, ban
4 Senior Moderator Full moderation access
5 Administrator Server administration
6 Head Administrator Full server control
7 Server Owner Complete access

Learn more about permissions →

Command Syntax

Tux fully supports Discord slash commands with auto-completion:

/command option:value
/timeout user:@someone duration:10m reason:Spam

Prefix Commands

You can also use traditional prefix commands (default: $):

$command arguments
$timeout @someone 10m Spam

The prefix can be customized with /config prefix.

Getting Help

In-Discord Help

Use Tux's built-in help system:

/help                    # Show all commands
/help moderation         # Show category help
/help timeout            # Show specific command help

External Resources

Tips for Users

Use Slash Commands

Slash commands provide:

  • Auto-completion for options
  • Built-in help text
  • Better error messages
  • Consistent syntax

Check Permissions

If a command doesn't work, check:

  1. Your assigned roles (/config role)
  2. The command's required rank
  3. Channel-specific permissions

Bookmark the Docs

Save this documentation for quick reference:

  • Bookmark this page
  • Use browser search (Ctrl+F) to find commands
  • Check the command reference pages

For Server Administrators

Initial Setup

  1. Run Config Wizard: /config wizard
  2. Set up moderation channels
  3. Configure jail system
  4. Set up starboard

  5. Configure XP roles

  6. Set Up Permission Ranks: /config rank init

  7. Assign roles to permission ranks
  8. Test permissions with different roles

  9. Adjust as needed

  10. Configure Features:

  11. Enable/disable features in config
  12. Set up logging channels
  13. Configure XP multipliers
  14. Set up automated actions

For a typical server:

  • Moderation Channel: Private channel for mod logs
  • Jail Role: Role that restricts channel access
  • Starboard: Public channel for starred messages (requires 3-5 stars)
  • XP System: Enable with role rewards at key levels

Moderation Best Practices

  • Use warnings before timeouts/bans
  • Document cases with detailed reasons
  • Review cases regularly with /cases
  • Set up automated logging for transparency
  • Train moderators on command usage

Customization

Per-Server Configuration

Each server can customize:

  • Command prefix
  • Permission rank assignments
  • Feature enable/disable
  • XP role rewards
  • Starboard threshold
  • Jail system configuration

Use /config to manage these settings.

Role Integration

Tux integrates with Discord roles:

  • Permission Ranks: Assign Discord roles to Tux permission ranks
  • XP Roles: Auto-assign roles based on XP level
  • Jail System: Uses a configured jail role
  • Status Roles: Auto-assign based on Discord status

What's Next?

New Users

Moderators

Administrators

Ready to explore? Choose a section from the navigation or check out the command reference!

For Developers Inviting Tux