Skip to content

Commit f83ca11

Browse files
committed
docs: update sidebar labels and descriptions
1 parent 3f5c3f9 commit f83ca11

4 files changed

Lines changed: 108 additions & 59 deletions

File tree

docs/chatbot/variables/7tvemotes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: 7tvemotes
3-
sidebar_label: "7TV Emotes"
3+
sidebar_label: "$(7tvemotes)"
44
description: "Lists active 7TV emotes in a Twitch channel. Learn how to use the $(7tvemotes) variable in StreamElements Chatbot commands."
55
tags:
66
- chatbot

docs/chatbot/variables/ai.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,16 @@
22
id: ai
33
sidebar_label: "$(ai)"
44
description: "Learn how to use the StreamElements AI chatbot variable to generate dynamic responses in your stream chat."
5-
keywords:
5+
tags:
6+
- chatbot
67
- ai
8+
- variables
9+
keywords:
710
- streamelements ai
811
- chatbot ai
912
- twitch bot
1013
- stream bot
14+
- ai variable
1115
---
1216

1317
# $(ai) Variable

docs/chatbot/variables/args.md

Lines changed: 38 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,87 +1,81 @@
11
---
22
id: args
3+
sidebar_label: "$(args)"
4+
description: "Learn how to use the $(args) variable in StreamElements chatbot commands for dynamic, user-input-based responses."
35
tags:
46
- chatbot
57
- variable
68
keywords:
79
- args
810
- arguments
11+
- chatbot commands
12+
- user input
13+
- dynamic responses
914
---
1015

11-
# $(args)
16+
# $(args) Variable
17+
18+
## Overview
1219

1320
The `$(args)` variable is a powerful feature in StreamElements chatbot commands that allows you to access and manipulate arguments passed by users. This enables dynamic responses based on user input, enhancing the interactivity of your chatbot.
1421

15-
## Basic Usage
22+
## Usage
1623

17-
### Syntax
24+
The basic syntax for using the `$(args)` variable is:
1825

1926
```
2027
$(args)
2128
```
2229

23-
### Description
30+
You can access specific arguments using numeric indices, starting from 1:
2431

25-
The `$(args)` variable represents all arguments passed to a command. You can access specific arguments using numeric indices, starting from 1.
32+
```
33+
$(1), $(2), $(3), etc.
34+
```
2635

27-
### Examples
36+
## Examples
2837

29-
1. Accessing the first argument:
38+
1. Greeting a user:
3039
```
3140
Command: !greet $(1)
3241
User input: !greet World
3342
Output: Hello, World!
3443
```
3544

36-
2. Using multiple arguments:
45+
2. Introducing a user:
3746
```
3847
Command: !introduce $(1) is $(2) years old
3948
User input: !introduce Alice 25
4049
Output: Alice is 25 years old
4150
```
4251

43-
## Advanced Features
44-
45-
### $(args.emote)
46-
47-
This variant outputs an argument only if it is a valid emote.
48-
49-
#### Syntax
50-
51-
```
52-
$(n.emote)
53-
```
54-
Where `n` is the argument index.
55-
56-
#### Example
52+
## Parameters
5753

58-
```
59-
Command: !emote $(1.emote)
60-
User input: !emote Kappa
61-
Output: Kappa
54+
The `$(args)` variable has two special variants:
6255

63-
User input: !emote Hello
64-
Output: [No output, as "Hello" is not an emote]
65-
```
56+
1. `$(n.emote)`: Outputs an argument only if it is a valid emote.
57+
```
58+
Command: !emote $(1.emote)
59+
User input: !emote Kappa
60+
Output: Kappa
61+
```
6662

67-
### $(args.word)
63+
2. `$(n.word)`: Outputs an argument only if it does not contain symbols.
64+
```
65+
Command: !word $(1.word)
66+
User input: !word Hello
67+
Output: Hello
68+
```
6869

69-
This variant outputs an argument only if it does not contain symbols.
70+
Where `n` is the argument index in both cases.
7071

71-
#### Syntax
72+
## Related Variables
7273

73-
```
74-
$(n.word)
75-
```
76-
Where `n` is the argument index.
74+
- [$(user)](user): Represents the username of the person using the command
75+
- [$(channel)](channel): Represents the channel name where the command is used
7776

78-
#### Example
77+
## FAQ
7978

80-
```
81-
Command: !word $(1.word)
82-
User input: !word Hello
83-
Output: Hello
79+
**Q: What happens if I try to access an argument that wasn't provided?**
8480

85-
User input: !word Hello!
86-
Output: [No output, as "Hello!" contains a symbol]
87-
```
81+
A: If you try to access an argument that wasn't provided (e.g., `$(2)` when only one argument was given), the output will be blank.
Lines changed: 64 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,81 @@
11
---
22
id: bttvemotes
3+
sidebar_label: "$(bttvemotes)"
4+
description: "Learn how to use the $(bttvemotes) variable to display active BetterTTV emotes in your Twitch channel."
35
tags:
4-
- chatbot
5-
- variable
6+
- chatbot
7+
- variable
8+
- emotes
69
keywords:
7-
- bttv
8-
- emotes
9-
- betterttv
10+
- bttv
11+
- emotes
12+
- betterttv
13+
- twitch
14+
- chat
1015
---
1116

12-
# $(bttvemotes)
17+
# $(bttvemotes) Variable
1318

14-
Lists the active BetterTTV emotes in the channel.
19+
## Overview
1520

16-
#### Parameters
21+
The `$(bttvemotes)` variable lists all active BetterTTV (BTTV) emotes in your Twitch channel. This feature allows streamers and viewers to easily see which custom BTTV emotes are available for use in the chat.
1722

18-
This variable does not take any parameters.
23+
## Usage
1924

20-
#### Example Input
25+
To use this variable, simply include `$(bttvemotes)` in your chatbot command or message. The variable doesn't require any additional parameters.
2126

27+
## Examples
28+
29+
### Example 1: Displaying BTTV Emotes
30+
31+
**Command:**
32+
```
33+
!bttvemotes
34+
```
35+
36+
**Chatbot Response:**
37+
```
38+
The active BTTV emotes in this channel are: $(bttvemotes)
39+
```
40+
41+
**Output:**
42+
```
43+
The active BTTV emotes in this channel are: LULW KEKW 5Head PogU
44+
```
45+
46+
### Example 2: Creating a Custom Command
47+
48+
**Command:**
2249
```
23-
$(bttvemotes)
50+
!command add !customemotes Our channel's BTTV emotes: $(bttvemotes)
2451
```
2552

26-
#### Example Output
53+
**Usage:**
54+
```
55+
!customemotes
56+
```
2757

58+
**Chatbot Response:**
2859
```
29-
LULW KEKW 5Head PogU
60+
Our channel's BTTV emotes: LULW KEKW 5Head PogU
3061
```
62+
63+
## Parameters
64+
65+
This variable does not accept any parameters.
66+
67+
## Related Commands
68+
69+
- [$(ffzemotes)](ffzemotes): Lists active FrankerFaceZ (FFZ) emotes in the channel
70+
- [$(7tvemotes)](7tvemotes): Lists active 7TV emotes in the channel
71+
72+
## FAQ
73+
74+
**Q: How often is the list of BTTV emotes updated?**
75+
A: The BTTV emote list is cached for 48 hours. To update the list immediately, you can use the command `!emotes reload`.
76+
77+
**Q: Can I use this variable to check BTTV emotes in other channels?**
78+
A: No, the `$(bttvemotes)` variable only shows BTTV emotes for the channel where the chatbot is active.
79+
80+
**Q: What if there are no BTTV emotes enabled in my channel?**
81+
A: If no BTTV emotes are enabled, the variable will return an empty result.

0 commit comments

Comments
 (0)