70 lines
2.3 KiB
Plaintext
70 lines
2.3 KiB
Plaintext
Blackout Bingo OBS Overlay Prototype
|
|
|
|
Local Windows run:
|
|
|
|
1. Extract the bingo-overlay folder.
|
|
2. Double-click start-bingo.bat.
|
|
3. Open the editor:
|
|
http://localhost:8780/editor.html
|
|
4. Add up to 100 tasks, one per line.
|
|
5. Click Save Tasks.
|
|
6. Click Generate Board to randomly pick 25 unique tasks for the 5x5 card.
|
|
7. Add this OBS Browser Source:
|
|
http://localhost:8780/overlay.html
|
|
|
|
Recommended OBS Browser Source size:
|
|
|
|
Width: 1000
|
|
Height: 900
|
|
|
|
Server/Docker run:
|
|
|
|
This overlay can also run on a server, Docker host, or Dell20.
|
|
|
|
1. Copy the bingo-overlay folder to the Docker host.
|
|
2. From inside the folder, run:
|
|
docker compose up -d --build
|
|
3. Open the editor from another machine:
|
|
http://SERVER-IP:8780/editor.html
|
|
4. Add this OBS Browser Source on the streaming PC:
|
|
http://SERVER-IP:8780/overlay.html
|
|
|
|
For Dell20, replace SERVER-IP with Dell20's LAN IP or hostname. If Dell20 resolves on your network, this will usually be one of:
|
|
|
|
http://obin-core.wheelz.lab:8780/overlay.html
|
|
http://192.168.20.123:8780/overlay.html
|
|
|
|
Docker persistence:
|
|
|
|
- docker-compose.yml stores the saved bingo state under:
|
|
./data/bingo.json
|
|
- This keeps the board and task list through container restarts/rebuilds.
|
|
- To reset everything manually, stop the stack and remove data/bingo.json, then start it again.
|
|
|
|
How completion works:
|
|
|
|
- This is a blackout bingo card.
|
|
- Each square can be marked by Player 1, Player 2, or both.
|
|
- Player names are editable at the top of editor.html.
|
|
- Blue mark = Player 1.
|
|
- Pink mark = Player 2.
|
|
- Gold/mixed highlight = both players completed that square.
|
|
|
|
Files:
|
|
|
|
server.py Save/API server
|
|
editor.html Task entry, board generation, and completion controls
|
|
overlay.html OBS overlay view
|
|
bingo.json Default/single-machine saved task pool, player names, and current board
|
|
start-bingo.bat Windows launcher
|
|
Dockerfile Container image definition
|
|
docker-compose.yml Docker deployment on a server
|
|
|
|
Notes:
|
|
|
|
- If running locally with the BAT file, keep the start-bingo.bat window open while streaming.
|
|
- If running with Docker, the container keeps running in the background until stopped.
|
|
- Generate Board clears completion marks because it creates a new card.
|
|
- Save Tasks preserves the current board and marks.
|
|
- The overlay auto-refreshes about every 1.5 seconds.
|