Repository navigation
Projects
Michael Riddle edited this page Aug 26, 2026
·
6 revisions
The solution uses the .slnx (XML) format — open KHost.slnx; there is no .sln. Application projects live under src/, test projects under tests/, and developer CLIs under tools/.
| Project | Role |
|---|---|
KHost.Abstractions |
All interfaces and shared models. References only Plugins.Sdk. |
KHost.Domain |
Business logic and stateful singleton services: singer queue, playback, screen coordination, HLS transcoding, media import/parsing/search, venues, users, groups, tips, auth (Argon2id), lyrics, JSON file cache, queue-rotation strategies, plugin loading. Also Orthography, the spelling rules search folds text with. Uses TagLibSharp, FFMpegCore and Unidecode.NET. |
KHost.DataAccess |
EF Core 10 + SQLite persistence for the song library, users, groups, performances, and tips. See Data and Persistence. |
KHost.UserInterface |
Blazor Server app — the host console. Razor components under Components/. Hosts the IPC hub at /ipc/screen and the HLS endpoint at /media/{sessionId}/{fileName}. |
KHost.Screen2 |
Photino desktop app for karaoke video/audio output. Connects to the host hub as a SignalR client and plays the host's HLS stream. References Abstractions, Telemetry, and IPC.SignalR. |
KHost.IPC.SignalR |
SignalR host ⇄ screen IPC: ScreenHub, ScreenServerService (IScreenServer), ScreenClient (IScreenClient). Registered via AddSignalRIPCServer() + MapIPCServer() (host) and CreateScreenClient() (screen). |
KHost.Cast |
Chromecast sender built on Sharpcaster — discovery, connection, and transport for a single receiver at a time. Deliberately separate from the screen abstractions. Registered via AddCast(). |
KHost.Plugins.Sdk |
Contracts a drop-in plugin compiles against, plus the message broker every service talks through (see Messaging). No project references, so it is the layer everything else may sit on. Plugins are loaded at runtime from a plugins/ folder next to the host binary — see Plugins. |
KHost.LrcLib |
Standalone HTTP client for the LRCLIB.NET lyrics API. No project references; consumed by Domain via AddLrcLib(). |
KHost.Telemetry |
OpenTelemetry metrics and trace activities (KHostMetrics, KHostActivitySource) plus the IAnalyticsService implementation. Registered via AddTelemetry(). |
KHost.AppHost |
.NET Aspire orchestrator. Launches KHost.UserInterface as an Aspire resource with the dashboard. |
KHost.ServiceDefaults |
Shared Aspire defaults — OpenTelemetry, HTTP resilience, service discovery. Consumed via builder.AddServiceDefaults(). |
| Project | Role |
|---|---|
KHost.CatalogSync |
tools/ — CLI that adds a plugin's GitHub release to plugin-catalog.json. References Domain so it enforces the host's own payload rules rather than a copy that can drift. See Plugins. |
KHost.UnitTests |
xUnit + NSubstitute. Mirrors the src/ layout; repositories run against real in-memory SQLite. See Testing. |
KHost.IntegrationTests |
xUnit tests that drive real external tools — ffmpeg transcoding, the Chromecast emulator. Each suite guards its own presence. See Testing. |
KHost
Architecture
- Architecture
- Projects
- Screens and Casting
- Break Music and Ads
- Messaging
- Data and Persistence
- Plugins
Contributing