Skip to main content

Chatbot Commands Overview

Updated

Creator_Tools.png

Purpose:

This guide explains how to use and customize chatbot commands in StreamElements. It covers default commands, custom commands, and advanced configurations like cooldowns, aliases, and permission levels.

Prerequisites:

Default commands

List of Default Commands
You can view a list of commonly used default commands in this document. Click on each command to explore its usage, parameters, and configuration options.

We support a wide variety of default commands that can be used out-of-the-box. These commands cover a broad range of functionalities, making it easy to create a rich and interactive chat experience. You can use these commands as they are, or customize them to suit your specific needs. Responses for these commands can't be customized but you can change their settings:

  • Command name: This is what triggers the command, all commands are triggered by an exclamation point (!) followed by the command name
  • User level: This controls which group can trigger the command, and it can be set to three values
    • Everyone: No restrictions
    • Subscribers: Viewers that are subscribed to your channel
    • Regular: Those that are manually added as StreamElements Regulars
    • VIP: Viewers that you've added as VIP
    • Moderator: Moderators of your channel
    • Super Moderator: Those that are manually added as StreamElements Super Moderators
    • Broadcaster: You will be the only one able to trigger the command
  • Command availability: You can choose to enable the command only when the stream is Online, Offline or Both
  • Command cost: This is the cost of the command, in case you want to use our loyalty system to limit its usage
  • User cooldown: This is how much time it needs to pass before the command can be triggered again by the same user (seconds)
  • Global cooldown: This is how much time it needs to pass before the command can be triggered again by anyone (seconds)
  • Command aliases: These are alternative ways of triggering the command, they will also need to be triggered with an exclamation point (!) (you can have up to 10 aliases per command)

Custom Commands

In addition to the default commands, you can create your own custom commands to tailor interactions and functionalities to your channel and community. Custom commands enable unique interactions that are not possible with the default commands.

Managing Custom Commands

There are two primary ways to manage custom commands:

  1. Through the Creator Dashboard
  2. Directly in Chat with the !command Command

Using the Dashboard to Manage Custom Commands

Refer to the "Creating a Command" section in the Getting Started guide for detailed instructions on managing custom commands via the dashboard.

Using Chat to Manage Custom Commands

Creating a Custom Command in Chat

The general syntax is as follows:

!command add <command name> <response>

Modifying a Custom Command in Chat

!command edit <command name> <response>

Deleting a Custom Command in Chat

!command remove <command name>

Displaying the Command Text in Chat

!command show <command name>

Example Output:

@Styler, command test: ${channel} This is a test command. ${settitle ${1:}}

Changing the Options / Permissions / Cooldowns of a Command

!command options <command name> <-option> <value>

For specifics, refer to the documentation for the !command command.

Examples

The Simplest Command

A basic command that responds with a static text message.

Creating the Command

!command add test This is a test command

Example Input

!test

Example Output

This is a test command


Accepting Arguments in a Command

Arguments can be used with ${} and the number of the passed argument.

Creating the Command

!command add greet Welcome to the stream ${1}!

Example Input

!greet styler

Example Output

Welcome to the stream styler!


Accepting Multiple Arguments in a Command

Arguments can be used with ${} and the number of the passed argument. If the incorrect number of arguments is provided, the command won't run.

Creating the Command

!command add greet Welcome to the stream ${1} and ${2}!

Example Input

!greet styler styler2

Example Output

Welcome to the stream styler and styler2!


Using Variables

Chat commands support variables dynamically. Variables are placeholders that represent specific values or pieces of information. When a command is triggered, these variables are replaced with their actual values.

Creating the Command

!command add shoutout Check out ${1}, they are playing ${game ${1}} at https://twitch.tv/${channel ${1}}

Example Input

!shoutout styler

Example Output

Check out styler, they are playing Minecraft at https://twitch.tv/styler

Setting Permission Levels

You may want to restrict command usage based on user permission levels.

Creating the Command with Permission Level

!command options shoutout -level 500

This configuration allows only users with access level moderator or higher to use the command. For a list of available access levels, see the !level command.

Using variables makes chat commands more versatile and powerful, enabling a wide range of interactions and automated responses.

Both the ${} and $() syntaxes are supported and can be used interchangeably. For instance, ${uptime shroud} can also be written as $(uptime shroud).


For a full list of available variables you can use in your commands, be sure to check out the official documentation here. This will help you customize your chatbot responses and automate interactions more effectively!

Additional Resources: 

For more information, please refer to this resource.

Related to

Related articles