GRiMbot documentation

GRiMbOS desktop

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

GRiMbOS desktop

GRiMbOS is the administration interface for GRiMbot. It uses the GRiMbot HTTP API. The desktop contains GRiMbar, application windows, shortcuts, status icons, and a clock.

GRiMbar

Click GRiMbar at the lower left to open the start menu. The default Core categories are Stream, Community, Overlays, Media, Bot, and System. Installed plugins can add Games and Plugins folders.

Point to a category or submenu to open its flyout. Click a window name to open it. Clicking outside the menu closes the menu.

Right-click a window entry for these commands:

Command Result
Change Icon Opens the icon picker for that window.
Add to Desktop Adds a desktop shortcut. The command is unavailable when the shortcut already exists.

The System menu also contains the GRiMbot reboot command. Reboot closes open windows in sequence before it sends the reboot request.

Windows and taskbar

Each open window has a taskbar button. Click the button to restore or focus the window. Click the button for the active window to minimize it.

Title-bar control Result
Minimize Hides the window without closing it.
Maximize Fills the desktop area above the taskbar. Click it again to restore the normal size.
Close Closes the window.

Drag a normal window by its title bar. Resize it from any edge or corner. GRiMbOS keeps each window's last normal position and size in the browser.

Most windows are single-instance windows. Opening one again restores and focuses the existing window instead of opening a duplicate.

Desktop shortcuts

Double-click a shortcut to open its window. Drag a shortcut to move it on the desktop grid.

Right-click a shortcut for these commands:

  • Open
  • Change Icon
  • Remove from Desktop

Right-click an empty part of the desktop for:

  • Change Theme, which opens Theme.
  • Sort Desktop Icons by Name, which arranges shortcuts by window name.

Desktop shortcut choices and positions are stored in the current browser. They are not part of the server-side GRiMbar layout.

Taskbar status area

The right side of the taskbar can contain plugin icons, the Connection Status icon, and the clock. GRiMbOS shows a taskbar plugin icon only when that plugin registers at least one GRiMbOS window.

Click a plugin icon once to list its registered GRiMbOS windows. Double-click it to open a window whose identifier ends in settings, or whose title contains Settings. If neither exists, GRiMbOS opens the plugin's first registered window. A plugin does not have to register a GRiMbOS window or a settings window.

Click the networking icon to open Connection Status. Its tooltip reports how many current checks are connected. A warning appearance means at least one check failed or the status request was unavailable. The icon flashes while GRiMbOS records connection activity.

Customize the desktop

Task Path
Change palette, font, text size, or desktop image size System > Theme
Reorder Core menus and windows System > Organize GRiMbar
Install or uninstall standard plugins System > Add/Remove Plugins
Check Twitch authorization System > System Status
Check current external connections System > Connection Status

See Theme, Organize GRiMbar, and Add/Remove Plugins for full procedures.

Boundaries

Theme settings change GRiMbOS. They do not change overlay fonts or colors.

Games and Plugins menu layouts follow installed packages. Organize GRiMbar can change their folder icons, but it cannot move, rename, remove, or reorder their contents.

Closing a window does not save draft settings unless that window documents automatic saving. Use the window's SAVE, Save, or Apply Theme button when shown.