Warning

This document is for Red's development version, which can be significantly different from previous releases. If you're a regular user, you should read the Red documentation for the current stable release.

CustomCommands

This is the cog guide for the customcommands cog. You will find detailed docs about usage and commands.

[p] is considered as your prefix.

Note

To use this cog, load it by typing this:

[p]load customcom

Usage

This cog contains commands for creating and managing custom commands that display text.

These are useful for storing information members might need, like FAQ answers or invite links. Custom commands can be used by anyone by default, so be careful with pings. Commands can only be lowercase, and will not respond to any uppercase letters.

Commands

customcom

Syntax

[p]customcom

Tip

Alias: cc

Description

Base command for Custom Commands management.

customcom cooldown

Note

This command is locked to the mod role.

Syntax

[p]customcom cooldown <command> [cooldown] [per=member]

Description

Set, edit, or view the cooldown for a custom command.

You may set cooldowns per member, channel, or guild. Multiple cooldowns may be set. All cooldowns must be cooled to call the custom command.

Examples:
  • [p]customcom cooldown pingrole

  • [p]customcom cooldown yourcommand 30

  • [p]cc cooldown mycommand 30 guild

Arguments:

  • <command> The custom command to check or set the cooldown.

  • <cooldown> The number of seconds to wait before allowing the command to be invoked again. If omitted, will instead return the current cooldown settings.

  • <per> The group to apply the cooldown on. Defaults to per member. Valid choices are server, guild, user, and member.

customcom create

Note

This command is locked to the mod role.

Syntax

[p]customcom create <command> <text>

Tip

Alias: customcom add

Description

Create custom commands.

If a type is not specified, a simple CC will be created. CCs can be enhanced with arguments, see the guide here.

customcom create random

Note

This command is locked to the mod role.

Syntax

[p]customcom create random <command>

Description

Create a CC where it will randomly choose a response!

Note: This command is interactive.

Arguments:

  • <command> The command executed to return the text. Cast to lowercase.

customcom create simple

Note

This command is locked to the mod role.

Syntax

[p]customcom create simple <command> <text>

Description

Add a simple custom command.

Example:
  • [p]customcom create simple yourcommand Text you want

Arguments:

  • <command> The command executed to return the text. Cast to lowercase.

  • <text> The text to return when executing the command. See guide for enhanced usage.

customcom delete

Note

This command is locked to the mod role.

Syntax

[p]customcom delete <command>

Tip

Aliases: customcom del, customcom remove

Description

Delete a custom command.

Example:
  • [p]customcom delete yourcommand

Arguments:

  • <command> The custom command to delete.

customcom edit

Note

This command is locked to the mod role.

Syntax

[p]customcom edit <command> [text]

Description

Edit a custom command.

Example:
  • [p]customcom edit yourcommand Text you want

Arguments:

  • <command> The custom command to edit.

  • <text> The new text to return when executing the command.

customcom list

Syntax

[p]customcom list

Description

List all available custom commands.

The list displays a preview of each command’s response, with markdown escaped and newlines replaced with spaces.

customcom raw

Syntax

[p]customcom raw <command>

Description

Get the raw response of a custom command, to get the proper markdown.

This is helpful for copy and pasting.

Arguments:

  • <command> The custom command to get the raw response of.

customcom show

Syntax

[p]customcom show <command_name>

Description

Shows a custom command’s responses and its settings.

Arguments:

  • <command> The custom command to show.