DOCSEARCHbyAlgolia
Submit Docs

ModBoty Documentation

website·Indexed 29 days ago

https://relanit.github.io/modboty-docs/

Documentation for ModBoty, a Twitch moderation bot. Includes guides on antiflood protection, banwords, massbanning, global bans, and managing VIPs, trusted users, and bot editors. Covers command creation, timers, polls, predictions, and stream information management, as well as installation and authorization processes.

Tokens
7.7K
Snippets
112
Records
125
Agent score
72%

What's inside ModBoty

  3. Global Ban system overview and constraints

    The Global Ban system (gb) blocks users across all channels where the feature is enabled. It has a general cooldown of 1 second. There is no global unban command because bans are reserved for the most serious violations and are manually verified by a group of moderators. Bot editors can grant trusted users the permission to submit global ban requests.

  4. Prevent chat flooding with the Antiflood module

    The Antiflood module in ModBoty is designed to keep chats readable by automatically muting users based on specific flood patterns. Key capabilities include:

    • Muting messages containing repeating phrases, excessive capitalization (caps), or too many emojis.
    • Calculating mutes based on the actual visual size of messages, including the size of emojis.
    • Tracking message history over several seconds to detect rapid-fire spam.
    • Automatically removing long links.

  5. Manage bot editors and their permissions

    Bot editors are users who can manage VIPs and assign trusted users. Note that editors cannot execute commands without moderator privileges. The general cooldown for editor-related commands is 3 seconds.

  6. Configure which commands trusted users can execute

    You can specify which commands are available to trusted users. When adding a command, all of its associated aliases are automatically added as well (e.g., adding !poll also adds !delpoll).
    !trustcmd add <command>  # Allow trusted users to use this command
!trustcmd del <command>  # Prevent trusted users from using this command
!trustcmds               # View the list of commands available to trusted users

  7. Manage group mutewords

    Mutewords can be organized into groups. If a user repeatedly sends phrases from the same group, the timeout duration increases automatically (from 10 minutes up to 2 weeks). This feature is currently in beta for a limited number of channels.
    # Manage groups (add or delete)
!mgroup <add|del> <group_name>

# Add or remove a phrase from a group
!mgword <group_name> <add|del> <phrase>

# View all group mutewords
!mgwords

# Automatically create multiple mutewords for a game in a group
!mgame <category_name> add <game_name>

  8. Use regular expressions for banwords

    You can define banwords using regular expressions by prefixing the phrase with r'...'. This allows for complex pattern matching, such as ignoring specific prefixes or matching multiple variations of a word.
    # Example: Mute for 600s using a regex
!mword 600 r'regular expression'

  9. Add ModBoty bot to your stream

    To add ModBoty, you must meet the following eligibility requirements: have several thousand followers and stream at least 1-2 times per week. If you meet these criteria, grant the bot moderator permissions by typing /mod modboty in your chat and then send your nickname to the developer via Telegram.
    /mod modboty

  12. Configure automatic category switching via Steam

    ModBoty can automatically change your stream category based on the game you are playing in Steam. Note: This feature is currently in beta for a limited number of channels and may become a paid feature. It will not work if your Steam profile is set to 'Invisible'.
    # Step 1: Set the streamer's Steam ID (e.g., 76561198995571697)
!steamid <steam_id>

# Step 2: Enable or disable automatic category switching
!autog on
!autog off