Skip to content

{COMMAND_NAME}

{Your introduction paragraphs go here}

Syntax

The {COMMAND_NAME} command can be used in two ways:

Slash Command:

Text Only
/{COMMAND_NAME} [parameters]

Prefix Command:

Text Only
${COMMAND_NAME} [parameters]

Aliases:

  • {ALIAS1}
  • {ALIAS2}

Parameters

Parameter Type Required Description
{PARAMETER_NAME} {TYPE} {Yes/No} {Description}
{PARAMETER_NAME} {TYPE} {Yes/No} {Description}

{PARAMETER_NAME}

{Detailed description of the parameter}

  • Type: {TYPE}
  • Required: {Yes/No}
  • Constraints: {Any limits, format requirements, etc.}
  • Examples: {Valid values or formats}

Flags

This command supports the following flags:

Flag Type Default Description
--{FLAG_NAME} {TYPE} {DEFAULT} {Description}
--{FLAG_NAME} {TYPE} {DEFAULT} {Description}

--{FLAG_NAME}

{Detailed description of the flag}

  • Type: {TYPE}
  • Default: {DEFAULT_VALUE}
  • Usage: {How to use this flag}
  • Examples:
Text Only
/command @user --{FLAG_NAME} value
$command @user --{FLAG_NAME} value

Permissions

Bot Permissions

Tux requires the following permissions to execute this command:

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

User Permissions

Users need {PERMISSION_LEVEL} or higher to use this command.

Permission System

Command permissions are configured per-guild using Tux's dynamic permission system. Configure via /config commands or see the Permission Configuration guide.

Usage Examples

Basic Usage

{Simple, most common use case}

Text Only
/{COMMAND_NAME} @user

{What happens when this is executed}

With Parameters

{Example with additional parameters}

Text Only
/{COMMAND_NAME} @user parameter value

{What happens when this is executed}

With Flags

{Example using flags}

Text Only
/{COMMAND_NAME} @user --{FLAG_NAME} value

{What happens when this is executed}

Advanced Usage

{Complex example showing multiple parameters/flags}

Text Only
/{COMMAND_NAME} @user parameter --{FLAG_NAME} value --{FLAG_NAME2} value

{What happens when this is executed}

Response

When executed successfully, this command {description of response}.

{Example of what the response looks like - embed, message, action taken, etc.}

Error Handling

Common Errors

Error:

When it occurs: {Circumstances that trigger this error}

Error message:

Text Only
{Actual or example error message}

Solution: {How to fix it}

Behavior Notes

  • {BEHAVIOR_NOTE}: {Description}
  • {BEHAVIOR_NOTE}: {Description}

Tip

{Helpful tip about using this command effectively}

Warning

{Important warning about using this command}

Configuration

This command's behavior can be configured via {CONFIGURATION_METHOD}:

  • {SETTING_NAME}: {Description and effect on command behavior}
  • {SETTING_NAME}: {Description and effect on command behavior}

Configuration Guide

See the Configuration Guide for detailed setup instructions.