- 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.
9.9 KiB
LiveStreamAssist JS client
Browser helper for the WebSocket API. It is intended for OBS Browser Sources and local overlay pages with BigInt and Promise.allSettled support. There is no npm build; load the packed script as a classic <script>.
The library has four layers:
| Layer | Script surface | WebSocket? | Role |
|---|---|---|---|
| Low-level client | LiveStreamAssist.Client |
Yes | JSON-RPC 2.0 transport, method wrappers, pending-request limit |
| High-level query | LiveStreamAssist.GameQuery |
Yes | Common overlay reads: item rates, research, Dyson power |
| Game text | LiveStreamAssist.GameText |
No | ID to localized name, DSP KMG formatting |
| Game icons | LiveStreamAssist.GameIcons |
No | ID to icon data URL extracted from game textures |
GameText and GameIcons never send API requests. Names come from generated dictionaries converted from the game's Locale/ files and prototype tables; icons come from textures extracted from a local install.
Files
livestream-assist.js— packed browser bundlegenerated/dsp-text.js— generated locale/proto dictionarygenerated/dsp-icons.js— generated item/tech icon data URLssrc/— layer sources concatenated byscripts/pack_js.pyscripts/generate_text.py— regenerate text data from a local DSP installscripts/generate_icons.py— regenerate icon data from a local DSP install
Overlay usage
<div id="research"></div>
<div id="rates"></div>
<div id="power"></div>
<script src="../js/generated/dsp-text.js"></script>
<script src="../js/livestream-assist.js"></script>
<script>
(async function () {
const text = LiveStreamAssist.GameText.fromGenerated({ language: "en" });
const client = new LiveStreamAssist.Client({ url: "ws://127.0.0.1:18080/api/v1" });
const query = new LiveStreamAssist.GameQuery(client);
await client.systemInfo();
await client.validate({ apiMajor: 1, requiredCapabilities: ["reflection.read"] });
await query.waitUntilReady();
const research = await query.getCurrentResearch();
const iron = await query.getItemRates(1101);
const dyson = await query.getDysonPower();
document.getElementById("research").textContent = research.active
? text.techDisplayName(research.techId, research.curLevel)
: "No active research";
document.getElementById("rates").textContent = text.itemName(1101) + " " + text.formatRate(iron.production) + " / min";
document.getElementById("power").textContent = text.formatPower(dyson.watts);
})().catch(function (error) { console.error(error); });
</script>
Examples:
Keep examples/ and js/ side by side when copying these pages. The examples retry failed connections, wait for each polling cycle to finish before scheduling another, and discard stale results after connection changes. Use ?lang=en, ?lang=zh-CN, or an LCID such as ?lang=2052; the stats example also accepts ?item=1101.
The Chinese live-dashboard page shows only the sections selected by URL parameters and defaults to research plus Dyson power when none are given:
?items=1101,1203&techs=1001,1104&research=1&dyson=1&window=1min
itemsrenders the game-style rate table: each material has two rows (production with its theoretical value, then consumption with its theoretical value) sharing one icon and name cell.techsrenders tech levels:cur/maxfor repeatable techs, 已解锁/未解锁 for one-time techs.researchrenders the current tech with a progress bar and hash counters.dysonrenders total Dyson sphere power generation.windowselects the rate window (1mindefault,10min,1hour,10hour,100hour,total).
Low-level client
Client speaks the documented JSON-RPC methods only: system.ping, system.info (systemInfo()), system.validate, system.stats, data.roots, data.describe, and data.read. Unknown parameters are omitted so the server does not reject the request.
- Request ids are
n-<n>and are unique among outstanding calls. - At most
maxPendingrequests are in flight (default 8, thensystem.info.limits.maxPendingRequestsPerConnection). An explicit caller limit remains an upper bound. Limits must be positive integers. - Responses are correlated by id and may arrive out of order.
Int64/UInt64values stay strings on the wire.GameQueryconverts them where needed.LiveStreamAssist.key(id)builds a dictionary path segment{ key }.connect(url)replaces a connection when its URL changes.close()cancels connecting, pending, and queued work and stops reconnect timers. Callconnect()explicitly to reopen a closed client; requests never replay across connections.
API errors throw LiveStreamAssist.ApiError with stable kind from error.data.kind.
High-level queries
Compound queries reject with SESSION_CHANGED instead of combining reads from different saves. Retry the entire query. Reads within one session can still sample different game ticks; they are not atomic snapshots.
Item production
query.getItemRates(itemId, { window, scope })
window:1min(default),10min,1hour,10hour,100hour,total. The default 1-minute window matches the statistics panel's shortest rate view:ProductStat.total[1]production andtotal[8]consumption, already items/min.scope: omitted/'cluster'sums every factory;'localPlanet'useslocalPlanet.factoryIndex;{ factoryIndex }reads one factory.- Result fields:
production,consumption,theoreticalProduction,theoreticalConsumption. Theoretical values are the game'srefProductSpeed/refConsumeSpeedin items/min. The server queues queried factories for the native production extra-info calculator without requiring the statistics window or Ctrl+F8 assist. Refresh requests are deduplicated and limited to once per factory every two seconds; an active calculation batch finishes before more factories are queued. Initial polls can return zero, and later polls can return the previous values until the native batch reaches that factory.
Pass an array of positive integer item ids to share the factory scan; duplicates do not multiply totals. Only existing product indices are cached, so newly produced items become visible on later polls. An unbuilt local planet returns zero rates; an unavailable local planet during space travel still raises ROOT_UNAVAILABLE.
Research
getTechState(techId)readshistory.techStates[techId].getCurrentResearch()readshistory.currentTech, then that tech's state.techId === 0means no active research.progressPercentuses integer hash math, same as the sample overlay.
Dyson power
getDysonPower() sums game.dysonSpheres[i].energyGenCurrentTick across non-null spheres, projecting energy fields in collection pages. getDysonPower({ starIndex }) reads only that sphere. Watts are joulesPerTick * 60 (DSP ticks per second). originalWatts is the pre-Dark-Fog-debuff figure. Star display names use overrideName or name because displayName is a getter and is not readable through the API. Empty results retain their session metadata.
Game text
Load generated/dsp-text.js before the library, then GameText.fromGenerated({ language: "zh-CN" }). Language may be an LCID (1033, 2052), en, zh, fr, de, or ja.
itemName,techName,recipeName,signalName,veinName, andname(kind, id)translate(key)for generated locale keys (missing entries return the key and explicit empty translations stay empty, matching DSP)techDisplayName(id, curLevel)matchesTechState.currentTechString: name, or name +杠等级+ levelformatKmg,formatPower,formatEnergymatchStringBuilderUtility.WriteKMG/WriteKMGPower/WriteKMGEnergy: values below 10000 stay raw, then k/M/G/T/P/E with three leading digits. Decimal separators follow the selected language (小数点).
Game icons
Load generated/dsp-icons.js before the library, then GameIcons.fromGenerated().
itemIcon(id),techIcon(id), andicon(kind, id)return PNG data URLs extracted from the game'sIcons/ItemRecipeandIcons/Techtextures, ornullfor unknown IDs.- The data file is around 3.5 MB because it embeds every item and tech icon; pages should keep referencing it from disk like the other generated data.
Regenerating text and icon data
Requires a local DSP install plus pip install -r LiveStreamAssist/js/scripts/requirements.txt.
python LiveStreamAssist/js/scripts/generate_text.py --game-root "<DSP install>"
python LiveStreamAssist/js/scripts/generate_icons.py --game-root "<DSP install>"
python LiveStreamAssist/js/scripts/pack_js.py
The generator locates Steam/DSP the same way UpdateGameDlls.ps1 does when --game-root is omitted. It reads BOM-aware Locale/ files in the header's stable page order and extracts prototype id/name maps from resources.assets. Missing item or tech tables abort generation before overwriting the dictionary. Edit src/ and repack rather than editing livestream-assist.js directly.
Validation
Run from the repository root. JavaScript checks use Node.js 20 or later and require no npm packages. Python checks use the standard library; locale integration checks run when DSP is installed.
python LiveStreamAssist/js/scripts/pack_js.py
node --test LiveStreamAssist/js/scripts/test_client.js LiveStreamAssist/js/scripts/test_query.js LiveStreamAssist/js/scripts/test_text.js LiveStreamAssist/js/scripts/test_overlays.js LiveStreamAssist/js/scripts/test_dashboard.js
python LiveStreamAssist/js/scripts/test_text.py
These checks cover connection cancellation, queue limits, session changes, production caching, Dyson pagination, locale parsing, formatting, and overlay polling. They do not replace DSP/OBS or LAN acceptance testing.