GRiMbot documentation

Moderation

This is the hosted copy of the GRiMbot technical manual. Use the table of contents to open any page in the manual.

Moderation

Open Stream → Channel → Moderation. This is the default GRiMbar path. Organize GRiMbar can move the window.

Moderation looks up Twitch users and applies timeout, ban, VIP, and moderator actions.

Before you start

  • Authorize the bot account and broadcaster account in System Status.
  • The bot account must be a moderator in the channel for timeout, ban, and unban actions.
  • Timeout, ban, and unban need moderator:manage:banned_users on the chat identity.
  • VIP changes need channel:manage:vips on the broadcaster token.
  • Moderator changes need channel:manage:moderators on the broadcaster token.
  • Role display uses moderation:read plus the VIP and moderator scopes.

Add and select a user

  1. Click + Add user to choose someone from the recorded chatter roster.
  2. You can also type a Twitch login in Or type Twitch login… and click Look up.
  3. Click the user in the list to select them.
  4. Read the current role summary before applying an action.

The × button removes the person from this working list. It does not change anything on Twitch.

Apply an action

  1. Select a user.
  2. Choose an action.
  3. For Timeout, set the duration in seconds.
  4. Enter an optional Reason for Timeout or Ban.
  5. Click Apply.
  6. Wait for the success message and refreshed role summary.

Actions take effect on Twitch immediately. Closing the window does not undo them.

Actions and controls

Action or control What it does
Timeout Blocks Chat Messages from the user for the selected number of seconds. The default is 600 seconds.
Ban Blocks Chat Messages until an unban action succeeds.
Unban Removes the Twitch ban.
Add VIP Grants the Twitch VIP role.
Remove VIP Removes the Twitch VIP role.
Add mod Grants the Twitch moderator role.
Remove mod Removes the Twitch moderator role.
Reason (optional) Sends a reason with Timeout or Ban. Other actions ignore this field.
Apply Sends the selected action to Twitch.

Timeout duration must be 1 through 1,209,600 seconds, which is 14 days.

Check the result

  • A success message names the action and user.
  • The selected user's role summary refreshes after the action.
  • Twitch chat or the Twitch role list shows the change.
  • A timed-out or banned user can no longer send Chat Messages until the timeout ends or the ban is removed.

If something fails

  • Re-authorize the bot for timeout, ban, or unban permission errors.
  • Confirm that the bot is a channel moderator.
  • Re-authorize the broadcaster for VIP or moderator permission errors.
  • Search by the exact Twitch login if display-name lookup fails.
  • Refresh the user by selecting them again or looking them up again if the role summary is stale.
  • Twitch may reject conflicting role changes, such as a role the user already has or cannot hold.

Use care with Add mod. A moderator can perform Twitch moderation actions outside GRiMbOS.