Files
DSP_Mods/LiveStreamAssist/README.md
T
soarqin e95c832e03 fix(livestreamassist): migrate WebSocket API to Kestrel
Replace Fleck with pinned in-process Kestrel packages and explicit runtime packaging. Fix connection lifetimes, deadlines, admission accounting, and reflection validation.

Add production transport regressions and update the migration guidance with remaining Unity/LAN acceptance gates.
2026-09-17 20:53:05 +08:00

31 lines
1.4 KiB
Markdown

# LiveStreamAssist
Keeps the Dyson Sphere Program statistics window active during a live stream by switching between the Production Statistics and Dyson Sphere tabs at a random interval. Optionally exposes a local/LAN WebSocket API for read-only game data.
## Usage
- Press Ctrl+F8 to start or stop the assist. The key can be changed in the game's keyboard settings.
- Starting the assist opens the statistics window and selects Production Statistics.
- The mod switches between Production Statistics and Dyson Sphere every 15 to 30 seconds.
- Closing the statistics window stops the assist automatically.
The mod requires UXAssist.
## WebSocket API
The in-tree listener uses in-process ASP.NET Core 2.3 Kestrel (managed sockets). Unity 2022/Mono and LAN acceptance remain pending. The design document below defines the remaining gates.
Disabled by default. In the BepInEx config file, set:
```text
[WebSocketApi]
Enabled = true
ListenAddress = 127.0.0.1
Port = 18080
```
Then connect to `ws://<host>:18080/api/v1`. There is no authentication. Use a LAN bind address or `0.0.0.0` only on trusted networks. Configuration changes require a game restart.
- [WebSocket API reference](https://github.com/soarqin/DSP_Mods/blob/master/LiveStreamAssist/docs/WebSocketApi.md)
- [WebSocket design and transport migration plan](https://github.com/soarqin/DSP_Mods/blob/master/LiveStreamAssist/docs/WebSocketDesign.md)