Skip to content

Latest commit

 

History

History
42 lines (29 loc) · 1.21 KB

README.md

File metadata and controls

42 lines (29 loc) · 1.21 KB
Raw

Custom HUD Example

This is an example demonstrating the real-time capabilities of slp-realtime and its ability to detect when player percentages change or stock count changes.

This script monitors a specific folder which has new SLP files being written to and when percents change or stocks change, writes that data to a file to be rendered in OBS.

How to use

  1. Clone the repo, install the dependencies, and build the library to be used by the example.
git clone https://github.com/vinceau/slp-realtime
cd slp-realtime
yarn install
yarn run build
  1. Prepare the example by changing directory into the example folder and installing the dependencies.
cd examples/custom-hud
yarn install
  1. Set the SLP folder folder location

Open up the index.js file in your favourite editor, and modify the value for slpLiveFolderPath appropriately. This should be the folder that Slippi Dolphin writes new SLP files to. You may want to also change the playerInfoFolder variable.

  1. Add those files to OBS

By default files are written to the desktop as player1Stocks.txt and player1Percent.txt. You should add these files to OBS as a text source.

  1. Run the actual code
node index.js