Skip to content

{COMMAND_GROUP_NAME}

{Your introduction paragraphs go here}

Base Command

The base {COMMAND_GROUP_NAME} command {describes base functionality}.

Syntax:

Text Only
/{COMMAND_GROUP_NAME}
${COMMAND_GROUP_NAME}

Aliases:

  • {ALIAS1}
  • {ALIAS2}

When invoked without a subcommand, this command {what happens}.

Subcommands

Subcommand Description Usage
{SUBCOMMAND_NAME} {Brief description} /{GROUP_NAME} {SUBCOMMAND_NAME} [params]
{SUBCOMMAND_NAME} {Brief description} /{GROUP_NAME} {SUBCOMMAND_NAME} [params]

Category:

{Description of this category of subcommands}

{SUBCOMMAND_NAME}

{Brief description of what this subcommand does - 2-3 sentences}

Syntax:

Text Only
/{GROUP_NAME} {SUBCOMMAND_NAME} [parameters]
${GROUP_NAME} {SUBCOMMAND_NAME} [parameters]

Parameters:

  • {PARAMETER_NAME} - {Description}
  • {PARAMETER_NAME} - {Description}

Example:

Text Only
/{GROUP_NAME} {SUBCOMMAND_NAME} parameter_value

Common Workflows

Workflow Name:

{Description of what this workflow accomplishes - 1-2 sentences}

Steps:

  1. Use /{GROUP_NAME} {SUBCOMMAND_NAME} to {action}
  2. Use /{GROUP_NAME} {SUBCOMMAND_NAME} to {action}
  3. Use /{GROUP_NAME} {SUBCOMMAND_NAME} to {action}

Example:

Text Only
/{GROUP_NAME} {SUBCOMMAND_NAME} parameter
/{GROUP_NAME} {SUBCOMMAND_NAME} parameter
/{GROUP_NAME} {SUBCOMMAND_NAME} parameter

Permissions

Bot Permissions

Tux requires the following permissions for this command group:

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

User Permissions

Users need {PERMISSION_LEVEL} or higher to use commands in this group.

Subcommand Permissions

{Note if subcommands have different permissions, or if all share the same permissions}

Permission System

Configure command permissions via /config commands or see the Permission Configuration guide.

Configuration

This command group 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.

Examples

Example 1:

{Description of the scenario}

Text Only
/{GROUP_NAME} {SUBCOMMAND_NAME} parameter

{What happens when this is executed}

Example 2:

{Description of a multi-step scenario}

Text Only
/{GROUP_NAME} {SUBCOMMAND_NAME} parameter1
/{GROUP_NAME} {SUBCOMMAND_NAME} parameter2
/{GROUP_NAME} {SUBCOMMAND_NAME} parameter3

{What happens after the workflow}

Dashboard/Interface

When you use /{GROUP_NAME} or certain subcommands, Tux opens an interactive {DASHBOARD_TYPE}.

Features:

  • {Feature 1} - {Description}
  • {Feature 2} - {Description}
  • {Feature 3} - {Description}

Navigation:

  • {How to navigate the interface}
  • {How to interact with components}
  • {How to save/cancel changes}