Rolfsvaag_Datateknikk/Lumi
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 22 Wiki Activity
37dda538b3
Lumi/companion
History
Franz Rolfsvaag 27555e258e Integrate Companion into Lumi admin
2026-07-22 14:18:20 +02:00
..
docs Add experimental Companion and OBS bridge boundaries 2026-07-22 11:02:04 +02:00
native/obs-bridge Add experimental Companion and OBS bridge boundaries 2026-07-22 11:02:04 +02:00
plugins/Lumi.Companion.Transcription Build Lumi Companion shell and whisper worker 2026-07-22 11:39:05 +02:00
src Integrate Companion into Lumi admin 2026-07-22 14:18:20 +02:00
Lumi.Companion.sln Build Lumi Companion shell and whisper worker 2026-07-22 11:39:05 +02:00
README.md Integrate Companion into Lumi admin 2026-07-22 14:18:20 +02:00

README.md

Lumi Companion (experimental transcription milestone)

This directory is the single Lumi Companion product boundary. The current milestone supplies the versioned protocol client, Windows credential protection, bounded outbound transport, plugin-process supervision, same-user OBS bridge IPC boundary, and an Avalonia tray shell. The shell is single-instance, closes to the tray, confirms quit during OBS streaming/recording, supports explicit pairing, and reports real setup/test blockers without presenting simulated success.

Build prerequisites: the current .NET SDK with the .NET 8 targeting pack on Windows x64. The app targets .NET 8; .NET SDK 10 is recommended for Avalonia 12 source-generator compatibility. The native bridge additionally requires CMake, Visual Studio C++ tools, and the OBS 31+ SDK.

The app accepts a .lumi-pairing.json bootstrap package. A paired ZIP downloaded from Lumi includes one beside the executable; the app detects it automatically, exchanges the embedded token once, stores the returned device credential with Windows DPAPI, and removes the pairing file after success. Do not commit bootstrap packages, credentials, generated installers, build output, or logs.

The companion never performs ASR in this MVP. Audio is normalized to 16 kHz mono signed 16-bit PCM, held in bounded memory, and sent to the paired Lumi host over TLS WebSockets. HTTP/WS works only for a package generated from the exact matching loopback Lumi origin. The OBS bridge talks only to the companion over a same-user named pipe.

Build all managed projects from the repository root:

dotnet build companion/Lumi.Companion.sln -p:EnableWindowsTargeting=true

The signed installer, managed OBS bridge installation/repair service, and a target-machine OBS/Twitch acceptance run are still required. Until those pass, the UI deliberately stops its test at the unavailable real boundary.

The Admin Download Companion action currently distributes a checksum-pinned, self-contained Windows x64 ZIP. It is intentionally marked experimental and is not code-signed yet.