Skip to content

Commit 45efee4

Browse files
committed
Add tutorial for creating commands
1 parent d5248fb commit 45efee4

8 files changed

Lines changed: 42 additions & 0 deletions

File tree

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"label": "Getting Started"
3+
}
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Creating a command
2+
3+
## Overview
4+
5+
Commands are the main way users will interact with the bot in your chat. They can be used to trigger actions, or to display information to your users. In this example we will create a command that will display the amount of time that has past since a user was last seen in chat.
6+
7+
## Step 1 - Open the command creation tool
8+
9+
1. From the [bot command dashboard](https://streamelements.com/dashboard/bot/commands), navigate to the "Custom Commands" tab.
10+
2. Click the "Add New Command" button to open the command creation tool.
11+
12+
![Step 1](img/step_1.png)
13+
14+
## Step 2 - Basic settings
15+
16+
1. Enter the desired name for your new command. For this example we will name the command "lastseen".
17+
2. Add your desired response. For a list of all available variables, see the [variables documentation](../../variables).
18+
19+
![Step 2](img/step_2.png)
20+
21+
## Step 3 - Advanced settings
22+
23+
1. Optional: In the "Response Type" dropdown, select the method you would like the bot to use to send the response.
24+
- "Say" will send the response as a chat message as it is entered in the basic settings.
25+
- "Mention" will send the response as a chat message, but will prefix the message with [`@$(user),`](../../variables/sender).
26+
- "Reply" will send the response as a native reply to the user who triggered the command.
27+
- NOTE: If the platform does not support native replies, the response will be sent as a "Mention" instead.
28+
- "Whisper" will send the response as a whisper to the user who triggered the command.
29+
2. Optional: Add one or more command aliases to allow users to trigger the same command using alternate names.
30+
3. Click the "Activate Command" button to save your new command.
31+
32+
![Step 3](img/step_3.png)
112 KB
Loading
86.3 KB
Loading
131 KB
Loading
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Custom Commands
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
sidebar_position: 0
3+
---
4+
5+
# Getting Started
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Timers

0 commit comments

Comments
 (0)