A remote scoreboard streaming tool, especially designed for PvP matches with scoring (ie fighting games). It allows modifying text files linked to overlays from a local or remote PC, via a nodejs service, which serves both the site and the api. OBS integration: it can connect to an OBS via obs-websocket plugin (https://github.com/Palakis/obs-websocket) to receive a list of available scenes, displaying them as buttons and allow selecting them from the app. Challonge integration: it can connect to Challonge with username / api key, and fetch player names from a tournament, for easier selection. The site is built using React and Bulma and is 100% responsive, so you can control your streaming with a phone or tablet too, similar to a Stream Deck.
TLDR; control your streaming remotely from another PC/tablet/phone, modify names, score, stage, messages, plus select current streaming scene (OBS only) and fetch player names from a Challonge tournament.
If you want to just use it, download an already packed release (currently 0.1.2), do 'npm install' then 'npm run start'. Open a browser and point to the machine where this is running, ie http://192.168.1.50:3000/index.html (or localhost if same PC).
You can edit a few options via a cfg.ini file
verbose=true # either you want some more log verbosity
apiPort=3000 # if you want a different port from the default 3000
dataPath=c:/obs_overlays # where the streaming files will be saved
obsHost=localhost:4444 # if you want to connect to your OBS
obsPassword=password # if your OBS is protected by a password, this is it
challongeUsername=user # if you want to connect to Challonge
challongeApiKey=password # apiKey for your Challonge user
These are the file names that will be saved in the dataPath folder
p1name.txt # Player 1 name
p2name.txt # Player 2 name
p1score.txt # score for Player 1
p2score.txt # score for Player 2
stage.txt # stage (Pools, Winners, Losers, Casuals, etc)
message.txt # additional message, usually while in rest mode, or to send some advice, can accomodate longer text
- Add security to prevent anyone else from connecting if they are in the same network
- Receive contents of all streaming fields at login time, and fill the client properly
