v0.1.0-alpha.1
Pre-release
Pre-release
·
8 commits
to main
since this release
Alpha release — Windows x64
Reads the OpenKJ SQLite database and serves a live karaoke rotation ticker as a local web page for use in OBS Browser Source. No changes to OpenKJ required.
Quick start
- Download
openkj-ticker.exebelow. - Run it — it will auto-discover your OpenKJ data directory and create
openkj-ticker.tomlin the same folder. - Add a Browser Source in OBS pointing to
http://localhost:8080/ticker. - Open
http://localhost:8080/in a browser for the full rotation dashboard.
If auto-discovery fails
Edit openkj-ticker.toml and set:
data_dir = "C:\\Users\\YourName\\AppData\\Roaming\\OpenKJ2"CLI options
openkj-ticker.exe --help
openkj-ticker.exe --port 9090
openkj-ticker.exe --data-dir "C:\path\to\OpenKJ2"
openkj-ticker.exe --singer-count 10
JSON API
GET http://localhost:8080/api/state — returns current singer, next up, and full rotation as JSON. Accessible from other machines on your network using the machine's IP address.
Platform: Windows x64
SQLite: bundled (no external dependencies)