GRiMbot documentation

Overlay Browser

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

Overlay Browser

Open Overlays > Browser & Chat > Overlay Browser to create the overlay pages used by OBS.

flowchart TB
    A[Overlay Browser] --> B[Up to 25 surfaces]
    B --> C[Layout: up to 15 objects]
    C --> D[Up to 8 embed iframes]
    D --> E[Copy URL]
    E --> F[OBS Browser Source]

Limits

Item	Limit
Overlays	25
Objects on one overlay	15
Live widget iframes on one overlay	8

Live widget iframes include chat, Bot Overlay, Custom Counters, Custom Lists, and plugin widgets. The iframe limit controls OBS memory use.

Create an overlay

Click New overlay.
Enter a Name.
Select 1920 by 1080, 1080 by 1920, 1280 by 720, or Custom.
For a custom canvas, enter a width from 320 to 7680 and a height from 240 to 4320.
Click Create.
Click Layout for the new row.
Use Add Object to assign objects, then place and size them in canvas pixels.
Save the layout.
Click Copy URL.

Follow Overlays in OBS to add the copied address as an OBS Browser Source.

Object catalog

Group	Core objects
Media	Standard Video, Fullscreen Video, GIFs, Sounds
Stage	Walk-On, Shoutout, Twitch Clip, Event Alerts, Bot Overlay
Chat	Vertical Chat Box, Horizontal Ticker
Other	Custom Counters, Custom Lists, and installed plugin objects

A Media Library clip must target an object assigned to the layout. Sounds is audio only. Hidden layout objects remain assigned but do not draw.

The settings for chat, Bot Overlay, Event Alerts, and stage cards live in their own windows. See Chat Overlay, Bot Overlay, Event Alerts, and Walk-On & Clip Overlay.

Browser URL controls

Copy URL copies the current GRiMbOS origin plus the saved overlay path. The URL stays tied to that overlay. Renaming or changing its layout does not require a new source address.

Clone copies the canvas and object layout into a new overlay with a new name and URL. Cloning is blocked when 25 overlays already exist.

Delete removes the overlay from GRiMbOS. Existing OBS Browser Sources are not removed. Replace or delete those sources yourself.

Verify a layout

The canvas matches the OBS Browser Source width and height.
Every required object is assigned and visible.
Media clips target an assigned media object.
No overlay exceeds 15 objects or 8 live widget iframes.
OBS has refreshed the page after a URL or layout change.

If creation, cloning, deletion, or copying fails, GRiMbOS shows an error. Reload the list before repeating the operation. If an object does not appear in OBS, refresh the Browser Source cache and check System > Connection Status.