# mlopezsegura/openstreamms architecture

> Architecture diagram of the GitHub repository mlopezsegura/openstreamms, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/mlopezsegura/openstreamms
- Repository: https://github.com/mlopezsegura/openstreamms

## Overview

OpenStreamMS turns one Windows PC into isolated game-streaming sessions and configurable local seats, managed through a web dashboard, REST API, or tray app. The main flow is a user request entering the service API, which manages session creation and lifecycle, then launches the streaming stack; a separate seat workflow assigns local devices and displays. The README also describes composites, extensions, metrics, and experimental RemoteIdd support. Some subsystem links rely on README or source-index references; unsampled implementation details are not inferred.

Main entry points: [`Core/Api/StreamSessionService.cs`](https://github.com/mlopezsegura/openstreamms/blob/master/Core/Api/StreamSessionService.cs) (Session lifecycle), [`Services/Seats/SeatManager.cs`](https://github.com/mlopezsegura/openstreamms/blob/master/Services/Seats/SeatManager.cs) (Seat management), [`Core/Api/SessionEndpoints.cs`](https://github.com/mlopezsegura/openstreamms/blob/master/Core/Api/SessionEndpoints.cs) (REST endpoints), [`Program.cs`](https://github.com/mlopezsegura/openstreamms/blob/master/Program.cs) (Service entry point)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_management["Management"]
  node_dashboard["Web dashboard<br/>[app.js]"]
  node_service["Service entry point<br/>[Program.cs]"]
  node_api["REST endpoints"]
  node_auth["Authentication<br/>[AuthService.cs]"]
  node_tray["Tray controls<br/>[TrayApp.cs]"]
end

subgraph group_sessions["Streaming sessions"]
  node_session["Session lifecycle"]
  node_sessionmodel["Stream session<br/>[StreamSession.cs]"]
  node_composite["Composite sessions"]
  node_rdp["RDP session setup"]
  node_users["Isolated users"]
  node_sunshine["Sunshine manager<br/>[SunshineManager.cs]"]
  node_ports["Stream ports<br/>[SunshinePorts.cs]"]
end

subgraph group_seats["Local seats"]
  node_seats["Seat management<br/>[SeatManager.cs]"]
  node_seatmodel["Seat model<br/>[Seat.cs]"]
  node_seathost["Seat host<br/>[SeatHost.cs]"]
  node_gamepads["Gamepad isolation"]
end

subgraph group_platform["Platform services"]
  node_config["Service configuration<br/>[ServiceConfig.cs]"]
  node_metrics["System metrics<br/>[SystemMetrics.cs]"]
  node_localization["Backend localization<br/>[BackendText.cs]"]
end

subgraph group_integrations["Extensions and drivers"]
  node_extensions["Extension manager"]
  node_remoteidd["RemoteIdd driver<br/>[Driver.cpp]"]
end

node_user(("User"))

node_user -->|"uses"| node_dashboard
node_user -->|"controls"| node_tray
node_dashboard -->|"calls API"| node_api
node_service -->|"maps routes"| node_api
node_service -->|"registers service"| node_session
node_service -->|"registers service"| node_seats
node_api -.->|"authenticates"| node_auth
node_api -.->|"manages sessions"| node_session
node_api -.->|"manages seats"| node_seats
node_session -->|"manages"| node_sessionmodel
node_session -->|"creates RDP"| node_rdp
node_session -->|"manages accounts"| node_users
node_session -->|"starts streaming"| node_sunshine
node_session -->|"allocates ports"| node_ports
node_session -.->|"fires hooks"| node_extensions
node_composite -->|"composes sessions"| node_session
node_sessionmodel -->|"uses ports"| node_ports
node_session -->|"reads settings"| node_config
node_seats -->|"stores seats"| node_seatmodel
node_seats -->|"checks assignment"| node_session
node_seats -.->|"starts host"| node_seathost
node_gamepads -->|"routes controllers"| node_session
node_gamepads -->|"checks seat state"| node_seats
node_sunshine -.->|"uses components"| node_extensions
node_service -->|"maps metrics"| node_metrics
node_session -->|"provides session data"| node_metrics
node_remoteidd -.->|"supplies frames"| node_sunshine
node_session -.->|"formats messages"| node_localization

click node_dashboard "https://github.com/mlopezsegura/openstreamms/blob/master/Core/wwwroot/app.js"
click node_service "https://github.com/mlopezsegura/openstreamms/blob/master/Program.cs"
click node_api "https://github.com/mlopezsegura/openstreamms/blob/master/Core/Api/SessionEndpoints.cs"
click node_auth "https://github.com/mlopezsegura/openstreamms/blob/master/Core/Api/AuthService.cs"
click node_tray "https://github.com/mlopezsegura/openstreamms/blob/master/Services/TrayApp/TrayApp.cs"
click node_config "https://github.com/mlopezsegura/openstreamms/blob/master/Core/Helpers/ServiceConfig.cs"
click node_session "https://github.com/mlopezsegura/openstreamms/blob/master/Core/Api/StreamSessionService.cs"
click node_sessionmodel "https://github.com/mlopezsegura/openstreamms/blob/master/Core/Api/StreamSession.cs"
click node_composite "https://github.com/mlopezsegura/openstreamms/blob/master/Core/Api/StreamSessionService.Composite.cs"
click node_rdp "https://github.com/mlopezsegura/openstreamms/blob/master/Core/Helpers/RdpSessionCreator.cs"
click node_users "https://github.com/mlopezsegura/openstreamms/blob/master/Core/Helpers/IsolatedUserManager.cs"
click node_sunshine "https://github.com/mlopezsegura/openstreamms/blob/master/Services/Sunshine/SunshineManager.cs"
click node_ports "https://github.com/mlopezsegura/openstreamms/blob/master/Core/Api/SunshinePorts.cs"
click node_seats "https://github.com/mlopezsegura/openstreamms/blob/master/Services/Seats/SeatManager.cs"
click node_seatmodel "https://github.com/mlopezsegura/openstreamms/blob/master/Services/Seats/Seat.cs"
click node_seathost "https://github.com/mlopezsegura/openstreamms/blob/master/Services/Seats/SeatHost.cs"
click node_gamepads "https://github.com/mlopezsegura/openstreamms/blob/master/Services/Gamepad/GamepadSessionIsolation.cs"
click node_extensions "https://github.com/mlopezsegura/openstreamms/blob/master/Services/Extensions/ExtensionManager.cs"
click node_metrics "https://github.com/mlopezsegura/openstreamms/blob/master/Services/Metrics/SystemMetrics.cs"
click node_remoteidd "https://github.com/mlopezsegura/openstreamms/blob/master/Native/RemoteIdd/Driver.cpp"
click node_localization "https://github.com/mlopezsegura/openstreamms/blob/master/Services/Localization/BackendText.cs"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_dashboard,node_service,node_api,node_auth,node_tray,node_user toneBlue
class node_session,node_sessionmodel,node_composite,node_rdp,node_users,node_sunshine,node_ports toneAmber
class node_seats,node_seatmodel,node_seathost,node_gamepads toneMint
class node_config,node_metrics,node_localization toneRose
class node_extensions,node_remoteidd toneIndigo
```

## Components

### Management

- [Web dashboard](https://github.com/mlopezsegura/openstreamms/blob/master/Core/wwwroot/app.js): `Core/wwwroot/app.js`
- [Service entry point](https://github.com/mlopezsegura/openstreamms/blob/master/Program.cs): `Program.cs`
- [REST endpoints](https://github.com/mlopezsegura/openstreamms/blob/master/Core/Api/SessionEndpoints.cs): `Core/Api/SessionEndpoints.cs`
- [Authentication](https://github.com/mlopezsegura/openstreamms/blob/master/Core/Api/AuthService.cs): `Core/Api/AuthService.cs`
- [Tray controls](https://github.com/mlopezsegura/openstreamms/blob/master/Services/TrayApp/TrayApp.cs): `Services/TrayApp/TrayApp.cs`

### Streaming sessions

- [Session lifecycle](https://github.com/mlopezsegura/openstreamms/blob/master/Core/Api/StreamSessionService.cs): `Core/Api/StreamSessionService.cs`
- [Stream session](https://github.com/mlopezsegura/openstreamms/blob/master/Core/Api/StreamSession.cs): `Core/Api/StreamSession.cs`
- [Composite sessions](https://github.com/mlopezsegura/openstreamms/blob/master/Core/Api/StreamSessionService.Composite.cs): `Core/Api/StreamSessionService.Composite.cs`
- [RDP session setup](https://github.com/mlopezsegura/openstreamms/blob/master/Core/Helpers/RdpSessionCreator.cs): `Core/Helpers/RdpSessionCreator.cs`
- [Isolated users](https://github.com/mlopezsegura/openstreamms/blob/master/Core/Helpers/IsolatedUserManager.cs): `Core/Helpers/IsolatedUserManager.cs`
- [Sunshine manager](https://github.com/mlopezsegura/openstreamms/blob/master/Services/Sunshine/SunshineManager.cs): `Services/Sunshine/SunshineManager.cs`
- [Stream ports](https://github.com/mlopezsegura/openstreamms/blob/master/Core/Api/SunshinePorts.cs): `Core/Api/SunshinePorts.cs`

### Local seats

- [Seat management](https://github.com/mlopezsegura/openstreamms/blob/master/Services/Seats/SeatManager.cs): `Services/Seats/SeatManager.cs`
- [Seat model](https://github.com/mlopezsegura/openstreamms/blob/master/Services/Seats/Seat.cs): `Services/Seats/Seat.cs`
- [Seat host](https://github.com/mlopezsegura/openstreamms/blob/master/Services/Seats/SeatHost.cs): `Services/Seats/SeatHost.cs`
- [Gamepad isolation](https://github.com/mlopezsegura/openstreamms/blob/master/Services/Gamepad/GamepadSessionIsolation.cs): `Services/Gamepad/GamepadSessionIsolation.cs`

### Platform services

- [Service configuration](https://github.com/mlopezsegura/openstreamms/blob/master/Core/Helpers/ServiceConfig.cs): `Core/Helpers/ServiceConfig.cs`
- [System metrics](https://github.com/mlopezsegura/openstreamms/blob/master/Services/Metrics/SystemMetrics.cs): `Services/Metrics/SystemMetrics.cs`
- [Backend localization](https://github.com/mlopezsegura/openstreamms/blob/master/Services/Localization/BackendText.cs): `Services/Localization/BackendText.cs`

### Extensions and drivers

- [Extension manager](https://github.com/mlopezsegura/openstreamms/blob/master/Services/Extensions/ExtensionManager.cs): `Services/Extensions/ExtensionManager.cs`
- [RemoteIdd driver](https://github.com/mlopezsegura/openstreamms/blob/master/Native/RemoteIdd/Driver.cpp): `Native/RemoteIdd/Driver.cpp`

### Other components

- **User**

## Connections

- User → Web dashboard: uses
- User → Tray controls: controls
- Web dashboard → REST endpoints: calls API
- Service entry point → REST endpoints: maps routes (evidence: `Program.cs`)
- Service entry point → Session lifecycle: registers service (evidence: `Program.cs`)
- Service entry point → Seat management: registers service (evidence: `Program.cs`)
- REST endpoints → Authentication: authenticates
- REST endpoints → Session lifecycle: manages sessions
- REST endpoints → Seat management: manages seats
- Session lifecycle → Stream session: manages (evidence: `Core/Api/StreamSessionService.cs`)
- Session lifecycle → RDP session setup: creates RDP (evidence: `Core/Api/StreamSessionService.cs`)
- Session lifecycle → Isolated users: manages accounts (evidence: `Core/Api/StreamSessionService.cs`)
- Session lifecycle → Sunshine manager: starts streaming (evidence: `Core/Api/StreamSessionService.cs`)
- Session lifecycle → Stream ports: allocates ports (evidence: `Core/Api/StreamSessionService.cs`)
- Session lifecycle → Extension manager: fires hooks (evidence: `Core/Api/StreamSessionService.cs`)
- Composite sessions → Session lifecycle: composes sessions (evidence: `Core/Api/StreamSessionService.Composite.cs`)
- Stream session → Stream ports: uses ports (evidence: `Core/Api/StreamSession.cs`)
- Session lifecycle → Service configuration: reads settings (evidence: `Core/Api/StreamSessionService.cs`)
- Seat management → Seat model: stores seats (evidence: `Services/Seats/SeatManager.cs`)
- Seat management → Session lifecycle: checks assignment (evidence: `Services/Seats/SeatManager.cs`)
- Seat management → Seat host: starts host
- Gamepad isolation → Session lifecycle: routes controllers (evidence: `Services/Gamepad/GamepadSessionIsolation.cs`)
- Gamepad isolation → Seat management: checks seat state (evidence: `Services/Gamepad/GamepadSessionIsolation.cs`)
- Sunshine manager → Extension manager: uses components (evidence: `Services/Sunshine/SunshineManager.cs`)
- Service entry point → System metrics: maps metrics (evidence: `Program.cs`)
- Session lifecycle → System metrics: provides session data (evidence: `Services/Metrics/SystemMetrics.cs`)
- RemoteIdd driver → Sunshine manager: supplies frames
- Session lifecycle → Backend localization: formats messages (evidence: `Core/Api/StreamSessionService.cs`)
