Levels¶

The Levels module provides a comprehensive XP and leveling system for your Discord server. It tracks user activity through messages and automatically assigns roles based on their earned experience points, encouraging engagement and rewarding active community members.

This system includes automatic XP gain with configurable cooldowns, role rewards for hitting level milestones, and administrative tools to manage user progress or restrict leveling in specific areas.

Command Groups¶

This module includes the following command groups:

Levels (Admin)¶

The /levels command group provides administrative tools for managing member XP and leveling status. These commands are essential for resolving issues, rewarding specific users, or managing leveling restrictions.

Commands:

• /levels set - Set a member's level directly
• /levels setxp - Set a member's XP amount
• /levels reset - Reset a member's XP and level to zero
• /levels blacklist - Prevent a member from gaining XP

Commands¶

Common Use Cases¶

Use Case Name: Checking Ranking Progress¶

Members can check their standing in the server and see how much XP is needed for the next level.

Steps:

1. Use the /level command in any allowed channel.
2. View the progress bar and current XP stats in the resulting embed.

Example:

/level
/level member:@user

Use Case Name: Manual Level Adjustments¶

Administrators can manually adjust a user's level or XP to correct errors or provide rewards.

Steps:

1. Use /levels set to skip levels or /levels setxp for precise adjustments.
2. The bot will automatically update the user's roles to match their new level.

Example:

/levels set member:@user new_level:10
/levels setxp member:@user xp_amount:5000

Configuration¶

This module requires the following configuration:

• XP Roles: Define which roles are awarded at specific levels.
• XP Blacklist Channels: Channels where message activity does not grant XP.
• XP Cooldown: Time between messages that grant XP to prevent spamming.

Permissions¶

Bot Permissions¶

Tux requires the following permissions for this module:

• Send Messages - Required for command responses
• Manage Roles - Required to assign and remove level-based roles
• Embed Links - Required for rank cards and progress displays

User Permissions¶

The /level command is available to all users. Administrative commands under /levels require Moderator rank (typically rank 3-5) or higher.

Related Documentation¶

• Permission Configuration
• Admin Configuration Guide