Commands

Define and configure your chat commands

Chat commands in Streamer.bot are platform-agnostic, supporting Twitch, YouTube and Trovo.

Configuration options give you fine-grained control over command text parsing, cooldowns, and user permissions.

To get started, navigate to Commands in Streamer.bot

Commands Pane

To create your first command, Right-Click in commands pane and select Add to open the configuration dialog.

Configuration

Commands Configuration Dialog

Name
Text required
Enter a friendly name for this command
This can be any label to recognize your command with. The actual text used for command execution will be defined in the Commands field.

::

Enabled
Toggle
Toggle this command on or off
Include
Toggle
Include this command in the Get Commands sub-action
Mode
Select required
Select a text matching mode for this command:
- `Basic` - Match at least one of the strings entered, based on the configured `Location` option
- `Regex` - Match based on Regular Expression
Location
Select
Modify the text matching behavior when using the Basic mode:
- `Start` - Match chat messages that **begin with** at least one command alias
- `Exact` - Match chat messages that are **exactly** the same text as at least one command alias
- `Anywhere` - Match chat messages that **contain** at least one command alias
Commands
Text required
Enter the text from chat used to execute this command
You can enter multiple trigger strings or aliases by adding one item per line
Command cooldowns are shared across all configured aliases within a command entity. You should create separate commands if you need exclusive cooldowns for each.
Group
Text
Optionally type or select a group for this command

::

Options

Ignore Bot Account
Toggle
Ignore messages from the bot account, if it is configured for the respective chat platform
Ignore Internal Messages
Toggle
Ignore messages from the internal Streamer.bot chat loopback.
Disabling this option is useful if you want to trigger commands internally, such as inside the Streamer.bot Chat Window

::

Persist per User Counter
Toggle
Persist the User Counter data for this command across restarts of Streamer.bot
Refer to the userCounter variable returned by the Command Triggered trigger
Persist Counter
Toggle
Persist the Counter data for this command across restarts of Streamer.bot
Refer to the counter variable returned by the Command Triggered trigger
Case Sensitive
Toggle
Require command aliases to be matched using the exact casing specified
Source(s)
Toggle
You can select any combination of chat sources to watch for execution of this command:
- `Twitch Message` - Accept commands from the chat of the configured [Twitch Broadcaster](/guide/platforms/twitch) account
- `YouTube Message` - Accept commands from the chat of the configured [YouTube Broadcaster](/guide/platforms/youtube) account
- `Twitch Whisper` - Accept commands from whispers sent to the configured [Twitch Broadcaster](/guide/platforms/twitch) account
- `Twitch Subscription Message` - Accept commands included in the Twitch sub message
- `Twitch Re-subscription Message` - Accept commands incldued in the Twitch re-sub message

::

Cooldowns

To prevent spam or generally restrict usage of your command, you can configure cooldown options:

Global Cooldown
Number
Enter a minimum time, in seconds, before the command can be used by anyone again after it is executed
  • Set to 0 to disable global cooldowns ::
    User Cooldown
    Number
    Enter a minimum time, in seconds, before the command can be used by a specific user again after it is executed by that user
  • Set to 0 to disable user cooldowns :: ::
The Broadcaster Account is always exempt from cooldowns. If you are testing this feature, ensure you use a different account.

Permissions

By default, commands can be executed by anyone in chat.

You can restrict access to your commands by configuring permissions options:

Grant Type
Select
Modify the grant type for all configured permissions within this command:
  • Allow - Only the specified groups or users can execute this command
  • Deny - Everyone except the specified groups or users can execute this command ::
If the Allowed or Denied fields are left empty, the permission applies to everyone. - Grant type Allow, with an empty Allowed field will allow all users access - Grant type Deny with an empty Denied field will deny all users access

::

The Broadcaster Account is always exempt from permission settings. If you are testing this feature, ensure you use a different account.

Context Menu

From the Commands tab, Right-Click any existing command to reveal the context menu.

Options are outlined below:

Add

Create a new command

Edit

Open the command configuration dialog.

This is the same as Double-Click the entry

Delete

Delete the selected command

Rename Group

Quickly rename the current group of the selected command

Set Group

Quickly assign the selected command to another group

Enabled

Quickly toggle this command on or off

Reset Counters

Reset stored counter data for the selected command

Reset User Counters

Reset stored user counter data for the selected command

Add to Export

Add this command to the current export

Read more about Importing & Exporting

Copy Command Id

Copy the unique ID string for the selected command to your clipboard

Usage

Once you have configured your commands, you can assign them to actions with triggers!

Read more in API > Sub Actions > Core > Commands
Read more in API > Triggers > Core > Commands
Read more in API > C# > Methods > Core > Commands