Get Started
Setup
Initial configuration of your Streamer.bot Client instance
Enable the WebSocket Server
In Streamer.bot, navigate to
Servers/Clients > WebSocket ServerEnsure your WebSocket Server is enabled and running, or click Start Server
If you changed the
Host, Port or Endpoint settings, make sure to follow the Custom Settings guide below!Initialize a Client
Explore all client Configuration Settings on the API reference page
You can initialize a new client instance with the StreamerbotClient() constructor:
example.js
const client = new StreamerbotClient();
The client will automatically connect to the default WebSocket server location at
ws://127.0.0.1:8080/Initialize a new client with the StreamerbotClient() constructor, passing in your custom configuration settings as the first argument:
example.js
const client = new StreamerbotClient({
host: '127.0.0.1',
port: 9001,
endpoint: '/',
});
The client will automatically connect to the configured location