GRiMbot documentation

Custom Lists

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

Custom Lists

Overlays → Browser & Chat → Custom Lists builds one or more overlay sets from saved channel leaderboards and recent activity.

Create and place a set

  1. Select an existing set or click New.
  2. Enter a name and click Create. A new set copies the default set's appearance but starts with no lists.
  3. On Lists, click Add list.
  4. Select a list type and click Add.
  5. Use Up and Down to set the stack order.
  6. Edit the title, row limit, title color, and row text template.
  7. Open Overlays → Browser & Chat → Overlay Browser and add the set by name to a layout.
  8. Confirm the live result in the preview and overlay.

Changes save automatically after about 450 milliseconds. Saved changes are also pushed to connected overlays.

Available lists

Custom Lists can show recent cheers, watch streaks, subscriptions, followers, bits, Chat Messages from the current Stream Session, the first chatter, Lurk Points by week or month, and hype train conductors or contributors.

The default set starts with Recent Cheer, Top Streakers, Last Subscribers, Top Cheers of all time, Biggest Cheer this Month, Top Chatters this Stream, First Chatter, and Top Lurkers this Week.

List controls

Control Default or limit
Title shown on overlay Starts with the catalog title.
How many rows to show Catalog default. Allowed range is 1 to 50.
Row text template Uses {rank}, {name}, and {value}. Some grouped results also support {count}.
Include value in template On.
Add list Each list type may appear once in a set.
Remove Removes the selected list from the set. It does not delete source records.

Appearance defaults and limits

Setting Default Range
Background mode Solid color Transparent or solid
Background opacity 1.0 0 to 1
Show panel border Off On or off
Border thickness 2 0 to 12
Corner roundness 0 0 to 48
Entry font size 20 10 to 64
Title font size 22 10 to 72
Outline thickness 0 0 to 12
Space between entries 2 0 to 48
Space under title 4 0 to 48
Space between sections 18 0 to 80
Inner panel padding 12 0 to 64
Cycle through lists Off On or off
Seconds per list 10 1 to 300
Transition Fade None, fade, or slide in four directions

When cycling is on, OBS shows one list at a time. The GRiMbOS preview still shows every list stacked.

Time periods and permissions

Weekly and monthly lists use Pacific calendar boundaries in the current source, not Bot Timezone. A week begins Monday. A month begins on its first day.

If a weekly or monthly Lurk Points period has no records, the list falls back to Lurk Points from the latest Stream Session. The displayed rows can therefore come from outside the named calendar period when that period is empty.

Hype train lists depend on Twitch hype train records. Re-authorize the broadcaster in System → System Status if those lists stay empty after a hype train.

Failure and deletion

  • An empty preview can mean that the selected list has no matching records.
  • A list for the current Stream Session stays empty while GRiMbot is offline or before matching activity occurs.
  • Deleting a set removes its Overlay Browser object from layouts.
  • GRiMbOS will not delete the last remaining set.
  • Custom List settings stay on disk until changed or deleted. The source defines no automatic expiry for a set.