add README

This commit is contained in:
Jeeves 2025-02-18 22:13:46 -07:00
parent a0ae1b422d
commit 364578bd7e

15
README.md Normal file
View file

@ -0,0 +1,15 @@
# Streamboy!
Jeeves' personal streaming toolkit.
{insert stereotypical message of This Is A Mess Not Designed For Others} so Good Luck Have Fun :)
# Usage
0. (Nix only) Run `nix develop`
1. Run VLC with `vlc --extraintf http --http-host localhost --http-password 1234`
2. Run OBS Studio
3. Create a browser source with a height of 19, width that is a multiple of 8, and point it to `http://localhost:8012/statusline`
4. Run Streamboy with `deno run dev`
Topic is hardcoded for now, but the song info will automatically update with VLC.