Mimir/README.md
2026-05-18 10:56:01 +01:00

63 lines
2.5 KiB
Markdown

# LocalCastBridge
LocalCastBridge turns a Windows gaming/desktop PC into LAN sources for another machine's OBS scene.
V1 does not fork OBS. OBS already accepts SRT Media Sources, and FFmpeg can capture Windows desktop/audio while encoding video with `h264_nvenc`. The sane first machine is:
```mermaid
flowchart LR
A["Husband's PC"] --> B["FFmpeg capture scripts"]
B --> C["NVENC H.264 video over SRT"]
B --> D["Opus audio source 1 over SRT"]
B --> E["Opus audio source 2 over SRT"]
C --> F["OBS Media Source: video"]
D --> G["OBS Media Source: audio source 1"]
E --> H["OBS Media Source: audio source 2"]
```
The video stream is encoded on the sender. Audio sources are separate endpoints so OBS can mix, mute, filter, and monitor them independently.
## Current Status
This repo is the first coherent scaffold: architecture docs, persistence machinery, and Windows scripts for device discovery, config validation, and FFmpeg command generation. It is ready for a real two-PC smoke test once FFmpeg with SRT/NVENC support is installed on the sender.
## Quick Start
1. Install OBS on the receiver.
2. Install FFmpeg on the sender, with `srt` protocol and `h264_nvenc` encoder enabled.
3. Copy `config/localcast.example.json` to `config/localcast.json`.
4. On the sender, list capture devices:
```powershell
.\scripts\sender-discover.ps1
```
5. Edit `config/localcast.json` with the receiver IP and chosen DirectShow audio device names.
6. Dry-run the generated FFmpeg commands:
```powershell
.\scripts\sender-start.ps1 -Config .\config\localcast.json -DryRun
```
7. Start the sender:
```powershell
.\scripts\sender-start.ps1 -Config .\config\localcast.json
```
8. In OBS on the receiver, add one Media Source per URL from `docs/obs-receiver-setup.md`.
## Why SRT Media Sources First
OBS documents SRT playback through VLC Source or Media Source, and Media Source can listen on `srt://0.0.0.0:PORT?mode=listener&timeout=5000000` with `mpegts` input format. FFmpeg also documents SRT protocol support and Windows capture devices through `dshow`/`gdigrab`. That gives us a standard, inspectable path before native OBS code starts making expensive promises.
## Repo State
Rehydrate with the bundled Python from this Codex workstation, or any normal Python 3:
```powershell
& 'C:\Users\Meta\.cache\codex-runtimes\codex-primary-runtime\dependencies\python\python.exe' .\tools\localcast_state.py status
Get-Content .\state\map.yaml
Get-Content .\notes\fresh-workspace-handoff.md
Get-Content .\notes\current-system-map.md
```