Skip to content

{MODULE_NAME}

{Your introduction paragraphs go here}

Command Groups

This module includes the following command groups:

{GROUP_NAME}

{Brief description of what this command group does and its purpose}

Commands:

  • {COMMAND_NAME} (aliases: {ALIAS1}, {ALIAS2}) - {Brief description}
  • {COMMAND_NAME} - {Brief description}

Commands

Command Aliases Description Documentation
/command {ALIAS1}, {ALIAS2} {Brief one-line description} Details
/command — {Brief one-line description} Details

Common Use Cases

Use Case Name:

{Brief description of when this use case applies - 1-2 sentences}

Steps:

  1. {Step 1 with example command if helpful}
  2. {Step 2 with example command if helpful}
  3. {Step 3 with example command if helpful}

Example:

Text Only
/command @user parameter

Configuration

This module requires the following configuration:

  • {SETTING_NAME}: {Description and how to configure}
  • {SETTING_NAME}: {Description and how to configure}

Configuration Guide

For detailed configuration instructions, see the Admin Guide.

Permissions

Bot Permissions

Tux requires the following permissions for this module:

  • {PERMISSION_NAME} - {Why it's needed}
  • {PERMISSION_NAME} - {Why it's needed}

User Permissions

{Describe user permission requirements - e.g., "Users need Moderator rank (typically rank 3-5) or higher to use commands in this module" or "Commands are available to all users by default"}

Permission System

Tux uses a dynamic permission system. Configure command permissions via /config commands or see the Permission Configuration guide.

Documentation Templates

When documenting individual commands, command groups, or features related to this module, use the appropriate templates from Documentation Templates. These templates ensure consistency and completeness across all documentation.