Skip to content

Commit f53270d

Browse files
committed
Update chatalerts module with new event descriptions
1 parent 5ec76b9 commit f53270d

1 file changed

Lines changed: 28 additions & 3 deletions

File tree

docs/chatbot/modules/chatalerts.md

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,41 @@ tags:
77

88
# Chat Alerts
99

10-
The chatalerts module is a feature that allows the chatbot to post messages in the chat when certain events occur. These events can include, but are not limited to, receiving a tip, gaining a new follower, or being raided.
10+
The chatalerts module is a feature that allows the chatbot to post messages in the chat when certain events occur. These events can include, but are not limited to:
11+
12+
- Receiving a tip
13+
- Gaining a new follower
14+
- Being raided
15+
- Ad breaks
16+
- New subscribers
17+
- Cheers
18+
- Loyalty redemptions
19+
- Raids
20+
- Hypetrains
21+
- Polls
22+
- Charity events
1123

1224
**How the module works:**
1325

14-
1. The module is activated when a specified event occurs (e.g., receiving a tip, new follower, raid, etc.).
26+
1. The module is activated when a specified event occurs.
1527
2. Upon activation, the chatbot posts a predefined message in the chat to alert the streamer and the viewers of the event.
16-
3. The message can be customized to include specific details about the event, such as the name of the new follower or the amount of the tip.
28+
3. The message can be customized to include specific details about the event, such as the name of the new follower, the amount of the tip, or the details of the poll.
1729

1830
This module helps to acknowledge and appreciate the actions of the viewers, enhancing the interaction between the streamer and the viewers.
1931

32+
### Event Descriptions
33+
34+
- **Followers**: Alerts when a user follows the channel.
35+
- **Tips**: Alerts when a user tips the streamer.
36+
- **Ad Breaks**: Alerts when an ad break starts.
37+
- **Subscribers**: Alerts when a user subscribes to the channel.
38+
- **Cheers**: Alerts when a user sends bits to the channel.
39+
- **Loyalty Redemptions**: Alerts when a user redeems loyalty points through StreamElements.
40+
- **Raids**: Alerts when another streamer raids the channel.
41+
- **Hypetrains**: Alerts when a hypetrain event starts on the channel.
42+
- **Polls**: Alerts when a poll is started.
43+
- **Charity**: Alerts when a charity event is happening or a donation is made to a charity through the channel.
44+
2045
### Commands
2146

2247
- None

0 commit comments

Comments
 (0)