Recipes

Setup Examples

These examples describe common first overlays without exposing internal implementation details.

Show Chat Text On Stream

  1. Open Overlay Setup and create an overlay.
  2. Add a box and position it where chat text should appear.
  3. Add a Text source.
  4. Set the text to {{user.display}}: {{message.text}}.
  5. Add a chat-message trigger and leave Ignore commands enabled if commands should not appear.
  6. Save the overlay and open it in OBS as a browser source.

Play A Media Clip From A Command

  1. Create or select an overlay.
  2. Add a box sized for the media clip.
  3. Add a Media source using a file or URL.
  4. Use Timer mode so the clip hides after playback.
  5. Add a command trigger such as !hype.
  6. Save and test the command from chat.

Read A Message With TTS

  1. Enable a TTS model from TTS Setup.
  2. In Overlay Setup, add a TTS source.
  3. Select the first available voice or a cloned voice.
  4. Set Message to {{message.text}}. For Streamer.bot command triggers, this is the text supplied with the command.
  5. Bind the box to a command trigger such as !tts.

Pick A Random Source

  1. Add multiple sources to a box.
  2. Set the box source trigger mode to Random.
  3. Bind a trigger to the box.
  4. Each trigger will choose one source, avoiding the previous choice when possible.

Use Trigger Tokens

Any field with the trigger-token help marker supports autocomplete. Type {{ to open suggestions, keep typing to filter, then choose a token.

TokenUse
{{user.display}}Viewer display name.
{{message.text}}Chat message text, or the message text attached to a command trigger.
{{text}}Short alias for message text.
{{command.name}}Command name selected by Streamer.bot.
{{command.fullCommand}}Full command text, when Streamer.bot provides it.
{{command.counter}}Total command-use counter.
{{command.userCounter}}Command-use counter for the current viewer.
{{channel.platform}}Twitch, Kick, YouTube, or the platform supplied by the trigger.
{{custom["key"]}}A custom trigger value. Replace key with the custom variable name.

Autocomplete is the safest way to insert tokens because NekoBot stores the real token key while displaying a readable label chip.