Initial Setup Guide

Let's get you up and running with Streamer.bot!

Overview

This guide covers the basics of the following initial setup of Streamer.bot:

Platforms

Connect your streaming platform account(s) to enable Streamer.bot to receive events and perform actions such as sending messages to your chat.

Streamer.bot supports both Twitch and YouTube as streaming platforms.

Twitch

Connect your Twitch account to Streamer.bot

YouTube

Connect your YouTube account to Streamer.bot

Twitch Setup

Connect your Twitch account to Streamer.bot

Navigate to Platforms > Twitch > Accounts

Twitch Accounts Configuration

Twitch Accounts Configuration

Broadcaster Account

The Broadcaster Account is your primary Twitch account where you host your stream. This connection is required for Streamer.bot to monitor your chat and receive Twitch events.

  1. Login to Twitch with your primary account
Press `Login` to launch the Twitch OAuth screen
  1. Grant permissions
Review all scopes granted to Streamer.bot and allow access to proceed
Streamer.bot will automatically connect to this account on startup.

Bot Account

The Bot Account is an optional second connection if you wish to send chat messages from another account.

  1. Login to Twitch with a secondary account
Press `Login` to launch the Twitch OAuth screen
  1. Grant permissions
Review all scopes granted to Streamer.bot and allow access to proceed
The Bot Account has limited permission scope and can only send chat messages or whispers.
Explore the full Twitch Configuration Guide to learn more about all available options.

YouTube Setup

Connect your YouTube account with Streamer.bot

Navigate to Platforms > YouTube > Accounts

YouTube Account Configuration

YouTube Account Configuration

If asked, you must click I Agree to continue to the YouTube configuration screen.

Broadcaster Account

The Broadcaster Account is your primary YouTube account where you host your stream. This connection is required for Streamer.bot to monitor your chat and receive YouTube events.

  1. Login to YouTube with your primary account
Click `Sign in with Google` to launch the Google OAuth screen
  1. Grant permissions
Review all scopes granted to Streamer.bot and allow access to proceed
  1. Auto Connect
Enable `Auto Connect` to automatically connect to your YouTube account when Streamer.bot starts up
The username field is read-only. Your authenticated username will display here once you have signed in.
If you stream from a brand account: the proper permissions will not be granted if you select the brand account on the first screen. You must first sign in to the primary YouTube account which has ownership of the brand account. You will then be able to select from owned brand accounts on the following screen.

Bot Account

The Bot Account is an optional second connection if you wish to send chat messages from another account.

  1. Login to YouTube with a secondary account
Click `Sign in with Google` to launch the Google OAuth screen
  1. Grant permissions
Review all scopes granted to Streamer.bot and allow access to proceed
  1. Auto Connect
Enable `Auto Connect` to automatically connect to your YouTube account when Streamer.bot starts up
Explore the full YouTube Configuration Guide to learn more about all available options.

Broadcasters

Set up your broadcasting software to work with Streamer.bot

OBS Studio

Take control of your OBS Studio instance(s) with Streamer.bot

Streamlabs Desktop

Control Streamlabs Desktop with Streamer.bot

Meld Studio

Control Meld Studio with Streamer.bot

OBS Studio is highly recommended and provides the most functionality

OBS Studio

Configure Streamer.bot to remotely control your OBS Studio instance(s).

This guide assumes you are running OBS Studio version 28.0.0 or later
  1. Enable OBS WebSocket Server
In OBS Studio, navigate to Tools > WebSocket Server Settings from the menu bar
![OBS Studio WebSocket Settings](/assets/1.get-started/assets/obs-studio-websocket-settings.png){width=600}

::warning
If you don't see the WebSocket settings, and you have verified you are on version `28.0.0` or later, navigate to **Help > Verify Files** from the menu bar.
::

- Ensure the `Enable WebSocket server` setting is **enabled** (checked)
- Change the `Server Settings` as desired
    - You will enter these values in Streamer.bot in the next steps

2. Set up your OBS Studio connection in Streamer.bot

Navigate to Stream Apps > OBS
![OBS Studio Configuration](/assets/1.get-started/assets/obs-studio.png)

To add a new connection, :kbd{value="Right-Click"} anywhere in the panel area and select `Add`
![OBS Studio Add Connection](/assets/1.get-started/assets/obs-studio-add-connection.png)

- Enter a name for this OBS connection
- Select version `v5.x`
- If OBS Studio is running on the same machine, keep `127.0.0.1` for the `Host` field
    - For multi-pc setups you can configure this with another LAN IP address
- Configure `Port` and `Password` to match the `WebSocket Server Settings` setup in OBS Studio
- Click `OK` when you have finished configuration
- :kbd{value="Right-Click"} the new instance and select `Connect` to force an immediate connection attempt

::warning
If you are having trouble connecting, double-check the **Host, Port, Password, and Version** to ensure it matches your OBS Studio instance.
::

::read-more{to=/guide/broadcasters/obs-studio}
Explore the full [OBS Studio Configuration Guide](/guide/broadcasters/obs-studio) to learn more about all available options.
::

Streamlabs Desktop

Set up Streamer.bot to remotely control your Streamlabs Desktop instance

  1. Get Streamlabs API Settings
Obtain your **API Token** and **Port** from your Streamlabs Desktop settings.
Navigate to Settings > Remote Control in Streamlabs Desktop
undefined

Save these settings for the next steps.

2. Add Streamlabs Desktop connection to Streamer.bot

Navigate to Stream Apps > Streamlabs Desktop
![Streamlabs Desktop Configuration](/assets/1.get-started/assets/streamlabs-desktop.png)

To add a new connection, :kbd{value="Right-Click"} anywhere in the panel area and select `Add`

::read-more{to=/guide/broadcasters/streamlabs-desktop}
Explore the full [Streamlabs Desktop Configuration Guide](/guide/broadcasters/streamlabs-desktop) to learn more about all available options.
::

Meld Studio

Set up Streamer.bot to remotely control your Meld Studio instance

  1. Enable Remote Connections
In Meld Studio, navigate to File > Preferences > Advanced in Meld Studio
![Meld Studio Advanced Settings](/assets/1.get-started/assets/meld-studio-advanced-settings.png){width=600}

- Ensure the `Allow remote connections` is **enabled** (checked)

2. Setup your Meld Studio connection in Streamer.bot

Navigate to Stream Apps > Meld Studio
![Meld Studio Configuration](/assets/1.get-started/assets/meld-studio.png)

To add a new connection, :kbd{value="Right-Click"} anywhere in the panel area and select `Add`
![Meld Studio Add Connection](/assets/1.get-started/assets/meld-studio-add-connection.png)

- Enter a name for this Meld Studio connection
- If Meld Studio is running on the same machine, keep `127.0.0.1` for the `Host` field
    - For multi-pc setups you can configure this with another LAN IP address
- Click `OK` when you have finished configuration
- :kbd{value="Right-Click"} the new instance and select `Connect` to force an immediate connection attempt

:read-more{to=/guide/broadcasters/meld-studio}