GRiMbot documentation

Walk-Ons

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

Walk-Ons

Community → Arrivals → Walk-Ons plays assigned Media Library clips when a chosen viewer arrives during a live Stream Session.

Each Walk-On can run at most once per Stream Session. A successful automatic or command play uses the same once-per-session record.

Before you begin

  • Add and enable the clips in Media → Library → Media Library.
  • Add a Walk-On object to an active layout in Overlays → Browser & Chat → Overlay Browser.
  • Confirm that GRiMbot has detected the live Stream Session.

Add a Walk-On

  1. Click Add walk-on.
  2. Search for the viewer and add them.
  3. Click Clips.
  4. Select one or more enabled Media Library clips.
  5. Choose how multiple clips play.
  6. Save the clip selection.
  7. Click Test and watch the overlay.

A new Walk-On is enabled, uses Auto on first message, and starts with no clips. Its multiple-clip mode starts as Play in order.

Settings and controls

Control What it does
Command Gives the viewer a personal chat command, such as !myintro. The value saves when the field loses focus or you press Enter.
Custom text Supplies {custom_text} to the Walk-On card. The value saves when the field loses focus or you press Enter.
Auto on first message Tries the Walk-On on that viewer's first non-command Chat Message during a live Stream Session.
Clips Selects enabled Media Library clips and their play mode.
Test Queues the Walk-On on the overlay without waiting for chat.
Remove Deletes the Walk-On after confirmation. This cannot be undone.

Multiple-clip modes are Play in order, Play all at once, and Random one. The clip picker is authoritative for the clips assigned to that viewer.

Automatic eligibility

An automatic Walk-On runs only when all of these conditions are true:

  • Twitch identifies the chatter as the configured viewer.
  • GRiMbot is live and has a current Stream Session.
  • The Chat Message does not start with !.
  • The Walk-On is enabled.
  • Auto on first message is checked.
  • The Walk-On has not already played during this Stream Session.
  • The overlay can queue at least one assigned clip.

If playback does not start, GRiMbot does not mark the Walk-On as played. A later eligible attempt can try again.

Personal commands

GRiMbot compares the first word of a command Chat Message with saved Walk-On commands. Only the assigned viewer may use that command. If another viewer uses it, GRiMbot replies:

Only {user} can use that command.

The command does nothing while offline. It also does nothing after that Walk-On has played during the current Stream Session.

A command can play the Walk-On before the viewer sends a non-command Chat Message. That successful command play uses the once-per-Stream-Session record, so the later automatic check does not play it again.

Verify and troubleshoot

  • Use Test first. If nothing appears, check that the Walk-On object is on the active layout.
  • If Test fails, confirm that at least one assigned clip is still enabled in Media Library.
  • If automatic playback fails, check that Auto on first message is on and that GRiMbot shows a live Stream Session.
  • If a command fails, confirm that it is unique and that the assigned viewer typed it.
  • Deleting a Walk-On removes its definition, clip assignments, and completed per-session play records through database cascade deletion.

Card wording and appearance are set in Overlays → Stage & Cards → Walk-On & Clip Overlay.