Streamer.bot supports both OBS WebSocket versions, v4.9+ and v5+
This documentation refers to OBS WebSocket version v5+
Adding at least one OBS connection will allow Streamer.bot to control your OBS.
Once configured, connected OBS sessions will report their status on this screen.
With v28+ OBS Websocket is pre-installed, so you don't need to install it. If you can't see it under tools you might need to do a
Check File Integrity in OBS. After that it should show up.
Right-Click -> Add to define a new OBS connection
Enter any name or label to describe this OBS instance, e.g.
Select the version of OBS WebSocket to use for this connection.
As of OBS Studio v28.0, OBS WebSocket v5+ is included by default.
To continue using OBS WebSocket v4.9+, you must install the obs-websocket-4.9.1-compat plugin
It is recommended to update to v5+ if you are currently using an older version.
Default is localhost,
To connect to another OBS instance on your local network, you can enter the local IP address, e.g.
Default is: v4.9+ =
4444 or v5+ =
It's recommended to keep this the same unless you are using multiple OBS portable installs on your same desktop.
Not required, devices can only connect to your OBS if they're on the same network as you.
When toggled this auto connects your OBS connection when you launch streamer.bot.
When toggled this tries to reconnect (by default every 30s) when streamer.bot loses connection with your OBS.
When Streamer.bot loses connection with your OBS this by default will try to reconnect every 30s, but you can change it to what you want.
Overview of connection information available on the right-hand panel
Shows the version number of OBS and the installed WebSocket plugin
Shows the name of the currently broadcasting scene on that connection
Shows the status of current streaming and recording activity
Lists all sources present on the currently selected scene
Select an OBS connection in the top panel, then Right-Click -> Add in the bottom events panel to register an OBS event.
Select the event type from OBS
A reference of all OBS Studio events is available here
Optional group name to keep your events organized
Select the action to be executed any time the selected event is fired off from OBS
Events emitted when the OBS websocket server has connected/disconnected