Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/content/docs/chatbot/commands/default/8ball.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ keywords:

import ChatExample from '@components/ChatExample.astro';

The `!8ball` command simulates a magic 8-ball toy, providing random responses to viewer questions. This interactive feature engages your audience and adds an element of unpredictability to your chat.
The `!8ball` command simulates a magic 8-ball toy: ask it a question and it answers with a random verdict.

## Usage

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/chatbot/commands/default/accountage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ keywords:

import ChatExample from '@components/ChatExample.astro';

The `!accountage` command allows users to check the creation date (age) of a Twitch account. This tool is particularly useful for moderators to verify user authenticity or determine eligibility for certain privileges based on account age.
The `!accountage` command shows how old a Twitch account is — a quick way for moderators to spot freshly created accounts.

## Usage

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/chatbot/commands/default/addpoints.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ keywords:

import ChatExample from '@components/ChatExample.astro';

The `!addpoints` command allows streamers and moderators to manually add points to a specific viewer's balance within the StreamElements loyalty system. This is useful for rewarding viewers for actions outside the standard point triggers, correcting point balances, or running special promotions.
The `!addpoints` command manually adds loyalty points to a viewer's balance — for one-off rewards or for correcting a balance.

## Usage

Expand Down
6 changes: 1 addition & 5 deletions src/content/docs/chatbot/filters/caps.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,4 @@ The Caps filter helps manage the use of capital letters in chat messages. It che
| Minimum characters | The minimum number of characters a message must have before the filter checks for a violation. If a message contains fewer characters than this limit, it will not be checked by the filter. |
| Maximum percent | The maximum percentage of a message that can be capital letters. If the percentage of capital letters in a message exceeds this limit, it will be flagged by the filter. |

The filter also supports the [settings shared by all filters](/chatbot/filters#settings-shared-by-all-filters), including the timeout length, custom timeout message, and excluded user level.

## What happens on a violation

The filter's timeout setting determines the action: a timeout for the configured number of seconds, message deletion only (timeout of 0), a permanent ban, or a warning plus deletion (Twitch only). See [What happens on a violation](/chatbot/filters#what-happens-on-a-violation) for details.
The filter also supports the [settings shared by all filters](/chatbot/filters#settings-shared-by-all-filters) — timeout length, custom timeout message, excluded user level — which also determine [what happens on a violation](/chatbot/filters#what-happens-on-a-violation).
6 changes: 1 addition & 5 deletions src/content/docs/chatbot/filters/emotes.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,4 @@ The Emote filter helps manage the use of emotes in chat messages. It checks the
|---------|-------------|
| Maximum amount | The maximum number of emotes allowed in a message. If a message contains more emotes than this limit, it will be flagged by the filter. |

The filter also supports the [settings shared by all filters](/chatbot/filters#settings-shared-by-all-filters), including the timeout length, custom timeout message, and excluded user level.

## What happens on a violation

The filter's timeout setting determines the action: a timeout for the configured number of seconds, message deletion only (timeout of 0), a permanent ban, or a warning plus deletion (Twitch only). See [What happens on a violation](/chatbot/filters#what-happens-on-a-violation) for details.
The filter also supports the [settings shared by all filters](/chatbot/filters#settings-shared-by-all-filters) — timeout length, custom timeout message, excluded user level — which also determine [what happens on a violation](/chatbot/filters#what-happens-on-a-violation).
2 changes: 1 addition & 1 deletion src/content/docs/chatbot/filters/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ keywords:

import { CardGrid, LinkCard, Steps } from '@astrojs/starlight/components';

Spam filters are essential tools for maintaining a clean and enjoyable chat environment during your streams. StreamElements Chatbot offers various types of filters to help you automatically moderate messages and protect your chat from unwanted content.
Spam filters automatically moderate chat messages so you don't have to catch everything yourself. Each filter targets one kind of unwanted message — caps, links, banned words, spam — and takes a configurable action when a message matches.

## Usage

Expand Down
6 changes: 1 addition & 5 deletions src/content/docs/chatbot/filters/language.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,4 @@ The Language filter moderates messages based on the language they are written in
| Minimum percentage | The minimum detection confidence. Messages whose language can't be identified with at least this confidence are flagged. |
| Excluded characters | Phrases stripped from a message before language detection runs (useful for emote names and channel-specific slang that confuse detection). |

The filter also supports the [settings shared by all filters](/chatbot/filters#settings-shared-by-all-filters), including the timeout length, custom timeout message, and excluded user level.

## What happens on a violation

The filter's timeout setting determines the action: a timeout for the configured number of seconds, message deletion only (timeout of 0), a permanent ban, or a warning plus deletion (Twitch only). See [What happens on a violation](/chatbot/filters#what-happens-on-a-violation) for details.
The filter also supports the [settings shared by all filters](/chatbot/filters#settings-shared-by-all-filters) — timeout length, custom timeout message, excluded user level — which also determine [what happens on a violation](/chatbot/filters#what-happens-on-a-violation).
6 changes: 1 addition & 5 deletions src/content/docs/chatbot/filters/links.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,6 @@ The Link filter helps manage the posting of links in chat messages. It checks if

Both lists support the `*` wildcard character for flexible rules, and patterns are matched case-insensitively.

The filter also supports the [settings shared by all filters](/chatbot/filters#settings-shared-by-all-filters), including the timeout length, custom timeout message, and excluded user level.

## What happens on a violation

The filter's timeout setting determines the action: a timeout for the configured number of seconds, message deletion only (timeout of 0), a permanent ban, or a warning plus deletion (Twitch only). See [What happens on a violation](/chatbot/filters#what-happens-on-a-violation) for details.
The filter also supports the [settings shared by all filters](/chatbot/filters#settings-shared-by-all-filters) — timeout length, custom timeout message, excluded user level — which also determine [what happens on a violation](/chatbot/filters#what-happens-on-a-violation).

Links matching the blocklist receive a harsher punishment: when the action is a timeout, the user is timed out for **double** the configured duration. With any other action (delete only, ban, or warning), the configured action applies as-is.
6 changes: 1 addition & 5 deletions src/content/docs/chatbot/filters/one-man-spam.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,4 @@ The One-Man Spam filter targets spam coming from a single user. Instead of judgi
| Lookback | How many seconds of the user's message history are inspected. |
| Threshold | The message similarity score (0–1, decimals allowed) that causes the user to be timed out. Messages at or above this similarity count as spam. |

The filter also supports the [settings shared by all filters](/chatbot/filters#settings-shared-by-all-filters), including the timeout length, custom timeout message, and excluded user level.

## What happens on a violation

The filter's timeout setting determines the action: a timeout for the configured number of seconds, message deletion only (timeout of 0), a permanent ban, or a warning plus deletion (Twitch only). See [What happens on a violation](/chatbot/filters#what-happens-on-a-violation) for details.
The filter also supports the [settings shared by all filters](/chatbot/filters#settings-shared-by-all-filters) — timeout length, custom timeout message, excluded user level — which also determine [what happens on a violation](/chatbot/filters#what-happens-on-a-violation).
6 changes: 1 addition & 5 deletions src/content/docs/chatbot/filters/paragraph.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,4 @@ The Paragraph filter helps manage the length of chat messages. It checks the num
|---------|-------------|
| Maximum amount | The maximum number of characters allowed in a message. If a message contains more characters than this limit, it will be flagged by the filter. |

The filter also supports the [settings shared by all filters](/chatbot/filters#settings-shared-by-all-filters), including the timeout length, custom timeout message, and excluded user level.

## What happens on a violation

The filter's timeout setting determines the action: a timeout for the configured number of seconds, message deletion only (timeout of 0), a permanent ban, or a warning plus deletion (Twitch only). See [What happens on a violation](/chatbot/filters#what-happens-on-a-violation) for details.
The filter also supports the [settings shared by all filters](/chatbot/filters#settings-shared-by-all-filters) — timeout length, custom timeout message, excluded user level — which also determine [what happens on a violation](/chatbot/filters#what-happens-on-a-violation).
6 changes: 1 addition & 5 deletions src/content/docs/chatbot/filters/repetition.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,4 @@ The Repetition filter limits how often the same word may be repeated within a si
| Maximum word repetitions | The maximum number of times a word can occur in a single message. |
| Minimum characters | Words shorter than this are ignored when counting repetitions. |

The filter also supports the [settings shared by all filters](/chatbot/filters#settings-shared-by-all-filters), including the timeout length, custom timeout message, and excluded user level.

## What happens on a violation

The filter's timeout setting determines the action: a timeout for the configured number of seconds, message deletion only (timeout of 0), a permanent ban, or a warning plus deletion (Twitch only). See [What happens on a violation](/chatbot/filters#what-happens-on-a-violation) for details.
The filter also supports the [settings shared by all filters](/chatbot/filters#settings-shared-by-all-filters) — timeout length, custom timeout message, excluded user level — which also determine [what happens on a violation](/chatbot/filters#what-happens-on-a-violation).
6 changes: 1 addition & 5 deletions src/content/docs/chatbot/filters/symbol.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,4 @@ The Symbol filter helps manage the use of symbols in chat messages. It checks th
| Minimum amount | The minimum number of symbols a message must have before the filter checks for a violation. If a message contains fewer symbols than this limit, it will not be checked by the filter. |
| Maximum percent | The maximum percentage of a message that can be symbols. If the percentage of symbols in a message exceeds this limit, it will be flagged by the filter. |

The filter also supports the [settings shared by all filters](/chatbot/filters#settings-shared-by-all-filters), including the timeout length, custom timeout message, and excluded user level.

## What happens on a violation

The filter's timeout setting determines the action: a timeout for the configured number of seconds, message deletion only (timeout of 0), a permanent ban, or a warning plus deletion (Twitch only). See [What happens on a violation](/chatbot/filters#what-happens-on-a-violation) for details.
The filter also supports the [settings shared by all filters](/chatbot/filters#settings-shared-by-all-filters) — timeout length, custom timeout message, excluded user level — which also determine [what happens on a violation](/chatbot/filters#what-happens-on-a-violation).
6 changes: 1 addition & 5 deletions src/content/docs/chatbot/filters/zalgo.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,4 @@ The Zalgo filter removes "zalgo" text — messages distorted with stacked combin
|---------|-------------|
| Maximum amount | The maximum number of zalgo (combining) characters allowed in a single message. |

The filter also supports the [settings shared by all filters](/chatbot/filters#settings-shared-by-all-filters), including the timeout length, custom timeout message, and excluded user level.

## What happens on a violation

The filter's timeout setting determines the action: a timeout for the configured number of seconds, message deletion only (timeout of 0), a permanent ban, or a warning plus deletion (Twitch only). See [What happens on a violation](/chatbot/filters#what-happens-on-a-violation) for details.
The filter also supports the [settings shared by all filters](/chatbot/filters#settings-shared-by-all-filters) — timeout length, custom timeout message, excluded user level — which also determine [what happens on a violation](/chatbot/filters#what-happens-on-a-violation).
2 changes: 1 addition & 1 deletion src/content/docs/chatbot/modules/chatalerts.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ keywords:
- Twitch community engagement
---

The Chat Alerts module is a powerful feature of the StreamElements chatbot that automatically posts messages in your chat when specific events occur. This helps streamers acknowledge viewer actions, enhance engagement, and keep the community informed about important stream events.
The Chat Alerts module automatically posts a chat message when something happens on your channel — a follow, a subscription, a raid, and so on — so events get acknowledged even when you're mid-game.

## Usage

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/chatbot/modules/emotecombo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ keywords:

import ChatExample from '@components/ChatExample.astro';

The Emote Combo feature is an interactive chat module that encourages viewers to create chains of consecutive emotes. It adds a fun, engaging element to your stream by challenging viewers to maintain and extend emote streaks.
The Emote Combo module tracks chains of consecutive messages containing the same emote, and announces the streak when someone finally breaks it.

## How It Works

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/chatbot/modules/emotepyramid.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ keywords:

import ChatExample from '@components/ChatExample.astro';

The Emote Pyramid is an engaging chat game that encourages viewer participation and creates a fun atmosphere in your stream. Players attempt to collaboratively build a pyramid of emotes in the chat, increasing the challenge and excitement as the pyramid grows.
The Emote Pyramid module is a chat game where viewers build a pyramid out of a single emote — one emote, then two, up to a peak and back down — and the bot announces whoever sends the message that completes it.

## How It Works

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/chatbot/modules/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ keywords:

import { CardGrid, LinkCard } from '@astrojs/starlight/components';

Chatbot modules are a set of powerful tools designed to enhance viewer interaction and engagement in your live stream. These modules provide a wide range of functionalities that can be customized to fit the unique needs of your stream and community.
Chatbot modules are optional features you can switch on per channel — chat games like roulette and bingo, automated chat alerts, raffles, and moderation helpers like votekick.

## Usage

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/chatbot/modules/roulette.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ keywords:
- point system for streams
---

The Roulette module is an interactive chat game that allows users to wager their points in a roulette-style gamble. It adds excitement and engagement to your stream by giving viewers a chance to win or lose points based on luck.
The Roulette module is a chat game where viewers wager loyalty points on a spin: win and you gain your wager, lose and it's gone.

## Usage

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/chatbot/modules/slotmachine.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ keywords:
- chat-based gambling simulator
---

The Slotmachine module is an interactive chat game that allows viewers to wager their points on a virtual slot machine. Players can win or lose points based on the outcome of the spin, adding an element of excitement to the stream chat.
The Slotmachine module is a chat game where viewers wager loyalty points on a spin of a virtual slot machine.

## Usage

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/chatbot/modules/votekick.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ keywords:
- temporary user removal
---

The Votekick module is a powerful chatbot feature that enables viewers to vote on whether to temporarily remove a user from the chat. If the vote passes, the user is timed out in chat for the configured duration.
The Votekick module lets viewers vote on whether to temporarily remove a user from the chat. If the vote passes, the user is timed out for the configured duration.

## Usage

Expand Down
18 changes: 1 addition & 17 deletions src/content/docs/chatbot/variables/ai.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ arguments: required

import ChatExample from '@components/ChatExample.astro';

The `$(ai)` variable allows you to integrate AI into your StreamElements chat commands, generating dynamic responses based on user input. This powerful feature can enhance viewer engagement and create unique interactive experiences in your stream.
The `$(ai)` variable allows you to integrate AI into your StreamElements chat commands, generating dynamic responses based on user input.

:::caution
The `$(ai)` variable is currently in beta and may be subject to changes.
Expand Down Expand Up @@ -108,22 +108,6 @@ When the limit is exceeded, the bot replies `rate limit exceeded`.
AI replies are sanitized before being sent to chat: leading `/` and `.` characters are stripped, and replies starting with `!` are prefixed with an invisible character — so an AI response can never trigger chat commands or other bot commands.
:::

## Best Practices

1. Provide clear context in your queries to get more relevant responses.
2. Use command cooldowns to prevent spam.
3. Combine the `$(ai)` variable with other StreamElements variables for more dynamic interactions.
4. Test your AI commands thoroughly before using them in live streams.

## Troubleshooting

If you're experiencing issues with the `$(ai)` variable, try the following:

1. Check your rate limit usage and wait for the reset if necessary.
2. Verify that your command syntax is correct.
3. Ensure that your StreamElements bot has the necessary permissions in your chat.
4. If problems persist, reach out to StreamElements support for further assistance.

## FAQ

**Q: Can I customize the AI's personality?**
Expand Down
11 changes: 0 additions & 11 deletions src/content/docs/chatbot/variables/channel.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -89,17 +89,6 @@ The standalone [`$(game)`](/chatbot/variables/game), [`$(title)`](/chatbot/varia
We've been live for 3 hours 27 mins with 1337 viewers and 850 active chatters!
```

## Best Practices

1. Use channel variables to provide real-time information about your stream in chat commands.
2. Combine multiple variables to create comprehensive stream status messages.
3. Always provide clear examples and explanations when creating custom commands using these variables.

## Troubleshooting

- If a variable returns unexpected results, ensure you're using the correct syntax.
- Remember that some variables may return specific values when the stream is offline or information is not available.

## Related Variables

- [$(user)](/chatbot/variables/user): Displays information about the user who triggered the command
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/chatbot/variables/count.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ arguments: optional

import ChatExample from '@components/ChatExample.astro';

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.
The `$(count)` variable creates, displays, and changes named counters. It's commonly used for tracking deaths in games, counting command usage, or keeping score of any recurring event.

## Use it

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/chatbot/variables/customapi.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ arguments: required

import ChatExample from '@components/ChatExample.astro';

The `$(customapi)` variable enables you to make HTTP requests to external APIs and display the responses directly in your stream's chat. This powerful feature allows you to integrate real-time data from various sources into your chat messages and commands.
The `$(customapi)` variable makes an HTTP request to an external API and displays the response directly in chat. Use it to pull real-time data — game stats, third-party services, or your own endpoints — into commands.

## Use it

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/chatbot/variables/game.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ arguments: optional

import ChatExample from '@components/ChatExample.astro';

The `$(game)` variable is a powerful tool that allows you to display the current game being played on a Twitch channel. This variable is particularly useful for creating dynamic commands or messages that reference the streamer's current activity.
The `$(game)` variable displays the game category a channel is currently playing.

:::note
`$(game)` is not available on YouTube — there, it renders as literal text instead of being replaced. On YouTube, use [`$(channel.game)`](/chatbot/variables/channel) instead, which works on every platform.
Expand Down
Loading
Loading