Installation & Setup

Getting GherkinBot running is a simple 2-step process.

1. Extraction

Download the latest release .zip. Right-click the file and select Extract All.

2. Permissions

Right-click GherkinBot.exe and choose Run as Administrator. This is required for Global Hotkeys (Soundboard) to work while you are focused on your game.

Connecting Twitch

To control your stream, the bot needs an Access Token.

1. Launch the app.
2. Click the "Login Twitch" button in the bottom right of the Dashboard.
3. A browser window will open. Click Authorize.
4. The app will automatically detect the token. You will see "Online" status turn green.

Mission Control Dashboard

The home screen provides high-level control of your broadcast.

Quick Actions

Buttons to perform tasks without typing commands:

• Create Poll: Opens a dialog to draft a Twitch poll instantly.
• Start Raid: Type a username to send your viewers to another channel.
• Clip That: Instantly generates a clip of the last 30 seconds.
• Add Marker: Puts a timestamp in your VOD for later editing.

Protection Toggles

Safety switches you can flip on the fly:

• Block Links: Deletes any message containing a URL (VIPs/Mods exempt).
• Caps Filter: Timeouts users shouting in all caps.
• Emote Spam: Prevents walls of emote spam (Plus Feature).
• Auto Raid SO: Automatically posts a shoutout link when someone raids you (Plus Feature).

Stream Manager

Edit your stream metadata and monitor chat in a compact view.

Updating Info

Type your new Title, search for a Game Category (using the auto-complete dropdown), and add Tags. Click the green Update button to push changes live.

Ad Controls

The "Run 60s Ad" button manually triggers a commercial break to disable pre-rolls for incoming viewers.

Visual Alerts

Configure overlays for Follows, Subs, Bits, Raids, and Hype Trains using the new Armored Carbon style.

1. Connecting to OBS

Alerts run on their own dedicated layer.

1. In GherkinBot, go to the Alerts tab.
2. Click the "Copy OBS File Path" button in the top right.
3. In OBS, add a new Browser Source and name it "Gherkin Alerts".
4. Important: Leave "Local file" UNCHECKED. Paste the copied link into the URL field.
5. Set Width to 1920 and Height to 1080.

2. Variations

You can add multiple "Tiers" to an alert (e.g., a special alert for 1000+ bits). The bot will always pick the highest tier that matches the event amount.

Soundboard & Audio Engine

GherkinBot features a multi-track audio engine supporting .MP3, .WAV, and .OGG files.

Output Routing NEW

At the top of the Soundboard tab, you will find an Output Selector.

• Default: Plays through your Windows default device.
• Specific Device: Select a virtual cable (e.g., "CABLE Input" or "GoXLR Music") to route sound effects directly into your stream mix without hearing them yourself, or vice versa.

Panic Button SAFETY

Located in the Soundboard header, the red STOP ALL button immediately kills all currently playing audio. Use this if a sound effect gets stuck or you trigger the wrong clip.

Triggers

• Global Hotkeys: Click "Key: None" and press a key (F13-F24 recommended).
• Channel Points: Create a Twitch Reward with the exact same name as the slot (case sensitive).

Automation

Manage your Chat Bot and Timed Announcements.

Announcements (Hybrid Logic)

To prevent spamming empty chats, announcements use "Hybrid Logic." An announcement only fires if:

Widgets

Interactive browser sources for OBS.

1. Omni-Bar

A progress bar that fills up based on a point system.

• Point Logic: In settings, assign how many points a Follow, Sub, or 100 Bits is worth.
• Goal: Set a target (e.g., 1000 points). The bar fills dynamically as events happen.

2. Death Counter PREMIUM

Track your fails. Supports custom backgrounds and fonts.

• Triggering: Use the !death chat command or bind a global Keyboard Shortcut in the widget settings.
• Customization: Upload your own background image or choose a preset.

3. Chat Bubbles PREMIUM

Physics-simulated chat overlay.

• Text Only Mode: Check the "Text Only" box to remove the bubble background and leave just the floating text with a heavy outline.
• Settings Reference:
  • Lifetime: How long (seconds) bubbles stay on screen.
  • Max Bubbles: Limit how many can be on screen at once to prevent lag.
  • Layout: "Stacked" (physics pile) or "Single Line" (clean row).

Audience CRM

Manage your viewer relationships.

Mod Notes

Click on any username in the Live Chat or Subscriber List to open their profile. You can save private notes (e.g., "Big Tipper", "IRL Friend") that only you can see. These persist between streams.