https://github.com/djlotus/pocket-billiards-score-keeper-overlay-and-control-panel
https://github.com/djlotus/pocket-billiards-score-keeper-overlay-and-control-panel
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/djlotus/pocket-billiards-score-keeper-overlay-and-control-panel
- Owner: djlotus
- License: gpl-3.0
- Created: 2024-02-18T04:09:50.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-01-14T15:45:12.000Z (4 months ago)
- Last Synced: 2025-01-14T17:12:42.968Z (4 months ago)
- Language: HTML
- Size: 10.5 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
# Pocket Billiards Score Keeper Overlay
## Introduction
Pocket Billiards Score Keeper Overlay; designed to enhance your streaming experience when broadcasting billiards matches. This overlay provides a streamlined, easy-to-use interface for scoring, allowing you to focus on the game while keeping your audience engaged.
Having an easy-to-use and easy-to-install control panel is essential for streamers. It simplifies the process of managing the overlay during a live stream, enabling you to update scores, display player names, and track game progress with just a few clicks. This simplicity not only enhances the viewer experience but also reduces the likelihood of errors, ensuring that your stream remains professional and engaging.
## Features
- Easy to use control panel.
- Built-in country flag generator.
- Scoring options for 8-Ball, 9-Ball, 10-Ball, Straight Pool, and One Pocket.
- One click updating of match information.
- Low profile.
## TODO
- [ ] Handle cases where HTML validation is not working and we receive bad data
- [ ] Add visual representation of balls made/left
- [ ] Shot clock
- [ ] Save game (to text file, db in the future)
- [ ] Snapshot (capture game state to importable file)
- [x] Simple mode (names, race, and score)
- [x] Create prompt for generating URLs
- [ ] Reload match (from exisitng localStorage)
## Usage
### OBS Studio
#### Getting Ready
- Run `generateURLS.bat` by simply left clicking.
- Follow the prompts to generate a `links.txt` file.
- Open this file for use configuring your custom dock and browser source.
#### Browser Source
**Add a New Browser Source**
- In the OBS Studio main window, right-click in the "Sources" box.
- Select "Add" > "Browser."
**Name Your Source**
Enter a name for your source (e.g., "Score Board").
**Configure the Browser Source**
- In the properties window for the Browser source, you'll see several settings:
- Local File: **Leave un-checked**
- URL: Enter the path to your local file path URI. (example: "file:///c:/{path/to/file}/scoreboard-top.html")
- Copy from `links.txt`
- Width and Height: Set the dimensions of your dock. You can adjust these later if needed.
- We recommend either 1920x1080 or 1225x90.
- Custom CSS: If your file includes CSS styles, you can enter them here.
**Position Your Dock**
- In the main OBS Studio window, click and drag overlay to position it.
- Use the arrow keys on your keyboard for precise positioning.
#### Custom Dock
**Define a New Custom Dock**
- In the OBS Studio main window, click the "Docks" menu item.
- Select "Custom Browser Docks...".
- In the pop-out window define your custom dock.
- Dock Name: Enter a name for your custom dock.
- URL: Enter the path to your local file path URI. (example: "file:///c:/{path/to/file}/control-panel.html")
- Copy from `links.txt`
**Add Your New Custom Dock**
- In the OBS Studio main window, click the "Docks" menu item.
- Select your custom dock from the list at the bottom of the tab.
### Stream Labs
**_Coming Soon..._**
## License
This project is licensed under the GNU General Public License V3 or later - see the [LICENSE](https://www.gnu.org/licenses/lgpl.html) file for details.
[](LICENSE)
## Acknowledgements
**_Coming Soon_**
## Contributing
**_Coming Soon_**
## Support
**_Coming Soon_**