Chat Commands

Commands let your chat community interact with your stream, trigger visual and audio effects on your overlay canvas, or request information on demand. Scrapbot features an optimized commands engine with support for parameters, variables, and permission security rules.

1. Built-in Core Commands

Scrapbot comes pre-packaged with several native administrative and overlay commands. These are ready to use the moment you connect the bot:

CommandUsage & ParametersAction Details
!ping None Responds with basic bot uptime status and API ping latency.
!lowerthird [Title] | [Subtitle] Triggers the visual lower-third element. Supports custom templates with the @ prefix.
!alert [Headline] | [Details] Fires a custom popup notification alert card onto your live overlay.
!clear None Instantly wipes all active visual widgets, labels, or pending alert queues from the canvas.
!tts [Your message] Plays your text out loud through the web overlay audio system.

2. Creating Custom Commands

To build custom commands that post text replies or execute overlay actions:

  1. Navigate to the Scrapbot Commands tab in your dashboard.
  2. Click + New Command.
  3. Set the **Trigger Key** (e.g. discord or specs).
  4. Write your **Bot Response**. You can use rich variables like {user} or {viewers} (see the Variables Guide).
  5. Configure security and pacing:
    • Access Level: Restrict access using our Trust Scoring system (e.g., VIP Only).
    • Global Cooldown (s): Minimum time before *anyone* can re-trigger this command.
    • User Cooldown (s): Minimum time before the *same* user can re-trigger.

3. Creating Sound Effect (SFX) Commands

You can bind commands directly to audio files so that typing the command triggers sound clips locally inside your OBS browser source:

Inside the New Command dialog, toggle the **Sound Effect (SFX)** option. Upload an audio clip (supported types: .mp3 or .wav) using the asset uploader.

Now, when a viewer types your trigger command (e.g. !airhorn), the text is processed, and the audio waveform is immediately dispatched to your active browser sources, triggering synchronized playback on stream.