/HDR-Stream-Tool

HDR overlay and control panel for tournament streams

Primary LanguageJavaScriptMIT LicenseMIT

HDR Stream Tool

So you want to do an HDR stream, huh? Well, today is your lucky day, because Readek, ilikepizza107, and I have done tons of work so you don’t have to! With this tool, you will be able to set up an HDR tournament stream in no time.


Features

  • Easy and fast setup using a browser source. Drag and drop!
  • Handy interface to quickly change everything you need, like player names, pronouns, characters, scores, round, casters...
    • With customizable Player and Commentator Presets to setup your match in no time!
  • Every single character and skin the game has to offer is supported.
  • A "VS Screen" to be displayed when waiting for the next game.
  • A Bracket View to showcase your tournament's top 8 positions!
  • A Remote GUI that can be accessed by any device within the local network, including mobile devices!
  • Now with 2v2 support!
  • Made to be customized! Add Brawl Vault characters, custom overlays or even dive into the code if you're brave enough!

How to setup

These are instructions for OBS Studio:

  • Get the latest release.
  • Extract somewhere.
  • Drag and drop 16.9 Scoreboard.html into OBS, or add a new browser source in OBS pointing at the local file.
    • If the source looks weird, manually set the source's properties to 1920 width and 1080 height, or set your OBS canvas resolution to 1080p, or make the source fit the screen (Ctrl+F).
  • In the source's properties, change Use custom frame rate -> 60 (if streaming at 60fps of course).
  • Manage it all with the HDR Stream Tool executable (or hdr-st-gui.app if you are on Mac).

Repeat from the 3rd step to add the VS Screen.html and Bracket.html views, though I recommend you to do so on another scene.

Interface shortcuts!

  • Press Enter to update*.
  • Press either F1 or F2 to increase P1's or P2's score.
  • Press ESC to clear player info*.

*Functionality may change in some menus to ease workflow.

For developing, there are some shortcuts to make things easier:

  • Press F5 to reload the GUI.
  • Press F12 to open the dev console. This will also unlock window resolution.

Advanced setup

Yes, those instructions above are enough, but we can do better. All of this is optional of course.

2 basic transitions are included in the Resources/OBS Transitions folder, intended to be used to change to the game scene and to the VS screen, if you don't have a transition yourself of course. To use them on OBS:

  • Add a new stinger transition.
  • Set the video file to Game In.webm if creating the game scene transition, and Swoosh.webm if creating a VS screen transition.
  • Transition point -> 350 ms.
  • I recommend you to set the Audio Fade Style to crossfade, just in case.
  • On the scene's right click menu, set it to Transition Override to the transition you just created.
  • Also, you may want to set a hotkey to transition to the game scene so you can press enter ingame to start the replay and press the transition key at the same time. The transition is timed to do so.

Remote GUI

The Stream Tool GUI can be controlled remotely by any device within the local network where the GUI is running, and yes, this includes mobile devices! Please take a look at Readek's wiki for instructions.


Other stuff...

Do you want to customize something? Do you need some OBS tips and tricks for an HDR stream? Please, go to Readek's wiki!