Files
aevolution/docs/engineering/M9_8_DELIVERY_PLAN.md
T
dingoandClaude Opus 5.5 5cf8709912 Add M9.8d rebindable engineering controls
SDL-free action/HID-key bindings with conflict validation, a staging editor and
a versioned all-or-nothing controls file (ADR-0085). The adapter maps keys
through the bindings, releases and drains on rebinding, and captures the chosen
key ahead of the toolkit and world. The client adds a Controls panel, key hints,
startup loading with a bounded rejection notice, and --controls/--show-controls.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-02 11:30:17 -04:00

6.2 KiB

M9.8 delivery plan

Status: M9.8a probe, M9.8b owned state/capture/event bounds, M9.8c launcher, legend, labelled inspector and click selection, and M9.8d rebindable controls complete, 2026-10-02; remaining segments planned. No application UI or deployment completion is claimed. See ADR-0084 for the toolkit boundary.

Confirmed scope

  • Native Windows x64 ZIP is the primary tester artifact. Linux remains a build/test target; no browser client or Steam integration.
  • Gitea Actions artifacts are the temporary download location. Later publication uses a CDN backed by rebuilt Ceph/MinIO storage. Packaging must be independent of its eventual hosting provider. No auto-updater in this gate.
  • Readable field names, units, legends, connection state and inspector values; shared dialogs, dismissible toasts, click selection and rebindable controls.
  • Startup panel offers Local fixture and Connect to dev, with endpoint and credential-file selection. Fixture mode is clearly labelled. Remote mode shows the server's empty organism layer honestly until placed organisms exist.
  • User will provide a low-spec VM. Measure first; minimum hardware and performance claims remain unqualified until CPU/RAM/GPU/OS/DPI are recorded and tested.
  • Live cluster restart evidence is explicitly deferred by the user. Local packaging qualification can complete independently; M9's live-deployment evidence remains open.
  • Cluster uses MetalLB and nginx. User reports 172.10.1.160 reachable from the development machine, with deployment through existing Gitea/GitOps machinery. This is the RKE2 control-plane address, not a confirmed MetalLB service address. Testing is internal from the development machine for now.
  • Available DNS names: sys, void, srs, cloud, assets under aeternalisgames.com. No assignment or route is implemented. Proposed dev session name: void; proposed future download name: assets. DNS existence is not evidence of service reachability.

Reviewable implementation segments

Commit and push each completed, validated segment. These rows extend M9.8; they must not be interpreted as implemented merely because a design exists.

Segment Objective / affected modules Dependencies Completion and tests Principal risk
9.8a Pin and integrate scoped UI toolkit: ADR, third_party, tools, cmake, private client adapter ADR-0084 proposal Verify exact version/license/hash; opt-in preparation; Windows/Linux text/widget probe; clean teardown; headless configure unchanged UI types leak into simulation or renderer-independent contracts
9.8b Owned UI state, dialogs, bounded dismissible notifications: src/client/ui, application adapter, tests a Explicit modal focus, notification expiry/dismissal/overflow; bounded event draining; tests under event bursts and reconnect Toasts conceal durable outcomes or queues grow indefinitely
9.8c Launcher, resource legend, labelled inspector, click selection: apps/evo-client, UI, tests a-b Fixture/live distinction, invalid credentials give bounded errors, cancel/retry, selected organism disappearance clears selection, zero/missing/stale remain distinct; visual review Displaying fictional state or logging credentials
9.8d Rebindable controls: input contracts, platform adapter, configuration, tests b-c Actions separated from physical keys; conflict validation; reset defaults; UI capture/key release/focus loss cannot cause movement; malformed config rejected Stuck actions and click-through while interacting with UI
9.8e Reproducible Windows ZIP: tools/client, CMake, Gitea workflow c-d, runner availability Stage explicit runtime files, licences, build identity and checksum manifest; no credentials; extract/run on clean Windows; publish Actions artifact Missing DLLs/runtime prerequisites or secrets packaged accidentally
9.8f Dev TCP route design and optional deployment: ADR, dev overlay, policy tests Confirm endpoint/controller/port and access policy Reconcile loopback-only ADR-0083 with deliberate dev-only exposure; TLS passthrough, verified server name, scoped grants, fail-closed policy tests; actual connectivity recorded separately Exposing development identity or widening World0 access
9.8g Qualification report: tools, tests, engineering docs b-e, test VM Record frame-time percentiles, memory after warm-up, queue high-water, prolonged run, DPI/resolution/input matrix, headless regression; publish actual limits Calling an unaccelerated VM result a universal hardware requirement

UI and input invariants

Toolkit events are processed on the application thread. Dialogs and binding capture consume relevant input before world intentions or selection are generated. Opening UI/focus loss releases active world actions; closing it does not synthesize held keys. A click that dismisses a toast or operates a widget must not select through it.

A transient toast is not the authoritative record of an intention outcome. Keep a bounded, inspectable session status/outcome model even if notifications expire. No credentials, grant payloads, or private keys in notifications, logs, config or ZIPs. Use bounded path inputs; retain file references rather than persisting grant bytes. All selected biological data remains a read-only presentation copy.

Infrastructure and packaging decisions still needed

  • No Windows runner exists yet (confirmed 2026-10-02). Local builds are the initial path. Do not silently route a Windows package job to the existing Linux runner or assume an untested cross-compile. The packaging script can run on the existing Windows development host meanwhile.
  • Confirmed control plane: 172.10.1.160. Still needed for direct service routing: nginx implementation/configuration, exposed TCP port, source restrictions and certificate name. The protocol is TLS/TCP, not HTTP; a standard HTTP Ingress rule does not implement it. Port-forward remains supported.
  • VM specification and whether graphics acceleration is available. Hardware-specific performance acceptance cannot be declared before these are known.
  • CDN origin/access/retention decisions wait for the storage rebuild. They do not block local ZIPs or temporary Actions artifact downloads.