Moderation¶

The Moderation module provides a comprehensive set of commands for managing your Discord server. It is essential for server administrators and moderators, offering tools for user management, case tracking, warnings, and automated moderation actions.

The module includes commands for banning, kicking, warning users, managing moderation cases, and handling various moderation scenarios. All moderation actions are logged to moderation cases, providing a complete audit trail of all actions taken in your server.

Command Groups¶

This module includes the following command groups:

Cases¶

The cases command group provides tools for viewing and managing moderation cases. Each moderation action creates a case, which can be viewed, edited, and referenced later.

Commands:

• cases view (aliases: v, show, get, list) - View a specific moderation case by number
• cases search (aliases: filter, find) - Search/filter moderation cases by criteria
• cases modify (aliases: m, edit, update) - Modify case information (status, reason)

Commands¶

Common Use Cases¶

Use Case Name: Handling Rule Violations¶

When a member violates server rules, moderators need a quick way to take action and maintain order.

Steps:

1. Issued a warning for first-time violations using /warn.
2. Use /timeout for repeat violations to temporarily restrict member interaction.
3. Use /ban for severe violations to permanently remove the member.

Example:

/warn member:@user reason:"Spamming in general channel"
/timeout member:@user reason:"Repeat spam" duration:1h
/ban member:@user reason:"Malicious behavior"

Use Case Name: Cleaning Up Channels¶

Moderators often need to clean up spam messages or slow down a fast-moving conversation.

Steps:

1. Use /purge to bulk-delete recent messages.
2. Apply /slowmode to the channel to prevent further spamming.

Example:

/purge limit:10
/slowmode seconds:30s

Use Case Name: Case Management¶

Reviewing moderation history and managing cases ensures transparency and consistency in server management.

Steps:

1. Use /cases to view the moderation log.
2. Search for specific users or moderators using /cases search.
3. Update case details like reasons or statuses using /cases modify.

Example:

/cases
/cases view case_number:123
/cases search user:@user
/cases modify reason:"Update: User apologized" case_number:123

Configuration¶

This module requires the following configuration:

• Moderation Log Channel: Channel where moderation actions are logged
• Jail Channel: Channel for jailed members (if using jail commands)
• Permission Ranks: Configure which ranks can use moderation commands

Permissions¶

Bot Permissions¶

Tux requires the following permissions for this module:

• Ban Members - Required for ban and unban commands
• Kick Members - Required for kick commands
• Manage Messages - Required for purge and slowmode commands
• Moderate Members - Required for timeout commands
• Manage Roles - Required for jail commands (role-based jail)
• Send Messages - Required for command responses and logs
• Embed Links - Required for rich moderation embeds

User Permissions¶

Users need Moderator rank (typically rank 3-5) or higher to use commands in this module.

Related Documentation¶

• Permission Configuration
• Admin Configuration Guide
• Jail Configuration
• Cases Command Group