Get Started

Setup

Initial configuration of your Streamer.bot Client instance

Enable the WebSocket Server

In Streamer.bot, navigate to Servers/Clients > WebSocket Server
  1. Ensure 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 Options directions below!

Initialize a Client

Explore all client Configuration Options on the API reference page
  1. Initialize a new client with the StreamerbotClient() constructor
  const client = new StreamerbotClient();
  // Client is connected to ws://127.0.0.1:8080/
  1. That's it!
The client will automatically connect to the default WebSocket server location at ws://127.0.0.1:8080/
  1. Initialize a new client with the StreamerbotClient() constructor
  2. Pass your custom configuration settings as the first argument
  const client = new StreamerbotClient({
    host: '127.0.0.1',
    port: 9001,
    endpoint: '/'
  });
  // Client is connected to ws://127.0.0.1:9001/
  1. That's it!
The client will automatically connect to the configured location

Installation

Add @streamerbot/client to your project

Executing Actions

Fetch your actions list and execute specific actions on your Streamer.bot instance