Qualify pinned Dear ImGui toolkit for M9.8a

This commit is contained in:
dingo
2026-10-02 07:53:17 -04:00
parent 4d6a2b6d83
commit 22c7c341ce
16 changed files with 293 additions and 20 deletions
+4 -1
View File
@@ -454,9 +454,12 @@ terrain meshing or procedural creature animation is required.
| 9.7 Connect to one authoritative dev region | src/client/session, src/server/session adapter | 9.6, M8-dev/stage | Real desktop-to-server connection, snapshot display and minimal admitted intent; reconnect requests fresh baseline; final outcomes reflect durable server ACK | Disconnect/reconnect, stale epoch, server pod restart, rejected intention and duplicate session tests | Client state or reconnect becomes authority |
| 9.8 Validate presentation and package the client | tools/client packaging, tests/client, docs/engineering | 9.1-9.7 | Reproducible native artifact, bounded snapshot/render queues, frame/memory report and documented manual visual checks | Install/run on supported dev platforms; long session, resolution/DPI matrix, headless regression suite | Declaring FUN or multiplayer scalability from a viewer |
**M9.8a (2026-10-02):** isolated Dear ImGui 1.92.9b probe qualified on Windows/Linux;
application UI integration remains next. ADR-0084 is accepted for this probe.
**M9.8 planning (2026-10-02):** user-confirmed Windows ZIP, temporary Gitea Actions
artifacts, labelled engineering UI/launcher and control rebinding. See the
[delivery segments](engineering/M9_8_DELIVERY_PLAN.md) and proposed ADR-0084.
[delivery segments](engineering/M9_8_DELIVERY_PLAN.md) and ADR-0084.
Low-spec VM qualification and live cluster evidence remain outstanding; neither
is implied by packaging completion.
+21 -8
View File
@@ -1,10 +1,14 @@
# ADR-0084: Engineering UI toolkit and ownership boundary
## Status
Proposed, 2026-10-02. User authorized evaluating/adopting a maintained framework.
Preferred candidate: Dear ImGui for the engineering client only. Adoption requires
an exact source pin, licence inventory and Windows/Linux compatibility probe in
M9.8a. No dependency has been added by this ADR. Final player UI remains undecided.
Accepted for the isolated M9.8a engineering UI probe, 2026-10-02. User delegated
UI selection. Dear ImGui 1.92.9b, MIT, upstream commit
`f1cc2ae15e53a861a874c3034aae6798fde194ab`; archive SHA-256
`21d8a0a565e85dce943e375db00812c2f3f0ab21f3f0f7964e364a63422d7f99`.
Published 2026-07-31; upstream latest-release API and tag checked 2026-10-02.
Checksum is locally measured over the upstream HTTPS archive, not an independent
signature. The pin is in tools/imgui-pin.cmake. Broader application integration
follows the probe. Final player UI remains undecided.
## Context
M9.4/M9.5 intentionally used rectangles and unlabelled gauges. M9.8 now requires
@@ -12,7 +16,7 @@ readable text, a launcher, dialogs, dismissible notifications, click selection a
control rebinding. The existing client uses SDL3 and SDL_Renderer. The headless
libraries and immutable biological views must remain toolkit-independent.
## Decision proposed
## Decision
Use Dear ImGui's upstream SDL3 platform and SDL_Renderer3 rendering adapters behind
the private native client boundary. Implement owned application state for toasts,
selection, dialogs and action bindings; do not equate toolkit widget state with
@@ -57,12 +61,21 @@ segment, not inferred from this high-level comparison.
## Consequences
Revisits ADR-0081's scoped decision to defer ImGui once labelled engineering UI is
needed. M9.8a must change this status to accepted only with the pin and probe evidence.
needed. M9.8a records the pin and executed probe evidence in VALIDATION.md.
M9.8 delivery is tracked in ../engineering/M9_8_DELIVERY_PLAN.md.
## Primary-source evidence reviewed 2026-10-02
- https://github.com/ocornut/imgui/blob/master/docs/BACKENDS.md — upstream SDL3 and SDL_Renderer3 adapters; platform/render separation.
- https://github.com/ocornut/imgui/blob/master/LICENSE.txt — MIT licence; pin-time notice audit still required.
- https://github.com/ocornut/imgui/blob/master/LICENSE.txt — MIT licence; notice inventory in third_party/imgui/README.md.
- https://github.com/ocornut/imgui/blob/master/docs/FAQ.md — input capture guidance and integration responsibilities.
- https://github.com/ocornut/imgui/releases — release/maintenance evidence; no version selected here.
- https://github.com/ocornut/imgui/releases — release/maintenance evidence; v1.92.9b selected above.
- https://mikke89.github.io/RmlUiDoc/pages/cpp_manual/integrating.html — context and rendering integration requirements for the alternative.
The probe compiles core, draw, tables, widgets and the SDL3/SDL_Renderer3 backends;
no demo, docking, multi-viewport, FreeType or external font dependency is introduced.
Use the embedded ProggyClean bitmap font explicitly for the probe. Retain LICENSE.txt,
docs/FONTS.md, imgui_draw.cpp and the stb headers' embedded notices at
packaging. The bundled ProggyForever data also carries notices in imgui_draw.cpp;
include the source notice inventory even when that font is not selected.
Normal headless/client configuration does not require ImGui until explicitly enabled.
+1 -1
View File
@@ -96,4 +96,4 @@ design. No unadopted candidate is a link dependency of the proof.
- [ADR-0082: Dev session transport](0082-dev-session-transport.md) - TLS 1.3-only Mbed TLS 4.1.1 LTS (pinned, compiled-down), dev-only HMAC grants, versioned bounded protocol v1 and session admission for M9.
- [ADR-0083: Dev region sessions](0083-dev-region-sessions.md) - session server in evo-server, durable no-effect intentions on synthetic carriers, empty organism presentation, reconnect with fresh baselines, loopback-only drill-time dev deployment.
- [ADR-0084: Engineering UI toolkit](0084-engineering-ui-toolkit.md) - proposed Dear ImGui boundary; adoption waits for the exact pin and compatibility probe.
- [ADR-0084: Engineering UI toolkit](0084-engineering-ui-toolkit.md) - accepted for the isolated M9.8a Dear ImGui 1.92.9b compatibility probe; application UI follows.
+7 -5
View File
@@ -1,7 +1,7 @@
# M9.8 delivery plan
Status: planned; user choices recorded 2026-10-02. No implementation or deployment
is claimed by this document. See ADR-0084 for the proposed UI toolkit boundary.
Status: M9.8a isolated toolkit probe complete, 2026-10-02; remaining segments planned.
No application UI or deployment completion is claimed. See ADR-0084 for the toolkit boundary.
## Confirmed scope
@@ -21,7 +21,8 @@ is claimed by this document. See ADR-0084 for the proposed UI toolkit boundary.
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.
Whether this address belongs to a node or the ingress service is unconfirmed.
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.
@@ -56,10 +57,11 @@ All selected biological data remains a read-only presentation copy.
## Infrastructure and packaging decisions still needed
- Windows runner label/toolchain availability. Do not silently route a Windows
- 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.
- Exact role of 172.10.1.160, nginx implementation/configuration, exposed TCP port,
- 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
+35
View File
@@ -3602,3 +3602,38 @@ in M9_8_DELIVERY_PLAN.md. ADR-0084 proposes the UI boundary and comparison; no l
version or dependency was adopted. Reviewed upstream toolkit documentation, checked
repository-relative links and git diff --check. Documentation only: no code tests,
package build, runner execution, endpoint verification or deployment performed.
## 2026-10-02 — M9.8a pinned engineering UI probe
Adopted Dear ImGui 1.92.9b for an isolated SDL3/SDL_Renderer3 compatibility probe;
normal client/headless builds do not require it. Exact upstream commit, locally
measured archive checksum, maintenance and notice evidence are in ADR-0084 and
third_party/imgui/README.md. No upstream code modified. Embedded bitmap font used;
no extra font dependency. Source preparation is explicit, with hash verification.
Executed: Windows MSVC Release probe CTest 2/2; Linux GCC14 Release 2/2;
Clang19 ASan/UBSan 2/2 (including instrumented toolkit sources); real X11 software
renderer probes under Xvfb in Release and sanitizer builds. Three full SDL/UI
initialize/render/shutdown cycles per successful invocation. A synthetic press and
release activates a real widget exactly once; geometry bounds and pixel readback
are checked under NDEBUG. Invalid explicit renderer fails. This is synthetic input
and render evidence, not physical keyboard/DPI/accessibility acceptance.
clang-tidy19 on owned probe: no owned diagnostics; clang-format19 and CI selector
fixtures passed, including a new toolkit-pin selection case. Fresh headless configure
with client/network/probes off passed without evaluating SDL/ImGui dependencies.
An initial const mismatch with upstream's mutable draw API was corrected. Initial
static analysis used a GCC database with unsupported module flags; rerun against the
Clang database passed. Edited shell scripts were normalized to LF before selector
fixtures ran successfully.
Artifact observations: Windows Release probe EXE 398336 bytes, SDL3.dll 1998848;
Linux Release executable 1098464 bytes. These are probe totals, not a final client
package size or an incremental apples-to-apples benchmark. No minimum hardware,
frame-rate or accessibility claim yet. Low-spec VM pending; live cluster drill is
explicitly deferred; control-plane IP is not assumed to be a MetalLB endpoint.
Not run: Docker/Gitea image execution, physical GPU/DPI matrix, VM soak, client UI
integration/launcher or packaging acceptance. Existing network and headless simulation
behavior is unchanged; no simulation version or golden was modified.