Overview
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.
Banned Words Filter
The Banned Words filter is a tool that helps maintain the chat environment by removing messages that contain banned phrases and patterns. This filter is highly customizable and supports the creation of multiple groups, each with its own set of banned phrases.
These phrases can be simple text or they can be regular expressions (regexp), providing a high degree of flexibility in defining what constitutes a banned phrase. For example, you could ban a specific word, or use a regular expression to ban any word that contains a certain sequence of characters.
To use this filter, simply define your groups and their associated banned phrases or patterns. Any incoming message that matches a banned phrase or pattern in any group will be automatically removed.
To create a group, click the Add Group button. This will create a new group with the default name Group 1.
Example
Caps
The Caps filter helps manage the use of capital letters in chat messages. It checks the number and percentage of capital letters in a message and compares them with the set limits. If a message violates these limits, the filter takes action according to the configured settings.
Supported Settings
-
Timeout duration
: This is the duration (in seconds) for which a user will be timed out if their message violates the capital letters limits. -
Excluded user groups
: These are the user groups that are exempt from the caps filter. Messages from users in these groups will not be checked by the filter. -
Custom timeout message
: This is the message that will be displayed when a user is timed out due to a violation of the capital letters limits. This message can be customized to provide specific information about the violation and the timeout. -
Maximum amount
: This is the maximum number of capital letters allowed in a message. If a message contains more capital letters than this limit, it will be flagged by the filter. -
Minimum characters
: This is 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
: This is 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.
Emotes
The Emote filter helps manage the use of emotes in chat messages. It checks the number of emotes in a message and compares them with the set limit. If a message violates this limit, the filter takes action according to the configured settings.
Supported Settings
-
Timeout duration
: This is the duration (in seconds) for which a user will be timed out if their message violates the emote limit. -
Excluded user groups
: These are the user groups that are exempt from the emote filter. Messages from users in these groups will not be checked by the filter. -
Custom timeout message
: This is the message that will be displayed when a user is timed out due to a violation of the emote limit. This message can be customized to provide specific information about the violation and the timeout. -
Maximum amount
: This is 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.
Links
The Link filter helps manage the posting of links in chat messages. It checks if a message contains any links and compares them with the set allowlist and blocklist. If a message contains a link that is not in the allowlist or is in the blocklist, the filter takes action according to the configured settings.
Supported Settings
-
Timeout duration
: This is the duration (in seconds) for which a user will be timed out if their message violates the link rules. -
Excluded user groups
: These are the user groups that are exempt from the link filter. Messages from users in these groups will not be checked by the filter. -
Custom timeout message
: This is the message that will be displayed when a user is timed out due to a violation of the link rules. This message can be customized to provide specific information about the violation and the timeout. -
Allowlist
: This is a list of links or link patterns that are allowed in messages. The filter supports wildcard characters in this list, allowing for flexible rules. -
Blocklist
: This is a list of links or link patterns that are not allowed in messages. Any link that matches a pattern in this list is treated as harmful and will result in a harsher punishment for the user.
Paragraph
The Paragraph filter helps manage the length of chat messages. It checks the number of characters in a message and compares them with the set limit. If a message violates this limit, the filter takes action according to the configured settings.
Supported Settings
-
Maximum amount
: This is 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. -
Timeout duration
: This is the duration (in seconds) for which a user will be timed out if their message violates the character limit. -
Excluded user groups
: These are the user groups that are exempt from the paragraph filter. Messages from users in these groups will not be checked by the filter. -
Custom timeout message
: This is the message that will be displayed when a user is timed out due to a violation of the character limit. This message can be customized to provide specific information about the violation and the timeout.
Symbol
The Symbol filter helps manage the use of symbols in chat messages. It checks the number and percentage of symbols in a message and compares them with the set limits. If a message violates these limits, the filter takes action according to the configured settings.
Supported Settings
-
Maximum amount
: This is the maximum number of symbols allowed in a message. If a message contains more symbols than this limit, it will be flagged by the filter. -
Minimum amount
: This is 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
: This is 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. -
Timeout duration
: This is the duration (in seconds) for which a user will be timed out if their message violates the symbol limits. -
Excluded user groups
: These are the user groups that are exempt from the symbol filter. Messages from users in these groups will not be checked by the filter. -
Custom timeout message
: This is the message that will be displayed when a user is timed out due to a violation of the symbol limits. This message can be customized to provide specific information about the violation and the timeout.