Video walkthroughs are coming - subscribe on YouTube to catch them. Any tab not covered here has inline help inside StreamLinkr. Join the Discord for support and updates.

Before You Begin

StreamLinkr needs a few core pieces before the chatbot is considered ready.

A valid license key.
At least one configured platform: Twitch, Kick, or YouTube.
One active AI provider.
A bot identity and base persona.

Downloads

Streamer.bot & Speaker.bot

streamer.bot/downloads

Ollama (Windows)

ollama.com/download/windows

StreamLinkr Installer

streamlinkr.tv/download/

Streamer.bot Setup

Download from streamer.bot/downloads, extract the archive, and run Streamer.bot.exe.
In the left panel open Platforms → Twitch and sign in both the bot account and the streamer account.
Open Servers/Clients → WebSocket Server.
Enable Auto Start. If the status shows Running, click Stop Server first.
Enable and open Authentication, then set a password.
Click Start Server and confirm the status is Running.
Enable Auto Start so the WebSocket server starts automatically on launch.
Write down Address (Host), Port, Endpoint, and Password - you'll enter these in Step 4.

A bot account lets Streamer.bot interact with Twitch on your behalf. It can be your main account, but a separate account is recommended for security.

Why authentication is required: StreamLinkr needs this password to send and receive data over the Streamer.bot WebSocket connection.

Do not enable Enforce unless you want all WebSocket clients to require authentication. Enabling it can break other integrations that expect open local access.

Install StreamLinkr

Download the latest StreamLinkr installer from the Downloads page.
Run the installer, click Next, then choose your install directory.
Click Next, wait for installation to finish, then launch from the desktop shortcut.

Platform Connections

Configure one platform or several. StreamLinkr keeps platform settings separate so command permissions and credentials can be managed independently.

Open System → Connections → Platforms in StreamLinkr.
Enable the platforms you use: Twitch, Kick, and/or YouTube.
For each enabled platform set Bot name, Streamer name, and Name match threshold.
Click Save changes in the top bar and verify the platform status indicators.
If you use multiple platforms, review Community → Moderation → Permissions so each command is available to the right roles on each service.

Good to know: Some features are platform-specific by nature. StreamLinkr keeps those distinctions explicit rather than pretending every platform exposes the same events.

Configure StreamLinkr

Open System → Connections → Runtime and fill in Host, Port, Endpoint, and Password from Step 1.
In that same panel expand Streamer.bot action group import, click Copy import data, then follow the Action Group Import section below and return here.
Open AI → AI Provider → Provider, choose your provider, then open AI → AI Provider → Setup and complete the matching provider section below.
Open System → License, enter your license key, and click Test key to confirm it is valid. Don't have one? Sign in on the Dashboard and start a free 7-day trial, or buy a lifetime key on Ko-Fi.
Open AI → Bot Behavior → Identity, set the bot name, and choose a personality preset or write a custom personality.
Click Save changes in the top bar.

Action Group Import

Complete this after clicking Copy import data from StreamLinkr (Step 4.2), then return to Step 4.3.

Switch to Streamer.bot.
Click Import at the top of the app.
Paste the import data you copied from StreamLinkr.
Click Import to add the StreamLinkr action group.
Return to StreamLinkr and continue at Step 4.3.

What gets imported

FetchTwitchProfile

Retrieves Twitch profile data (bio, last stream, game, tags) for a given user. Used by shoutouts, !roast, !compliment, and sub/gifted sub events.

TTSBotReplyOptional

Triggers Speaker.bot TTS playback from StreamLinkr. Used by !comment, !tts, and ban/unban/timeout/untimeout announcements. Disable if you are not using Speaker.bot.

StopBotOnStreamEndOptional

C# script that stops StreamLinkr when your stream ends. To also auto-start on go-live, edit the action and change "action" to "start" in the C# script. Use if Auto-Detection isn't working.

AI Provider Setup

Choose your provider - only one is needed.

Go to AI → AI Provider → Provider and select OpenAI.
Open AI → AI Provider → Setup and enter your OpenAI API key.
Click Refresh models and choose your model.
Open AI → AI Provider → Tuning to adjust generation parameters.
Return to Step 4.4 (License).

Speaker.bot Setup

Optional

Only needed for voice output or TTS playback.

5.1 - Enable Speaker.bot HTTP Server

In Speaker.bot, go to Settings → HTTP Server.
Enable the HTTP server and note the port (default: 7580).

5.2 - Connect Streamer.bot to Speaker.bot

In Streamer.bot, open Integrations → Speaker.bot.
Set Host to localhost if both apps are on the same PC, or the LAN IP if Speaker.bot is on a different machine.
Set Port to Speaker.bot's HTTP port (default: 7580).
Click Connect and confirm the status shows Connected.

5.3 - Create TTS Action in Streamer.bot

Create a new Streamer.bot action named TTSBotReply (or match your configured name).
Add sub-action: Speaker.bot → Speak.
Set the Speaker.bot instance from the dropdown.
Set Voice Alias (example: deadpool, jarvis, or your custom alias).
Set the message field to %text% so StreamLinkr responses are spoken.
Leave Ignore unchecked. Configure the Bad Word Filter as desired.

5.4 - Configure TTS in StreamLinkr

Open System → Add-ons → TTS in StreamLinkr.
Enable TTS globally and set the Action name to match the Streamer.bot action (default: TTSBotReply).
Set the Voice alias to match the alias configured in your Streamer.bot Speaker.bot sub-action.
Optionally set the Speaker.bot program path so StreamLinkr can auto-launch it.
Click Save changes in the top bar.

Final Checklist

Streamer.bot WebSocket server is running.
Host, Port, Endpoint, and Password in System → Connections → Runtime match Streamer.bot exactly.
AI provider is configured under AI → AI Provider and models load correctly.
License key passes the test in System → License.
Bot name and personality set in AI → Bot Behavior → Identity; streamer name and sensitivity set in System → Connections → Platforms.
Action Group import is completed in Streamer.bot.
If using Speaker.bot: integration status is Connected, TTS action works, and TTS is enabled in System → Add-ons → TTS.

Redeemable Rewards Setup

Optional

For Twitch channel point rewards that trigger StreamLinkr actions.

In Streamer.bot, go to Platforms → Twitch → Channel Point Rewards.
Right-click in the rewards list and select Create Reward.
Configure the reward and click Create.
Right-click the new reward and select Copy Reward ID.
In StreamLinkr, open Community → Moderation → Redeems for the functionality you want to trigger (example: !roast).
Paste the Reward ID into the field for that functionality.