diff options
| author | yum <yum.food.vr@gmail.com> | 2025-10-14 17:20:37 -0700 |
|---|---|---|
| committer | yum <yum.food.vr@gmail.com> | 2025-10-28 17:19:36 -0700 |
| commit | fdccac50e6740872ac5a6de881f39d660ced0c83 (patch) | |
| tree | e9b08a6127b99232451af853dc6bf8692dce83e8 | |
| parent | 8222717b7e12101cbc1945107b20f5258618d56e (diff) | |
begin readme overhaul
| -rw-r--r-- | README.md | 35 |
1 files changed, 33 insertions, 2 deletions
@@ -1,8 +1,39 @@ Shitty service to proxy data from OBS into an HTTP Live Streaming (HLS) feed VRChat understands. -## Usage +## Streamer instructions + +1. Configure OBS with a custom server pointing at `rtmp://<your-domain>/live` + and in the stream server. Enter your stream key. +2. Press stream. Check status on bottom right of obs. + +## Dev instructions + +1. Get ssh perms to yummers.dev. +2. Run ./push.sh +3. Add this to your .bashrc: +```bash +function check_live { + ssh yummers.dev 'sudo systemctl status obsproxy' +} +function start_live { + ssh yummers.dev 'sudo systemctl start obsproxy' +} +function stop_live { + ssh yummers.dev 'sudo systemctl stop obsproxy' +} +function reset_live { + ssh yummers.dev 'sudo systemctl restart obsproxy' + get_live_logs +} +function get_live { + live_url=$(ssh yummers.dev "journalctl -u obsproxy -n 10000 | grep 'HLS:' | awk '{print \$NF}'" | tail -n 1) + echo $live_url | clip.exe + echo "Copied to clipboard: $live_url" +} +``` +... and source it with `source ~/.bashrc`. +4. -1. Configure OBS with a custom server pointing at `rtmp://<your-domain>/live` and the pre-shared key stored in `STREAM_PSK`. 2. Install runtime dependencies: `pip install -r opt/obsproxy/requirements.txt`. 3. Start the Python service (see `etc/systemd/system/obsproxy.service` for a sample unit). The bundled entrypoint now runs under [Waitress](https://docs.pylonsproject.org/projects/waitress/en/stable/) so you get a production-grade WSGI server out of the box. 4. When the service starts it prints a session-specific playlist URL like `https://<your-domain>/hls/<session-hex>/stream.m3u8`; share that exact URL with your VRChat video player. Multiple viewers can consume the feed concurrently. |
