Overview
This is an overlay designed for cue sports, in particular pool where there are rack based results, however the overlay could be used for darts or any other competitive game with simple scoring.If you would like to donate for my efforts and your usage, it would be appreciated, but not necessary:
Donate and Support
The overlay includes:
- The ability to define two players, and associate a color gradient background with their name
- Optional shot clock and extensions UI components
- Player logos
- Sponsor/Image slideshow, supporting up to 3 images
- Player indicator (to show who is at the table, or who's currently playing)
- Player ball indicator (to show who is playing what balls)
- Win animations for various game types (based on game type selection)
- Included ball tracker for various game types (including international and world balls)
- Ability for multiple table/instance tracking
- Replay display
Multiple Instances:
To modify the overlay the user will leverage a local browser interface in OBS for control (one for each instance).
Control support:
- Overlay display sizes (small, medium, large)
- Control panel theme options (match OBS themes)
- Enabling/Disabling Players/Teams
- Player/Team Scoring
- Player/Team color choices
- Player logo support (with custom naming capability)
- Enabling/Disabling Shot Clock
- Clock and Extension controls and display
- Displaying additional Game and Info panel
- Custom/Sponsor logo slideshow
- Player indicator toggle
- Player ball indicator toggle
- Tabbed sections
- Select cue-ball game type
- Enable/Disable win animations
- Ball tracker enable/disable (supporting international and world ball styling
- Game monitoring with Replay control and Clip History
Installation Guide
Extract the downloaded zip file to the directory of your choosing e.g. home/username/obs-plugins, just make sure you know where to find it again.- Click on the Docks Menu from the top menu bar of OBS and select "Custom Browser Docks".
- Type a name (CueSport-Scoreboard) in the "Dock Name" box, and input the full path to "control_panel.html" in the URL box e.g., c:\users\yourname\desktop\Cuesport-Scoreboard\control_panel.html.
This forms the control panel for the overlay that will be implemented later, as a browser under sources.
- (Optional) If you are going to use multiple instances in a single stream make sure to add a query at the end of the URL e.g., ?instance=table1 (as seen in the image below, only needed when using multiple instances)
Click "Close"
- Select the scene you want the scoreboard to display and add a "Browser Source" -> "Create New" -> give it a name. click OK.
- Input the full path to "browser_source.html" in the URL box e.g., c:\users\yourname\obs-plugins\Cuesport-Scoreboard\browser_source.html"). Again, if using multiple instances, add ?instance=game4 at he end of the URL definition (as seen in the image)
Set Width to 1920 and Height to 1080.
Click OK.
- You now have a control panel and associated browser overlay, or multiple if you choose to use instances.
- In the event you need to clear the locally stored data, utilize the reset data button for an instance or all instances.
Additional Feature Notes
Ability to reposition elements within the space: scoreboard, logo slideshow, and game information. Select source, choose interact, and move to your desired location. Refresh page or change size to return to default locations.
Ability to use custom win animations, specific to cue-ball games (8,9, and 10-ball, default is 8-ball).
Tabbed sections of the control panel to save on UI real-estate.
Ball tracker that displays appropriate balls based on game type chosen, and allows for vertical or horizontal display (including International and American style pool balls)
See release notes (v3.0.0) for configuring Replay settings.
