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.
• Auto Raid SO: Automatically posts a shoutout link when someone raids you.

Stream Manager

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

Updating Info

Type your new Title, search for a Game Category, and add Tags (comma separated). Click the green Update button to push changes live to Twitch immediately.

Ad Controls

The "Run 60s Ad" button manually triggers a commercial break. Useful for timing ads during loading screens to disable pre-rolls for incoming viewers.

Visual Alerts

Configure overlays for Follows, Subs, Bits, Raids, and Hype Trains.

1. Connecting to OBS

Alerts run on their own dedicated layer. Setting this up handles Alerts AND Soundboard visuals.

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. Crucial Step: Check the box that says "Local file".
5. Paste the copied path into the Local file text field.
6. Set Width to 1920 and Height to 1080.
7. Make sure this source is at the top of your list so it covers the game!

2. Creating an Alert

1. Select an event type on the left (e.g., "Bits / Cheer").
2. Click + Add New Tier to create a variation (e.g., "100+ Bits").
3. Upload your Image/Video and Sound File.
4. Adjust Volume and Text layout.
5. Click Test This Alert. If the OBS source is active, you will see it pop up!

Soundboard

The soundboard works in two ways: via Hotkeys (for you) or Channel Points (for viewers).

Method 1: Global Hotkeys

Click the "Key: None" button on a slot and press any key (F13-F24 are recommended if you use a Stream Deck) to bind it.

To clear a slot, click the Trash Icon next to the slot name.

Method 2: Channel Points

To let viewers trigger sounds:

1. Create a reward in your Twitch Dashboard (e.g., "Airhorn").
2. In GherkinBot, name the sound slot exactly "Airhorn" (case sensitive).
3. When a viewer redeems it, the sound will play automatically.

Automation

Manage your Chat Bot and Timed Announcements.

Chat Commands

Create triggers like !discord or !lurk. You can restrict these to Mods or Subscribers only.

Announcements (Hybrid Logic)

Announcements use a "Hybrid" system to prevent spamming empty chats. An announcement only fires if:

Widgets

Add interactive overlays to OBS.

1. Omni-Bar

A hybrid interaction bar that fills up dynamically with every Follow, Sub, Bit, or Channel Point redeem. To install, click the card and use the Copy Browser Source button.

2. Death Counter PREMIUM

Track your in-game fails with style. Supports custom backgrounds, fonts, and hotkeys.

• Installation: Go to Widgets > Death Counter. Click Copy Source URL. Add a new Browser Source in OBS, check Local file, and paste the link. Recommended size: 400x150.
• Triggers: Increment the count via the !death chat command (Mods/Streamer only) or assign a global Hotkey in the settings.
• Customization: Choose from preset backgrounds, upload your own image, or change the font style (Horror, Comic, Sci-Fi).

Audience & CRM

Track your community growth and manage viewer relationships.

Subscriber List

Shows a live table of all active subscribers, their tier, and their subscription date. Click Refresh List to sync with the Twitch API.

User Profiles (CRM)

Click on any username in the Live Chat or Subscriber List to open their profile card.

• Player Stats: View account creation date and follow date.
• Mod Notes: Save private notes about specific viewers (e.g., "Big tipper", "Real name is Dave"). These notes are saved locally.
• Chat History: View the last 5 messages sent by that user to catch context.