Skip to content

Commit bf7ce2d

Browse files
committed
docs: Update channel variable description
1 parent f83ca11 commit bf7ce2d

2 files changed

Lines changed: 85 additions & 72 deletions

File tree

docs/chatbot/variables/channel.md

Lines changed: 76 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -1,123 +1,130 @@
11
---
22
id: channel
3-
description: Learn how to use channel-specific variables in your Twitch chatbot to display channel name, viewers, followers, subscribers, and more.
3+
sidebar_label: "$(channel)"
4+
description: "Learn how to use channel-specific variables in your StreamElements chatbot to display channel information on Twitch streams."
45
tags:
5-
- chatbot
6-
- variable
7-
- twitch
8-
- twitch subscriber count
6+
- chatbot
7+
- variable
8+
- twitch
9+
- channel information
10+
keywords:
11+
- StreamElements chatbot
12+
- Twitch channel variables
13+
- stream viewer count
14+
- follower count
15+
- subscriber count
916
---
1017

11-
# $(channel)
18+
# Channel Variables
1219

13-
Displays the name of the channel
20+
## Overview
1421

15-
#### Parameters
22+
Channel variables allow you to display dynamic information about your Twitch channel in chat messages or overlays. These variables provide real-time data such as channel name, viewer count, follower count, and subscriber information.
1623

17-
This variable does not take any parameters.
24+
## Usage
1825

19-
#### Example Output
26+
To use a channel variable, simply include it in your chatbot command. The variable will be replaced with the corresponding value when the message is sent.
27+
28+
## Examples
29+
30+
Here are some examples of how to use channel variables:
2031

2132
```
22-
styler
33+
Welcome to $(channel)! We currently have $(channel.viewers) viewers.
2334
```
2435

25-
## $(channel.viewers)
26-
27-
Displays the channel’s current viewer count
36+
```
37+
Thanks for watching! $(channel.display_name) has $(channel.followers) followers and $(channel.subs) subscribers.
38+
```
2839

29-
#### Parameters
40+
## Available Variables
3041

31-
This variable does not take any parameters.
42+
### $(channel)
3243

33-
#### Example Input
44+
Displays the name of the channel.
3445

46+
**Example:**
3547
```
36-
$(channel) has $(channel.viewers) viewers
48+
Welcome to $(channel)!
3749
```
38-
39-
#### Example Output
40-
50+
**Output:**
4151
```
42-
onslaught has 100 viewers
52+
Welcome to styler!
4353
```
4454

45-
## $(channel.followers)
46-
47-
Displays the channel’s total follower count
55+
### $(channel.viewers)
4856

49-
#### Parameters
50-
51-
This variable does not take any parameters.
52-
53-
#### Example Input
57+
Displays the channel's current viewer count.
5458

59+
**Example:**
5560
```
56-
$(channel) has $(channel.followers) followers
61+
We have $(channel.viewers) viewers right now!
5762
```
58-
59-
#### Example Output
60-
63+
**Output:**
6164
```
62-
onslaught has 100 followers
65+
We have 100 viewers right now!
6366
```
6467

65-
## $(channel.subs)
68+
### $(channel.followers)
6669

67-
Displays the channels total subscriber count
70+
Displays the channel's total follower count.
6871

69-
#### Parameters
72+
**Example:**
73+
```
74+
Thanks to our $(channel.followers) followers!
75+
```
76+
**Output:**
77+
```
78+
Thanks to our 5000 followers!
79+
```
7080

71-
This variable does not take any parameters.
81+
### $(channel.subs)
7282

73-
#### Example Input
83+
Displays the channel's total subscriber count.
7484

85+
**Example:**
7586
```
76-
$(channel) has $(channel.subs) subscribers
87+
We've reached $(channel.subs) subscribers!
7788
```
78-
79-
#### Example Output
80-
89+
**Output:**
8190
```
82-
onslaught has 100 subscribers
91+
We've reached 500 subscribers!
8392
```
8493

85-
## $(channel.subpoints)
94+
### $(channel.subpoints)
8695

87-
Displays the channels total subscriber points
96+
Displays the channel's total subscriber points.
8897

89-
#### Parameters
98+
**Example:**
99+
```
100+
Current sub points: $(channel.subpoints)
101+
```
102+
**Output:**
103+
```
104+
Current sub points: 750
105+
```
90106

91-
This variable does not take any parameters.
107+
### $(channel.display_name)
92108

93-
#### Example Input
109+
Displays the display name of the channel, which may differ from the channel name in capitalization.
94110

111+
**Example:**
95112
```
96-
$(channel) has $(channel.subpoints) subscriber points
113+
Welcome to $(channel.display_name)'s stream!
97114
```
98-
99-
#### Example Output
100-
115+
**Output:**
101116
```
102-
onslaught has 100 subscriber points
117+
Welcome to OnSlAuGhT's stream!
103118
```
104119

105-
## $(channel.display_name)
106-
107-
Displays the display name of the channel
120+
## Related Variables
108121

109-
#### Parameters
122+
- [$(user)](user): Displays information about the user who triggered the command
123+
- [$(touser)](touser): Refers to the target user in commands that mention other users
110124

111-
This variable does not take any parameters.
125+
## FAQ
112126

113-
#### Example Input
127+
**Q: How often are these variables updated?**
114128

115-
```
116-
$(channel) $(channel.display_name)
117-
```
129+
A: Channel variables are updated in real-time, reflecting the most current information available from Twitch.
118130

119-
#### Example Output
120-
121-
```
122-
onslaught OnSlAuGhT
123-
```

docs/chatbot/variables/count.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
---
22
id: count
33
sidebar_label: "$(count)"
4-
description: "Learn how to use the $(count) variable in StreamElements Chatbot to display and manipulate command counters for your stream."
4+
description: "Learn how to use the $(count) variable in StreamElements Chatbot to create and manage custom counters for your stream."
5+
tags:
6+
- variables
7+
- counters
58
keywords:
69
- count
710
- counter
@@ -12,11 +15,12 @@ keywords:
1215
- variable
1316
---
1417

18+
1519
# $(count) Variable
1620

1721
## Overview
1822

19-
The `$(count)` variable is a powerful tool in the StreamElements Chatbot that allows you to display and manipulate counters for various purposes in your stream. It's commonly used for tracking deaths in games, counting command usage, or keeping score of any recurring event.
23+
The `$(count)` variable is a versatile tool in the StreamElements Chatbot that allows you to create, display, and manipulate custom counters for various purposes in your stream. It's commonly used for tracking deaths in games, counting command usage, or keeping score of any recurring event.
2024

2125
## Usage
2226

@@ -27,6 +31,7 @@ $(count [counter_name] [optional_modifier])
2731
```
2832

2933
Where:
34+
3035
- `[counter_name]` is an optional name for your counter (default is the command name)
3136
- `[optional_modifier]` can be used to set or modify the counter value
3237

@@ -56,11 +61,12 @@ Where:
5661

5762
## Configuration
5863

59-
Counters are automatically created when first used and persist across stream sessions. You can manage counters in the StreamElements dashboard under the "Botting" section.
64+
Counters are automatically created when first used and persist across stream sessions. You can manage counters in the StreamElements dashboard under the Chatbot section.
6065

6166
## FAQ
6267

6368
**Q: Can I have multiple counters?**
69+
6470
A: Yes, you can create multiple counters by using different names (e.g., `$(count deaths)`, `$(count wins)`).
6571

6672
**Q: How do I reset a counter?**

0 commit comments

Comments
 (0)