streamer-tools-client

A Client for the Streamer tools Beat Saber mod

Installation

Downloading the client

Windows

1. Get the latest binaries from Releases
2. Extract the zip file
3. Run the exe and you should be set up

Mac, Windows and Linux

1. Download the quest mod from The streamer tools repo and upload it to BMBF.
2. Install Node.js
3. Download all files from this repo, unzip them and run install.bat
4. To run the client simply start start.bat

Setting up the client

After starting the client simply put in your Quests ip and hit save. Then you can download overlays from the download section and see them in the overlays section.

Adding overlays to obs

In your scene add a browser and as URL set the one you copied from the overlays section in the client

Documentation

Getting data from the quest through the client

The client starts a web server on your PC and starts to fetch from your Quest right away. You can access the latest data from localhost:53510/api/raw

Setting the config

Send a post request with a json of the values to set to localhost:53510/api/postconfig. e. g.

{
  "ip": "192.168.2.1"
}

Getting the config

localhost:53510/api/getconfig will give you the config back in a json format. e. g.

{
    "ip": "192.168.137.224",
    "interval": "100",
    "overlays": [
        {
            "Name": "Original_Overlay",
            "downloaded": false,
            "downloads": [
                {
                    "URL": "https://computerelite.github.io/tools/Streamer_Tools_Quest_Overlay/Overlay1.html",
                    "Path": "tools/Streamer_Tools_Quest_Overlay/Overlay2.html",
                    "IsEntryPoint": true
                },
                {
                    "URL": "https://computerelite.github.io/css/standard.css",
                    "Path": "css/standard.css",
                    "IsEntryPoint": false
                },
                {
                    "URL": "https://computerelite.github.io/tools/Streamer_Tools_Quest_Overlay/pulling.js",
                    "Path": "tools/Streamer_Tools_Quest_Overlay/pulling.js",
                    "IsEntryPoint": false
                },
                {
                    "URL": "https://computerelite.github.io/tools/Streamer_Tools_Quest_Overlay/default.png",
                    "Path": "tools/Streamer_Tools_Quest_Overlay/default.png",
                    "IsEntryPoint": false
                }
            ]
        }
    ],
    "dcrpe": false,
    "twitch": {
        "enabled": true,
        "token": "************",
        "channelname": "computerelite_dev"
    }
}

Getting installed overlays

localhost:53510/api/overlays will return an array of overlays (contains names, download urls and more) which will look like this:

[
        {
            "Name": "Original_Overlay",
            "downloaded": true,
            "downloads": [
                {
                    "URL": "https://computerelite.github.io/tools/Streamer_Tools_Quest_Overlay/Overlay1.html",
                    "Path": "tools/Streamer_Tools_Quest_Overlay/Overlay2.html",
                    "IsEntryPoint": true
                },
                {
                    "URL": "https://computerelite.github.io/css/standard.css",
                    "Path": "css/standard.css",
                    "IsEntryPoint": false
                },
                {
                    "URL": "https://computerelite.github.io/tools/Streamer_Tools_Quest_Overlay/pulling.js",
                    "Path": "tools/Streamer_Tools_Quest_Overlay/pulling.js",
                    "IsEntryPoint": false
                },
                {
                    "URL": "https://computerelite.github.io/tools/Streamer_Tools_Quest_Overlay/default.png",
                    "Path": "tools/Streamer_Tools_Quest_Overlay/default.png",
                    "IsEntryPoint": false
                }
            ]
        }
    ]

Getting a specific overlay

localhost:53510/api/getOverlay?name=[OverlayName] will redirect you to the Overlay you specified if it exists.

Downloading an overlay

Make a post request to localhost:53510/api/download with a json. e. g.

{
  "Name": "Original_Overlay"
}