Download the streamer buddy app from releases.
Run the streamer buddy app on the TI4-TTPG host's computer, then go to "streamer > buddy" in the game UI (or type "!buddy" into chat) to have the mod start pushing data to buddy.
To use with OBS, start the app then load "http://localhost:8080/overlay/overlay.html" there.
On a mac: right click the application and select "open" (it is not signed by a trusted authority, double clicking the app with the normal security settings prevents you from starting it).
Buddy loads an overlay hosted online, the overlay can be updated without needing a new version of the streamer buddy app. It is possible future features could require downloading a new version (most likely adding new image assets), but those major changes should be rare.
The app runs a local webserver on ports 8080 and 8081, it does not need access to access to the filesystem beyond loading the app itself.
Github actions build the app for Mac/Windows when the tag changes. Update the tag via:
Package.json version does not have a v, but tag does!
- edit version in package.json (MUST BE "#.#.#")
- git commit -am v#.#.#
- git tag v#.#.#
- git push
- git push --tags