Files
DSP_Mods/LiveStreamAssist/README.md
T
soarqin 3e3e995d55 feat(livestreamassist): add Chinese live dashboard with game icons
- Add a URL-driven Chinese overlay page rendering item rate tables,
  tech levels, current research, and Dyson sphere power for streams.
- Add the offline GameIcons layer and generate_icons.py, which extracts
  every item and tech icon from a local DSP install into
  js/generated/dsp-icons.js.
- Reuse the proto extraction in generate_text.py and cover the new
  page with test_dashboard.js.
2026-09-20 03:44:27 +08:00

2.7 KiB

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:

[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.

Open the overlay examples in a browser or OBS Browser Source. Default URL is ws://127.0.0.1:18080/api/v1; override with ?ws=.

The overlays use the JS client: Client for JSON-RPC, GameQuery for those reads, and GameText/GameIcons for offline localized names, DSP KMG formatting, and extracted game icons. Keep the examples/ and js/ directories side by side when copying an overlay. The offline data never calls the WebSocket API; regenerate js/generated/dsp-text.js and js/generated/dsp-icons.js from the repository root with python LiveStreamAssist/js/scripts/generate_text.py and python LiveStreamAssist/js/scripts/generate_icons.py.