Grim Games Live Grim Games Live

GRiMbot documentation

Core Commands

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

GRiMbot product page Manual home

Core Commands

Open System → Core Commands. This is the default GRiMbar path. Organize GRiMbar can move the window.

Core Commands lists the built-in chat commands that are present in the running GRiMbot version. Command names and descriptions are fixed. You can change who may run each command.

Before you start

  • Connect GRiMbot to Twitch chat.
  • Authorize the bot account and broadcaster account in System Status.
  • Create any custom Groups before assigning them.
  • Create a Custom Counter before using a Core Command that changes that counter.

Plugin commands do not appear here. Set those in the plugin's own Commands window.

Current Core Commands

This list comes from shared/planning/core_commands.py.

Command Alias Default audience Current behavior and settings
!ping None anyone Replies with pong. Use it to check whether chat commands work.
!commands !command anyone Lists the Core Commands the person is allowed to use.
!vipcommands !vipcommand anyone Lists commands whose permissions include the VIP role.
!uptime None anyone Shows how long the current stream has been live.
!lurk None anyone Marks the person as lurking for the current Stream Session and shows their lurk eligibility and Lurk Points.
!lurkers None anyone Lists viewers currently lurking. !lurkers all lists everyone who earned Lurk Points during the current Stream Session.
!lurkstatus None anyone Shows the current Stream Session's lurk progress, including blocks earned, buds, and current block status.
!lurkleaders None anyone Lists the top five people by total minutes lurked across all streams.
!pin <message> None mods Pins the supplied message in Twitch chat until !unpin. The bot needs chat pin permission.
!unpin None mods Removes the current Twitch chat pin.
!so <login> !shout mods Sends a Twitch shoutout for the login. It also plays a clip on the OBS overlay when that option is enabled.
!to <username> [seconds] !timeout mods Times out the user. The optional duration defaults to 5 seconds and has a maximum of 1,209,600 seconds.
!vip <username> None mods Adds the user as a channel VIP. It uses the broadcaster token and needs channel:manage:vips.
!mods None anyone Lists channel moderators from Twitch. It uses the broadcaster token and needs moderation:read.
!vips None anyone Lists channel VIPs from Twitch. It uses the broadcaster token and needs channel:manage:vips.
!addone <counter> None mods Adds 1 to a Custom Counter. The counter matches by ID or name. Singular and plural forms match.
!add <amount> <counter> None mods Adds the supplied amount to a Custom Counter. For example, !add 5 death adds 5 to Deaths. The counter matches by ID or name, including singular and plural forms.
!total <counter> None anyone Posts the current Custom Counter value. The counter matches by ID or name, including singular and plural forms.
!resetcounter <counter> None mods Restores a Custom Counter to its reset value. The default reset value is 0. The counter matches by ID or name, including singular and plural forms.
!convert <number><unit> None anyone Converts C and F, m and ft, km and mi, g and oz, and kg and lb. Knots, written as kt, convert to mph and km/h. Examples include !convert 75c, !convert 1000m, !convert 70kg, and !convert 10kt.

Change permissions

  1. Find the command in the table.
  2. Read its fixed description.
  3. Click Permissions.
  4. Choose everyone, a Twitch role, a custom Group, or named people.
  5. Apply the permission change.

The permission change saves immediately. Save all also sends the current full command table to GRiMbot. It is not required after an individual permission change.

Controls

Control What it does
Command Shows the fixed command text and any required arguments.
Description Shows the fixed behavior recorded in the current source.
Permissions Opens the permission editor for that command.
Permission summary Shows the roles, Groups, or named people that may run the command.
Column headings Sort the loaded command list.
Save all Saves the current full table and reloads it.

Check the result

  1. Send the command from a Twitch account that has permission.
  2. Confirm that GRiMbot performs the behavior shown in the description.
  3. Send it from an account without permission.
  4. Confirm that the restricted account cannot run it.
  5. Reopen Core Commands and check that the permission summary remains correct.

Permissions and Twitch scopes

Permissions in this window decide who may issue a command. Twitch scopes decide whether GRiMbot can complete the Twitch action.

Examples include moderator:manage:banned_users for timeouts, moderator:manage:chat_messages for chat pins, moderator:manage:shoutouts for shoutouts, channel:manage:vips for VIP changes, channel:manage:moderators for moderator lists or changes, and moderation:read for moderation lists.

If something fails

  • If a listed command is missing from the window, check the running GRiMbot version and reload the page.
  • If every command fails, check the Twitch chat connection in Connection Status.
  • If one Twitch action fails, re-authorize the required account in System → System Status.
  • If a Group or named person does not work, reopen Permissions and check the saved summary.
  • If a counter command cannot find a counter, open Overlays → Browser & Chat → Custom Counters and check its name or ID.

Core Commands cannot be renamed. Their descriptions cannot be edited. This window does not configure plugin commands or Custom Commands.