GRiMbot documentation

Basic functions

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

Basic functions

Basic functions are GRiMbOS windows that ship with Core. They do not require a plugin.

Open a window

  1. Click GRiMbar on the taskbar.
  2. Point to a category. Point to a submenu when one appears.
  3. Click the window name.

The default paths are listed below. Organize GRiMbar can move Core windows, so a customized installation may use different paths.

Window Default GRiMbar path What it does
Live Dashboard Stream > Live & Stats > Live Dashboard Shows the current Stream Session and recent activity.
Stream Setup Bot > Setup > Stream Setup Changes Twitch title, category, content classification, and tags.
Community Community > Audience > Community Shows people GRiMbot has recorded.
Core Commands System > Core Commands Shows built-in commands and their permissions.
Overlay Browser Overlays > Browser & Chat > Overlay Browser Provides overlay addresses and layout controls.
Chat Overlay Overlays > Browser & Chat > Chat Overlay Sets the appearance and filters for chat overlays.
Media Library Media > Library > Media Library Manages uploaded media.
System Status System > System Status Checks Twitch account authorization and can re-register EventSub subscriptions.
Connection Status System > Connection Status Checks live connections to Twitch, overlays, integrations, and plugins.
Theme System > Theme Sets the GRiMbOS palette, font, text size, and desktop image size.
Add/Remove Plugins System > Add/Remove Plugins Installs and uninstalls standard plugin zip packages.
Organize GRiMbar System > Organize GRiMbar Changes Core window placement and menu order.

Common window controls

Control Result
Minimize Hides the window but leaves its taskbar button open.
Maximize Expands the window to the desktop area above the taskbar.
Close Closes the window. The next open uses the last saved normal position and size.
Taskbar window button Restores a minimized window, focuses an inactive window, or minimizes the active window.

Drag a title bar to move a normal window. Drag an edge or corner to resize it. Maximized windows cannot be moved or resized.

Desktop shortcuts

Right-click a GRiMbar window entry and click Add to Desktop. Double-click the desktop shortcut to open it. Right-click a shortcut to open it, change its icon, or remove it from the desktop.

Drag desktop shortcuts to new grid positions. If a shortcut is dropped on an occupied position, the two shortcuts exchange positions.

Save behavior

Save behavior belongs to each window.

  • A window with SAVE, Save, or Apply Theme does not apply draft changes until that button is clicked.
  • Organize GRiMbar saves changes automatically.
  • Closing a settings window does not imply that unsaved settings were stored.
  • Window position, window size, desktop shortcuts, and Theme preferences are retained by the browser.

Status and help

Use Connection Status when a service, overlay, or integration is not connected. Use System Status for Twitch account authorization, missing permissions, or re-registering EventSub subscriptions.

Open System > Help for the Help App. Automation that uses action chains is covered in Advanced features. Chat Games are covered in Chat Games.