Streamer.bot

https://github.com/streamerbot/docs
Admin
Streamer.bot is an automation platform for streamers that enables custom actions, triggers, and...
Tokens:245,077
Snippets:3,049
Trust Score:6.4
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install winetricks and dependencies on Ubuntu

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/1.get-started/1.installation/1.linux/1.script.md

For Ubuntu, install winetricks and update it, then install git and curl. Run these commands in a terminal.

```bash
sudo apt install winetricks
sudo winetricks --self-update
```

```bash
sudo apt install git curl
```

--------------------------------

### Clone and run the Streamer.bot installer

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/1.get-started/1.installation/1.linux/1.script.md

Clone the sb-linux-installer repository, change into its directory, and execute the install script. This installs Streamer.bot and its dependencies.

```bash
# Clone the repository
git clone https://github.com/Streamerbot/sb-linux-installer

# Change directory
cd ./sb-linux-installer

# Execute the installer
./install.sh
```

--------------------------------

### GetCommands - Request, Response, and Client Example

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/4.websocket/3.requests.md

Request schema, example request, response, and client example for GetCommands. The response includes a list of commands with id, enabled, name, group, commands, caseSensitive, ignoreInternal, ignoreBotAccount, and sources.

```json
{
  "request": "GetCommands",
  "id": "<id>"
}
```

```json
{
  "request": "GetCommands",
  "id": "my-subscribe-id"
}
```

```json
{
  "status": "ok",
  "id": "my-subscribe-id",
  "commands": [
    {
      "id": "81bc8200-256d-4e1e-9e41-5010c3b808de",
      "enabled": false,
      "name": "My Game",
      "group": "playing with viewers",
      "commands": ["!addplayer", "!nextplayer", "!randomplayer"],
      "caseSensitive": false,
      "ignoreInternal": true,
      "ignoreBotAccount": true,
      "sources": 1
    },
    {
      "id": "ac0dfb07-b5e2-4e97-8528-ca27dd67f47c",
      "enabled": true,
      "name": "CheckFiveMPlayers",
      "group": null,
      "commands": ["!server"],
      "caseSensitive": false,
      "ignoreInternal": true,
      "ignoreBotAccount": true,
      "sources": 1
    }
  ],
  "count": 2
}
```

```ts
// Using @streamerbot/client
const response = await client.getCommands();
```

--------------------------------

### Install wine, winetricks, and dependencies on Arch

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/1.get-started/1.installation/1.linux/1.script.md

For Arch, install wine, winetricks, git, and curl using pacman. Each command is commented for clarity.

```bash
# Install wine
sudo pacman -S wine

# Install winetricks
sudo pacman -S winetricks

# Install remaining dependencies
sudo pacman -S git curl
```

--------------------------------

### TestCredits HTTP Request Examples

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/5.http/1.requests/test-credits.md

Examples of making a GET request to the TestCredits endpoint using curl, JavaScript fetch, and Python requests. All target http://127.0.0.1:7474/TestCredits.

```bash
curl -X GET http://127.0.0.1:7474/TestCredits
```

```js
const response = await fetch('http://127.0.0.1:7474/TestCredits');
const data = await response.json();
console.log(data);
```

```py
import requests
response = requests.get('http://127.0.0.1:7474/TestCredits')
data = response.json()
print(data)
```

--------------------------------

### JavaScript authentication example

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/4.websocket/0.guide/4.authentication.md

Example in JavaScript showing how to generate the authentication string using crypto and send the Authenticate request.

```javascript
import crypto from 'crypto';

const { salt, challenge } = data.authentication;
const password = 'your_websocket_password';
const secret = crypto.createHash('sha256').update(password + salt, 'utf8').digest('base64');
const authentication = crypto.createHash('sha256').update(secret + challenge, 'utf8').digest('base64');

const authRequest = {
  id: '1',
  request: 'Authenticate',
  authentication
};
ws.send(JSON.stringify(authRequest));
```

--------------------------------

### Install @streamerbot/client with npm

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/4.websocket/0.guide/1.client.md

Install the official Streamer.bot client package using the npm package manager.

```bash
npm install @streamerbot/client
```

--------------------------------

### ClearCredits HTTP request examples

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/5.http/1.requests/clear-credits.md

Send a GET request to /ClearCredits to clear credits. The response is 204 No Content. Examples are provided for Terminal (curl), JavaScript (fetch), and Python (requests).

```bash
curl -X GET http://127.0.0.1:7474/ClearCredits
```

```js
const response = await fetch('http://127.0.0.1:7474/ClearCredits', {
  method: 'GET'
});
console.log(response.status); // 204
```

```py
import requests
response = requests.get('http://127.0.0.1:7474/ClearCredits')
print(response.status_code)  # 204
```

--------------------------------

### Hello request JSON example

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/4.websocket/0.guide/4.authentication.md

Example of the Hello message received when connecting to the WebSocket server when authentication is enabled. Contains an authentication object with salt and challenge strings.

```json
{
  "timestamp": "<ISO8601_string>",
  "session": "<string>",
  "request": "Hello",
  "info": {
    "instanceId": "<string>",
    "name": "<string>",
    "version": "<string>",
    "os": "<string>",
    "osVersion": "<string>",
    "mode": "ui",
    "darkMode": true,
    "source": "websocketServer"
  },
  "authentication": {
    "salt": "<base64_string>",
    "challenge": "<base64_string>"
  }
}
```

--------------------------------

### Install @streamerbot/client with yarn

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/4.websocket/0.guide/1.client.md

Install the official Streamer.bot client package using the yarn package manager.

```bash
yarn add @streamerbot/client
```

--------------------------------

### Log output example

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/4.examples/csharp_obsraw.md

Example log output showing the extracted values.

```text
[2024-08-11 19:13:48.297 INF] GDI Text: Current bitrate: 7500 // Font Size: 144
```

--------------------------------

### ExecuteCodeTrigger - Request, Response, and Client Example

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/4.websocket/3.requests.md

Request schema, example request, response, and client example for ExecuteCodeTrigger. The request includes triggerName and args; the response confirms status and id.

```json
{
  "request": "ExecuteCodeTrigger",
  "id": "<id>",
  "triggerName": "<triggerName>",
  "args": {
    "key": "value"
  }
}
```

```json
{
  "request": "ExecuteCodeTrigger",
  "id": "my-subscribe-id",
  "triggerName": "poll_vote_removed",
  "args": {
    "stringArg": "abcdef",
    "numArg": 1234
  }
}
```

```json
{
  "status": "ok",
  "id": "my-subscribe-id"
}
```

```ts
// Using @streamerbot/client
client.executeCodeTrigger(
  (triggerName = "poll_vote_removed"),
  (args = { stringArg: "abcdef", numArg: 1234 }),
);
```

--------------------------------

### CPH.KeyboardPress example

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/3.csharp/3.methods/core/system/keyboard-press.md

Example of using CPH.KeyboardPress to send various keystrokes and key combinations.

```csharp
using System;

public class CPHInline
{
  public bool Execute()
  {
    // Examples:

    // 'W'
    CPH.KeyboardPress("{W}");

    // 'DOWN ARROW'
    CPH.KeyboardPress("{DOWN}");

    // 'SHIFT' and 'W'
    CPH.KeyboardPress("+{W}");

    // 'CTRL' and 'W'
    CPH.KeyboardPress("^{W}");

    // 'ALT' and 'W'
    CPH.KeyboardPress("%{W}");

    return true;
  }
}
```

--------------------------------

### Install @streamerbot/client with pnpm

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/4.websocket/0.guide/1.client.md

Install the official Streamer.bot client package using the pnpm package manager.

```bash
pnpm install @streamerbot/client
```

--------------------------------

### curl Example

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/5.http/1.requests/do-action.md

Sends a POST request to the /DoAction endpoint using curl. The example includes an action ID and name, and passes a custom argument.

```bash
curl -X POST http://127.0.0.1:7474/DoAction \
  -H "Content-Type: application/json" \
  -d '{
    "action": {
      "id": "your-action-guid",
      "name": "Your Action Name"
    },
    "args": {
      "customArg": "customValue"
    }
  }'
```

--------------------------------

### math() inline function examples

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/2.guide/01.core/03.variables.md

Evaluate mathematical equations inline with variable replacements using the mXparser library. The first example outputs 20 for 10+10. The remaining examples show multiplying or dividing variables by constants.

```cs
// Expected output: 20
$math(10+10)$

// Multiply %x% by 1.25
$math(%x% * 1.25)$

// Multiply %tier% by 10
$math(%tier% * 10)$

// Divide %duration% by 1000
$math(%duration% / 1000)$
```

--------------------------------

### Custom Overlay Module Example (Content/my-module.js)

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/2.guide/04.extra-features/3.html-overlay.md

Example of a custom overlay module. Subscribes to Twitch Channel Point Rewards and triggers the overlay when the reward title matches. Uses the Streamer.bot client available at window.client.

```js
const CONFIG = {
  rewardTitle: 'Show Image',
  imageUrl: 'https://streamer.bot/logo.png',
  seconds: 5,
  width: 'auto',
  height: 'auto',
};

// Here we are subscribing to Twitch Channel Point Rewards
// and triggering our overlay when the configured title matches a redemption
window.client.on('Twitch.RewardRedemption', (message) => {
  if ((message.data.reward.title || message.data.title) === config.rewardTitle) {
    showImage();
  }
});
```

--------------------------------

### GetCodeTriggers - Request, Response, and Client Example

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/4.websocket/3.requests.md

Request schema, example request, response, and client example for GetCodeTriggers. The response includes a list of code triggers with name, eventName, and category.

```json
{
  "request": "GetCodeTriggers",
  "id": "<id>"
}
```

```json
{
  "request": "GetCodeTriggers",
  "id": "my-subscribe-id"
}
```

```json
{
  "status": "ok",
  "id": "my-subscribe-id",
  "count": 1,
  "triggers": [
    {
      "name": "Channel Created",
      "eventName": "channel_created",
      "category": "Custom/Discord Server/Channels"
    }
  ]
}
```

```ts
// Using @streamerbot/client
const response = await client.getCodeTriggers();
```

--------------------------------

### Install ollama python package with pip

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/4.examples/ollama-chat-command.md

Run this command in Command Prompt from the scripts directory to install the ollama python package, which allows the script to interact with Ollama.

```bash
pip install ollama
```

--------------------------------

### Init() lifecycle method signature and example

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/3.csharp/0.guide/2.lifecycle-methods.md

The Init() method is executed when your code is first compiled, including during Streamer.bot startup. Use it for initialization steps such as setting up class-level variables or initializing objects used in Execute(). The signature shows the method declaration, and the example shows a full CPHInline class with an Init() method.

```cs
public void Init();
```

```cs
using System;

public class CPHInline
{
    public bool Execute()
    {
        // your main code goes here
        return true;
    }

    public void Init()
    {
        // place your init code here
    }
}
```

--------------------------------

### GetEvents Response Example

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/4.websocket/3.requests.md

Example response from the connected Streamer.bot instance listing all subscribable events.

```json
{
  "status": "ok",
  "id": "my-get-events-id",
  "events": {
    "general": ["Custom"],
    "twitch": [
      "Follow",
      "Cheer",
      "Sub",
      "ReSub",
      "GiftSub",
      "GiftBomb",
      "Raid",
      "HypeTrainStart",
      "HypeTrainUpdate",
      "HypeTrainLevelUp",
      "HypeTrainEnd",
      "RewardRedemption",
      "RewardCreated",
      "RewardUpdated",
      "RewardDeleted",
      "CommunityGoalContribution",
      "CommunityGoalEnded",
      "StreamUpdate",
      "Whisper",
      "FirstWord",
      "SubCounterRollover",
      "BroadcastUpdate",
      "StreamUpdateGameOnConnect",
      "PresentViewers",
      "PollCreated",
      "PollUpdated",
      "PollCompleted",
      "PredictionCreated",
      "PredictionUpdated",
      
```

--------------------------------

### GetVersion C# Example

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/3.csharp/3.methods/core/misc/get-version.md

Retrieves the Streamer.bot version string in SemVersion format (e.g., 0.2.6) and logs it to the log. The example is a CPHInline class with an Execute method.

```csharp
using System;
public class CPHInline
{
    public bool Execute()
    {
        //Get version string in SemVersion format (0.2.6)
        string sbVersion = CPH.GetVersion();
        //Write to log
        CPH.LogInfo(sbVersion);
        
        return true;
    }
}
```

--------------------------------

### GetEvents Request Example

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/4.websocket/3.requests.md

Example request for GetEvents with a concrete id value.

```json
{
  "request": "GetEvents",
  "id": "my-get-events-id"
}
```

--------------------------------

### CPH.WebsocketCustomServerStart

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/3.csharp/3.methods/core/websocket/websocket-custom-server-start.md

Starts a custom WebSocket server in Streamer.bot, selecting which server to start by its index in the clients list.

```APIDOC
## CPH.WebsocketCustomServerStart(0)

### Description
Starts a custom WebSocket server in Streamer.bot using the provided connection index.

### Method
CPH.WebsocketCustomServerStart(int connection)

### Parameters
- **connection** (int) - Required - The index of the custom WebSocket server to start, based on the order in the clients list, starting at 0.

### Request Example
```csharp
CPH.WebsocketCustomServerStart(0);
```

### Response
Returns a boolean indicating whether the operation was successful (likely true on success).

```

--------------------------------

### Example JSON response from GetInputSettings

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/4.examples/csharp_obsraw.md

The JSON response returned by the GetInputSettings request, showing the structure with inputKind and inputSettings.

```json
{
  "inputKind": "text_gdiplus_v3",
  "inputSettings": {
    "color": 8388437,
    "font": {
      "face": "Neue Haas Grotesk Text Pro Extr",
      "flags": 0,
      "size": 144,
      "style": "ExtraLight"
    },
    "text": "Current bitrate: 7500"
  }
}
```

--------------------------------

### JavaScript fetch Example

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/5.http/1.requests/do-action.md

Uses the fetch API to POST to the /DoAction endpoint. Logs the response status, which is 204 on success.

```js
const response = await fetch('http://127.0.0.1:7474/DoAction', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    action: {
      id: 'your-action-guid',
      name: 'Your Action Name',
    },
    args: {
      customArg: 'customValue',
    },
  }),
});
console.log(response.status); // 204
```

--------------------------------

### C# example: Fetch users in a group with CPH.UsersInGroup

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/3.csharp/3.methods/core/users/users-in-group.md

Use this snippet to retrieve a list of users in a group by name. The method returns a List<GroupUser>; each GroupUser has Username and Type properties. The example logs each user's username and platform type.

```csharp
using System;
using System.Collections.Generic;//due to List usage
public class CPHInline
{
    public bool Execute()
    {
        //Define the groupname you want to add the user to
        string groupName = "Test Group";

        //Get List of GroupUsers
        List<GroupUser> groupUsers = CPH.UsersInGroup(groupName);

        //Write each user of group into logs example
        foreach(GroupUser userInfo in groupUsers)
        {
            //user name of current user
            string user = userInfo.Username;
            //platform type of current user
            string userType = userInfo.Type;

            CPH.LogInfo($"Username: {user}, Platform: {userType}");
        }
        return true;
    }
}
```

--------------------------------

### Authenticate request JSON example

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/4.websocket/0.guide/4.authentication.md

Example of the Authenticate request to send back to Streamer.bot after generating the authentication string from the salt and challenge.

```json
{
  "request": "Authenticate",
  "id": "<request_id>", // Any unique ID you want to use
  "authentication": "<authentication_string>" // Your generated authentication string
}
```

--------------------------------

### GetActiveViewers - Request, Response, and Client Example

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/4.websocket/3.requests.md

Request schema for GetActiveViewers, followed by a sample response and a client example using @streamerbot/client. The response includes viewer details such as id, type, login, display, subscribed, role, groups, channelPointsUsed, previousActive, and exempt.

```json
{
  "request": "GetActiveViewers",
  "id": "<id>"
}
```

```json
{
  "count": 2,
  "viewers": [
    {
      "id": "695682330",
      "type": "kick",
      "login": "ik1497",
      "display": "ik1497",
      "subscribed": true,
      "role": "Broadcaster",
      "groups": [],
      "channelPointsUsed": 0,
      "previousActive": "2022-12-20T01:03:01.4613004+01:00",
      "exempt": true
    },
    {
      "id": "750146097",
      "type": "twitch",
      "login": "ik1497bot",
      "display": "Ik1497Bot",
      "subscribed": false,
      "role": "Moderator",
      "groups": ["Friends"],
      "channelPointsUsed": 0,
      "previousActive": "2022-12-20T01:03:10.5548462+01:00",
      "exempt": false
    }
  ],
  "status": "ok",
  "id": "123"
}
```

```ts
// Using @streamerbot/client
const response = await client.getActiveViewers();
console.log("Streamer.bot Active Viewers", response.viewers);
```

--------------------------------

### GetSource C# Example

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/3.csharp/3.methods/core/events/get-source.md

Retrieves the EventSource for the current action and compares it using a switch statement. The example includes cases for Twitch and YouTube events.

```csharp
using System;

public class CPHInline
{
  public bool Execute()
  {
    // Get the EventSource for the current action
    EventSource source = CPH.GetSource();

    // Compare EventSource with switch or if
    switch(source)
    {
      case EventSource.Twitch:
        // Do something with Twitch events...
        break;
      case EventSource.YouTube:
        // Do something with YouTube events...
        break;
    }

    return true;
  }
}
```

--------------------------------

### Example Event Payload (example.json)

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/4.websocket/0.guide/3.events.md

Concrete example of an event payload for a Twitch ChatMessage event. Shows the structure with timeStamp, event source and type, and data placeholder.

```json
{
  "timeStamp": "2022-01-30T21:32:04.4588947-05:00",
  "event": {
    "source": "Twitch",
    "type": "ChatMessage"
  },
  "data": {
    // Twitch Chat Message Data
  }
}
```

--------------------------------

### length() inline function examples

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/2.guide/01.core/03.variables.md

Obtain the length of arbitrary text or a given variable. The first example returns 69 for the provided string, and the second shows obtaining the length of %rawInput%.

```cs
// Expected output: 69
$length(Lorem ipsum dolor sit amet consectetur adipisicing elit. Commodi, ut.)$

// Obtain the length of %rawInput%
$length(%rawInput%)$
```

--------------------------------

### Get connection index of custom WebSocket server

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/3.csharp/3.methods/core/websocket/websocket-custom-server-get-connection-by-name.md

Use CPH.WebsocketCustomServerGetConnectionByName to retrieve the index of a custom WebSocket server by its configured name. The index corresponds to the server's position in the clients list, starting at 0. The example retrieves the index for a server named "Test".

```csharp
using System;
public class CPHInline
{
    public bool Execute()
    {
        //Get index of custom websocket server named "Test"
        //Index is from top to bottom of the clients list, starting at 0
        int index = CPH.WebsocketCustomServerGetConnectionByName("Test");
        
        return true;
    }
}
```

--------------------------------

### Basic HttpClient Setup

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/4.examples/http-post.md

Sets up a static HttpClient with a 30-second timeout and clears default headers on init. Disposes the client on shutdown. Avoid creating new HttpClient instances per request.

```csharp
using System;
using System.Text;
using System.Threading.Tasks;
using System.Net.Http;
using System.Net.Http.Headers;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;

public class CPHInline {
  // You can set the timeout to any length you need
  private static readonly HttpClient _httpClient = new HttpClient{Timeout = TimeSpan.FromSeconds(30)};

  public void Init() {
    // Ensure we are working with a clean slate
    _httpClient.DefaultRequestHeaders.Clear();
  }

  public void Dispose() {
    // Free up allocations
    _httpClient.Dispose();
  }

  public bool Execute() {
    // ...
    return true;
  }
}
```

--------------------------------

### StopAllSoundPlayback C# Example

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/3.csharp/3.methods/core/sounds/stop-all-sound-playback.md

Use this method to stop all sounds that were started by Streamer.bot. The example shows a basic CPHInline class with an Execute method that calls CPH.StopAllSoundPlayback() and returns true.

```csharp
using System;
public class CPHInline
{
    public bool Execute()
    {
        CPH.StopAllSoundPlayback();
        
        return true;
    }
}
```

--------------------------------

### TwitchAnnounce C# Example

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/3.csharp/3.methods/twitch/chat/twitch-announce.md

Sends a Twitch announcement using the CPH.TwitchAnnounce method. The example sets a message and calls the method with the bot account, falling back to the broadcaster if the bot is not available. The color parameter is referenced as 'color' but is not defined in the snippet.

```csharp
using System;
public class CPHInline
{
    public bool Execute()
    {
        //Set message for chat
        string message = "This is an announcement";

        //Send announcement with bot account, or fallback to broadcaster
        CPH.TwitchAnnounce(message, true, color, true);

        return true;
    }
}
```

--------------------------------

### Python requests example for GetCredits

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/5.http/1.requests/get-credits.md

Use this Python code to make a GET request to the Streamer.bot HTTP server and print the JSON response.

```py
import requests
response = requests.get('http://127.0.0.1:7474')
data = response.json()
print(data)
```

--------------------------------

### DisableTimerById C# Example

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/3.csharp/3.methods/core/timers/disable-timer-by-id.md

Use this snippet to disable a timer by its ID. It retrieves the 'timerId' argument as a string (directly convertible from Guid since version 0.2.5) and calls CPH.DisableTimerById. The commented-out lines show an alternative for older versions using Guid conversion.

```csharp
using System;
public class CPHInline
{
    public bool Execute()
    {
        //Guid are convertable directly to string since 0.2.5
        CPH.TryGetArg("timerId",out string timerId);
        //Otherwise use the commented out methods below to get the current timerId
        //CPH.TryGetArg<Guid>("timerId", out var timerIdVar);
        //string timerId = timerIdVar.ToString();
        
        CPH.DisableTimerById(timerId);
        
        return true;
    }
}
```

--------------------------------

### C# OBS Raw GetInputSettings and SetInputSettings with variables

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/4.examples/csharp_obsraw.md

Complete C# example that retrieves input settings from OBS, extracts the text and font size, and sends them to another source using variable substitution in the request.

```csharp
using System;
using Newtonsoft.Json.Linq;

public class CPHInline
{
    public bool Execute()
    {
        string getInputSettingsResponse = CPH.ObsSendRaw("GetInputSettings", "{\"inputName\":\"Bitrate Text\"}", 0);

        JObject inputSettingsJObject = JObject.Parse(getInputSettingsResponse);

        string gdiText = (string)inputSettingsJObject["inputSettings"]["text"];

        int fontSize = (int)inputSettingsJObject["inputSettings"]["font"]["size"];

        CPH.ObsSendRaw("SetInputSettings", "{\"inputName\":\"Other Textsource\",\"inputSettings\":{\"font\":{\"size\": " + fontSize + "},\"text\":\" " + gdiText + "\"},\"overlay\":true}", 0);

        return true;
    }
}
```

--------------------------------

### TwitchGetRewardUserCounter C# Example

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/3.csharp/3.methods/twitch/channel-reward/twitch-get-reward-user-counter.md

Use this snippet to get the reward counter for a specific user and reward. It requires a rewardId and a userName argument, and sets the counter as an argument named 'rewardUserCounter'.

```csharp
using System;
public class CPHInline
{
    public bool Execute()
    {
        //Define reward id of reward you want counter
        string rewardId = "4fcc2d13-9bcf-4c18-9d91-821a15f4b6e5";
        //Get user login
        CPH.TryGetArg("userName",out string userLogin);
        //Get persisted reward counter info of for specific user
        TwitchRewardCounter rewardCounter = CPH.TwitchGetRewardUserCounter(userLogin, rewardId, true);
        //Get counter
        int counter = rewardCounter.Count;
        //Set Argumnet for counter
        CPH.SetArgument("rewardUserCounter", counter);
        return true;
    }
}
```

--------------------------------

### Streaming

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/1.sub-actions/obs-studio/streaming.md

This sub-action allows you to start or stop streaming in OBS Studio. It requires a connection and a state selection.

```APIDOC
## [OBS] Streaming

### Description
Change your streaming status in OBS Studio.

### Parameters
- **Connection** (Connection) - Required - The OBS Studio connection to use.
- **State** (Select) - Required - Choose the streaming state. Options: Start (Start your streaming), Stop (Stop your streaming).

### C# Methods
- ObsStopStreaming
- ObsStartStreaming

```

--------------------------------

### C# Example: TwitchGetChannelPointsUsedByUserId

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/3.csharp/3.methods/twitch/channel-reward/twitch-get-channel-points-used-by-user-id.md

Use this C# code to get the channel points used by the current user. It retrieves the userId argument, calls TwitchGetChannelPointsUsedByUserId, and stores the result in the 'amountSpend' argument.

```csharp
using System;
public class CPHInline
{
    public bool Execute()
    {
        //Get user id of current user
        CPH.TryGetArg("userId",out string userId);
        //Get amount
        long amount = CPH.TwitchGetChannelPointsUsedByUserId(userId);
        //Set as argument example
        CPH.SetArgument("amountSpend",amount);
        return true;
    }
}
```

--------------------------------

### Set user cooldown duration for a command by ID

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/3.csharp/3.methods/core/commands/command-set-user-cooldown-duration.md

Use CPH.CommandSetUserCooldownDuration to set the user cooldown duration for a command identified by its ID. The example sets a cooldown of 42 seconds for a command with a specific GUID.

```csharp
using System;
public class CPHInline
{
    public bool Execute()
    {
        //Define string of commandId
        string commandId = "4fcc2d13-9bcf-4c18-9d91-821a15f4b6e5";

        //Set global cooldown to 42 seconds
        CPH.CommandSetUserCooldownDuration(commandId, 42);
        
        return true;
    }
}
```

--------------------------------

### On command (same as enable)

Source: https://github.com/streamerbot/docs/blob/main/speakerbot/2.api/1.udp/1.requests.md

The 'on' command provides the same functionality as 'enable'.

```json
{
  "command": "on"
}
```

--------------------------------

### Get Twitch Moderators with CPH.TwitchGetMods

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/3.csharp/3.methods/twitch/user/twitch-get-mods.md

Use CPH.TwitchGetMods() to retrieve a list of TwitchUserInfo objects representing the channel's moderators. The example iterates through the list and logs each moderator's username and user ID using CPH.LogInfo.

```csharp
using System;
using System.Collections.Generic;

public class CPHInline
{
    public bool Execute()
    {
        //get the list of Mods for the channel
        List<TwitchUserInfo> mods = CPH.TwitchGetMods();

        //iterate through the list and log the username and user id of each Moderator
        foreach (TwitchUserInfo mod in mods)
        {
            CPH.LogInfo($"Moderator: {mod.UserName} ({mod.UserId})");
        }

        return true;
    }
}
```

--------------------------------

### Download llama3.1 model with ollama run

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/4.examples/ollama-chat-command.md

Run this command in Command Prompt to download and run the llama3.1 model in Ollama. This is a prerequisite for the example.

```bash
ollama run llama3.1
```

--------------------------------

### CommandGetUserCounterById usage example

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/3.csharp/3.methods/core/commands/command-get-user-counter-by-id.md

Use this snippet to get the total number of times a user has executed a command by its ID. It retrieves the command ID, user ID, and platform from arguments, then calls CPH.CommandGetUserCounterById and reads the Count property.

```csharp
using System;
public class CPHInline
{
    public bool Execute()
    {
        //Define specified command via command id
        string commandId = "4fcc2d13-9bcf-4c18-9d91-821a15f4b6e5";
        //Get current user id
        CPH.TryGetArg("userId",out string userId);
        //Get current platform of user
        CPH.TryGetArg("userType",out string userType);
        Enum.TryParse(userType, out Platform platform);
        
        //Get CommandCounter
        CommandCounter commandCounterInfo = CPH.CommandGetUserCounterById(userId, platform, commandId);
        //Get command user count
        int numberOfUses = commandCounterInfo.Count;
        
        return true;
    }
}
```

--------------------------------

### GetAllClips Example

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/3.csharp/3.methods/twitch/clips/get-all-clips.md

Fetches all featured clips for the connected Twitch broadcaster and logs their details. The list is sorted by view count in descending order. A maximum of 1,000 clips can be returned.

```csharp
using System;
using System.Collections.Generic;//Needed for List
using Twitch.Common.Models.Api; //Needed for ClipData Type
public class CPHInline
{
    public bool Execute()
    {
        //Get List of featured clips
        List<ClipData> clipList = CPH.GetAllClips(true);

        //Go through clips and write info to logs
        foreach(ClipData clip in clipList)
        {
            //Get id of current clip
            string id = clip.Id;
            //Get url of current clip
            string url = clip.Url;
            //Get title of current clip
            string title = clip.Title;
            //Get view count of current clip
            int viewCount = clip.ViewCount;

            CPH.LogInfo($"ViewCount:{viewCount},Title:{title}, Id:{id}, Url:{url}");
        }
        return true;
    }
}
```

--------------------------------

### C# example: TwitchGetRewardUserCounterById

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/3.csharp/3.methods/twitch/channel-reward/twitch-get-reward-user-counter-by-id.md

Use this snippet to get the reward counter for a specific user and reward ID. It defines a reward ID, retrieves the user ID from arguments, calls CPH.TwitchGetRewardUserCounterById, and sets the counter as an argument named 'rewardUserCounter'.

```csharp
using System;
public class CPHInline
{
    public bool Execute()
    {
        //Define reward id of reward you want counter
        string rewardId = "4fcc2d13-9bcf-4c18-9d91-821a15f4b6e5";
        //Get user id
        CPH.TryGetArg("userId",out string userId);
        //Get persisted reward counter info of for specific user
        TwitchRewardCounter rewardCounter = CPH.TwitchGetRewardUserCounterById(userId, rewardId, true);
        //Get counter
        int counter = rewardCounter.Count;
        //Set Argumnet for counter
        CPH.SetArgument("rewardUserCounter", counter);
        return true;
    }
}
```

--------------------------------

### Get pinned chat message with CPH.TwitchGetPinnedMessage

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/3.csharp/3.methods/twitch/chat/twitch-get-pinned-message.md

Use this C# snippet to retrieve the current pinned chat message. The method returns the pinned message, which is stored in the variable 'pinnedMessage'. This example is part of a CPHInline class and returns true after execution.

```csharp
using System;
public class CPHInline
{
    public bool Execute()
    {
        // get the current pinned chat message
        var pinnedMessage = CPH.TwitchGetPinnedMessage();

        return true;
    }
}
```

--------------------------------

### Execute method with CPH.LogInfo example

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/3.csharp/0.guide/0.intro.md

Shows where to place your main code logic inside the Execute method, which is always called when the sub-action runs. Here it logs a message and returns true to allow subsequent sub-actions.

```cs
public bool Execute()
{
    CPH.LogInfo("Hello from C#");
    return true;
}
```

--------------------------------

### Register Custom Trigger in C#

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/3.csharp/3.methods/core/triggers/register-custom-trigger.md

Registers a custom trigger using CPH.RegisterCustomTrigger. The example is typically placed in the Init() method, often combined with Pre-Compile on Application start. It defines categories and an event name, then calls the method, which returns a boolean indicating success.

```csharp
using System;
public class CPHInline
{
    public void Init()
    {
      // Preferably Custom Triggers are registered during initialization of the code instance
      // Often in combination with Pre-Compile on Application start in the Execute-Code settings

      //Define the categories in custom trigger menu
      string[] categories = {"Streamer.bot","Documentation"};


      //Define the event name for later usage in code with CPH.TriggerCodeEvent(eventName)
      //Advise on making it fairly unique names to your code/extension
      string eventName = "sbDocsUpdate";

      //Register custom trigger. Will give boolean result if successfull
      bool success = CPH.RegisterCustomTrigger(triggerName, eventName, categories);
    }

    public bool Execute()
    {
        // Custom Trigger can also be registered with Execute but common usage is
        // in the Init() method as shown above
        return true;
    }
}
```

--------------------------------

### Handling the response

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/4.examples/http-post.md

Shows how to handle the response from an HTTP request. The example is incomplete in the source, but it indicates checking the response status and reading content.

```csharp
// ...

// Check if the request succeeded
if (response.IsSuccessStatusCode) {
  // Read the response content as a string
  string responseBody = response.Content.ReadAsStringAsync().GetAwaiter().GetResult();
  // Do something with the response body
} else {
  // Handle the error
}

// ...
```

--------------------------------

### UIAC.sh: Extract UIAutomationCore.dll from Windows ISO

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/1.get-started/1.installation/1.linux/4.uiautomationcore.md

Extracts UIAutomationCore.dll from a Windows ISO or install.wim using 7z (requires p7zip). The script prompts for the ISO path, extracts sources/install.wim, then extracts 1/Windows/System32/UIAutomationCore.dll, moves the DLL to the original working directory, and cleans up install.wim. Validates that 7z is installed and exits with an error message if extraction steps fail.

```bash
#!/bin/bash
# Saving the script directory
DIR=$(pwd)

# Changing to a temporal working directory
cd "$(mktemp -d)" || echo Error changing to a temporal directory, \
        will use the script directory instead.

# Verifing that we have a working environment

if ! command -v 7z &>/dev/null; then
    echo Install the needed package: p7zip
    echo Fedora: sudo dnf install p7zip
    echo Debian/Ubuntu: sudo apt-get install p7zip-full
    exit 1
fi

# Asking for the ISO file
echo Insert the path to the Windows ISO file:
read -r ISO_PATH
ISO_PATH=$(realpath "$ISO_PATH") # Solving path, just because
echo

echo Extracting install.wim...
# Getting the install.wim from the ISO
if ! 7z e "$ISO_PATH" sources/install.wim &>/dev/null; then
    echo An error ocurred extracting the Windows installation file.
    exit 1
fi
echo

echo Extracting UIAutomationCore.dll...
# Get the UIAutomationCore.dll from the .wim
if ! 7z e install.wim 1/Windows/System32/UIAutomationCore.dll &>/dev/null; then
    echo An error ocurred extracting UIAutomationCore.dll from the installation file.
    exit 1
fi
echo

# Move the file where the script is called from and clean the directory
mv UIAutomationCore.dll "$DIR/UIAutomationCore.dll"
rm install.wim

echo "Done! UIAutomationCore.dll was extracted and moved to $DIR/UIAutomationCore.dll"
```

--------------------------------

### Connect to Streamer.bot via Tailscale Serve (Streamer.bot Client)

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/4.websocket/1.recipes/remote-access.md

JavaScript example for the Streamer.bot client, connecting to the Tailscale hostname on port 443 with the `wss` scheme. Requires HTTPS certificates enabled on your tailnet.

```js
const client = new StreamerbotClient({
  host: 'device.my-tailnet.ts.net',
  port: 443,
  scheme: 'wss'
});
```

--------------------------------

### Show Image Module Configuration

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/2.guide/04.extra-features/3.html-overlay.md

Configuration for the Show Image overlay module. Set the rewardTitle, imageUrl, seconds, width, and height to customize the image display.

```js
const CONFIG = {
  // The title of the Channel Point Reward that will trigger the effect
  rewardTitle: 'Show Image',

  // The URL of the image to show
  imageUrl: 'https://streamer.bot/logo.png',

  // The number of seconds to show the image for
  seconds: 5,

  // The width and height of the image (css)
  width: 'auto',
  height: 'auto',
};
```

--------------------------------

### Create a StreamerbotClient with custom options

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/4.websocket/0.guide/1.client.md

Instantiate the client with custom host, port, endpoint, and password. The password is only needed if authentication is enabled.

```ts
const client = new StreamerbotClient({
  host: '127.0.0.1',
  port: 8080,
  endpoint: '/',
  password: 'my-secret-password' // Only needed if authentication is enabled
});
```

--------------------------------

### curl GET /GetActions

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/5.http/1.requests/get-actions.md

Use curl to send a GET request to the local Streamer.bot HTTP server on port 7474.

```bash
curl -X GET http://127.0.0.1:7474/GetActions
```

--------------------------------

### Add supplemental C# method documentation with frontmatter and parameters

Source: https://github.com/streamerbot/docs/blob/main/README.md

Markdown file to add supplemental information to a C# method. The file must be placed in api/csharp/_methods and have the exact same name as the C# method. Use description for the short description above the code block, and parameters with value to populate the CPH Example code block and Copy function.

```markdown
---
description: The primary short description for SomeCsharpMethod
version: 0.2.3
parameters:
  - name: data
    description: |
      Data to be sent to connected clients

      JSON must be stringified.
    value: '"Hello, world!"'
---

Some extended description information
```

--------------------------------

### ClearNonPersistedUserGlobals C# Example

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/3.csharp/3.methods/core/globals/clear-non-persisted-user-globals.md

Use this snippet to remove all non-persisted global user variables. The example calls CPH.ClearNonPersistedUserGlobals() and returns true.

```csharp
using System;
public class CPHInline
{
    public bool Execute()
    {
        CPH.ClearNonPersistedUserGlobals();

        return true;
    }
}
```

--------------------------------

### Enable

Source: https://github.com/streamerbot/docs/blob/main/speakerbot/2.api/0.websocket/1.requests.md

Enable the TTS engine.

```APIDOC
## Enable

### Description
Enable the TTS engine if it has been disabled.

### Request
```json
{
  "id": "<id>",
  "request": "Enable"
}
```

### Parameters
- **id** (string) - Required - Request identifier.
- **request** (string) - Required - Must be `Enable`.
```

--------------------------------

### TwitchGetEmotes Example Request

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/4.websocket/3.requests.md

Example request payload for the TwitchGetEmotes request. Uses a concrete subscription id in the "id" field.

```json
{
  "request": "TwitchGetEmotes",
  "id": "my-subscribe-id"
}
```

--------------------------------

### Split Commands Example.cs

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/1.sub-actions/core/commands/get-commands.md

Splits a list of commands into batches that fit within the message length limit (495 characters for Twitch, with a safety margin). Uses the 'commandsList' argument from the Get Commands Sub-Action and sends each batch via CPH.SendAction. To send to YouTube, replace with CPH.SendYouTubeMessage.

```cs
using System;
using System.Collections.Generic;

public class CPHInline
{
    public bool Execute()
    {
        // This is when the Variable Name in the Get Commands Sub-Action is `commands`
        CPH.TryGetArg("commandsList", out List<string> commands);
        // Limit is 500 on Twitch, 200 on YouTube.. I took a few off as a safety measure.
        const int maxMessageLength = 495;
        string message = "Commands Avaliable to you: ";
        const string additionalCommandsMessage = "Addional Commands for you: ";
        const string commandSeparator = ", ";
        const bool sendFromBot = false;

        int commandsSent = 0;
        while (commandsSent < commands.Count)
        {
            int currentMessageLength = message.Length;
            bool fitsInMessage(string text) => currentMessageLength + text.Length < maxMessageLength;
            List<string> commandsForMessage = [];
            for (int i = commandsSent; i < commands.Count && fitsInMessage(commands[i]); i++)
            {
                commandsForMessage.Add(commands[i]);
                currentMessageLength += commands[i].Length + commandSeparator.Length;
            }

            message += string.Join(commandSeparator, commandsForMessage);
            // if you wish to send the message to Youtube, use CPH.SendYouTubeMessage(message, sendFromBot);
            CPH.SendAction(message, sendFromBot);
            commandsSent += commandsForMessage.Count;
            message = additionalCommandsMessage;
        }
        return true;
    }
}
```

--------------------------------

### PauseAllActionQueues C# Example

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/3.csharp/3.methods/core/action-queues/pause-all-action-queues.md

Call CPH.PauseAllActionQueues() to pause all action queues. The example is a complete CPHInline class with an Execute method that returns true.

```csharp
using System;
public class CPHInline
{
    public bool Execute()
    {
        //Pause All Action Queues
        CPH.PauseAllActionQueues();

        return true;
    }
}
```

--------------------------------

### Use preconfigured MDC callout components

Source: https://github.com/streamerbot/docs/blob/main/README.md

Preconfigured MDC components available in the documentation: note, tip, warning, read-more, and wip. Use these callout-style components to highlight informational content, tips, warnings, additional links, and work-in-progress sections.

```mdc
::note
This is some useful information to callout
::

::tip
This is a cool tip!
::

::warning
Some important info goes here
::

:read-more{to="/path/to/some/other/page"}

::wip
This content is a work in progress
::
```

--------------------------------

### Subscribe to all events with wildcard

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/4.websocket/0.guide/1.client.md

Use the '*' wildcard to listen to all events. This is not recommended for production use as it generates a lot of events.

```js
// Subscribe to *All events*
client.on('*', ({ event, data }) => {
  // Do something with all events...
  console.log(`[${event.source}.${event.type}]`, data);
});
```

--------------------------------

### Create a StreamerbotClient instance

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/4.websocket/0.guide/1.client.md

Instantiate the Streamer.bot client with default connection settings.

```ts
const client = new StreamerbotClient();
```

--------------------------------

### C# example: CPH.CommandRemoveGlobalCooldown

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/3.csharp/3.methods/core/commands/command-remove-global-cooldown.md

Removes the global cooldown for a command using its ID. The command ID is a string, and the method is called on the CPH object. The example returns true after execution.

```csharp
using System;
public class CPHInline
{
    public bool Execute()
    {
        //Define string of commandId
        string commandId = "4fcc2d13-9bcf-4c18-9d91-821a15f4b6e5";
        
        //Remove global cooldown
        CPH.CommandRemoveGlobalCooldown(commandId);
        
        return true;
    }
}
```

--------------------------------

### GetGlobalVar C# usage example

Source: https://github.com/streamerbot/docs/blob/main/streamerbot/3.api/3.csharp/3.methods/core/globals/get-global-var.md

Shows how to use CPH.GetGlobalVar<T> to fetch persisted and non-persisted global variables. The example retrieves an integer from a persisted variable and strings from both persisted and non-persisted variables.

```csharp
using System;
public class CPHInline
{
    public bool Execute()
    {
        //Examples on usage
        //Get integer number from persisted global variable
        int myInt = CPH.GetGlobalVar<int>("myInt");

        //Get string/text from persisted global variable
        string myString = CPH.GetGlobalVar<string>("myString",true);

        //Get string/text from non-persisted global variable
        string myString = CPH.GetGlobalVar<string>("myString",false);

        return true;
    }
}
```
Tokens:
Raw