Add F1 debug menu with paused diagnostics and scene controls

This commit is contained in:
UnixNight committed 2026-10-25 01:49:36 -04:00
1 parent 8d60a68511
commit 3078b8afd0
21 files changed
+809 -36

No files matched your search

+8
View File
@@ -148,3 +148,11 @@ MeshPolygonSource obtains shape names from prepared mesh records. Its recovered
NC-prefix terrain eligibility is consumed by SceneCollision and OriginalScenePhysics
support/wall queries; rendering and raw source triangles remain unchanged. Other
collision masks and the modern narrowphase remain explicit fidelity limits.
DebugMenu is an intentional modern tool, separate from original UI/gameplay.
Its staged selection emits commands into the existing task/inventory/director/
transition consumers. DebugMenuOverlay appends fixed glyph/batch ranges last;
all composers still update the final mesh and the renderer uploads the changed
vertices even in static inspection. F1 owns input before practice/gameplay, pauses
simulation and all audio streams, resets the clock at both boundaries and retains
captured keys until release. Audio streams created during pause inherit that state.
+7
View File
@@ -23,6 +23,7 @@ separate evidence categories. **The game is not fully reconstructed/playable yet
| Null-material visibility | Binary rule implemented/tested | Original DX renderer skips null pointers; proxy geometry retained |
| SDL3 presentation/input | Linux Xvfb + GTX1070 | Six frames; injected keyboard event received |
| Swapchain resize | Linux tested | 960x720 ->800x600, zero validation errors |
| F1 debug menu | Managed/SDL audio tests + native Linux GTX1070 window pass |Pause/actions/input capture/resume/800x600 resize, zero validation errors;33 prepared scene/start choices; intentional modern tools, no new Windows runtime claim |
| Focus / fullscreen | Code present, partial/unverified | Focus clears keys; fullscreen toggle not dynamically tested |
| Mouse/relative input/controller | Incomplete | SDL entry point declaration alone is not behavior |
| Audio stream | Linux dummy device | Original11025Hz mono WAV consumed10752bytes/500ms; speakers untested |
@@ -77,6 +78,12 @@ exclusion fixes the underground water-plane rise while retaining rendering.
Both Linux x64 and Windows x64 self-contained executables republish successfully.
No subsequent native Windows/Wine runtime check is claimed.
F1 menu checkpoint: artifacts/debug-menu-full-tests.log passes the full suite,
including actual SDL audio pause/resume and539 unchanged originals. Native Linux
window/input/action/resize evidence is artifacts/debug-window.log; screenshots
were visually inspected. Both Linux and Windows self-contained packages publish
successfully. No new Windows/Wine runtime check was run for this addition.
Known visual/behavior limits include incomplete lighting/fog/blend/culling/material
mapping, inferred model/root pivot, provisional collision/cadence/animation timing,
close-wall camera clipping near Jimmy, incomplete class-specific triggers/interactions,
+58
View File
@@ -0,0 +1,58 @@
# F1 debug menu
User-requested modern investigation tools, separate from recovered original UI.
F1 works in the game, during cutscenes and practice prompts, and in scene inspection.
Opening the menu pauses player simulation, actors, mechanisms, cutscene clocks and
audio. Closing resumes the previous mode. No new assets or dependencies are needed.
| Key | Action |
| --- | --- |
| F1 | Open/close |
| Up/Down | Select a row |
| Left/Right | Change selected level, startpoint or staged SCENE task value |
| Page Up/Down | Change staged SCENE value by10 |
| Enter / numpad Enter | Apply the selected action |
| Escape | Close the menu |
Actions: resume, switch gameplay/orbit camera, skip the current cutscene, refill
energy to100, give/select the jet pack, apply SCENE, load selected level/start and
reset the current start. SCENE is staged until Enter, bounded0..999; it updates
the existing task system and its callbacks. Inventory/energy/task actions affect
current runtime state and its normal checkpoint snapshots; they do not write files
by themselves. Debug tools do not imply reconstructed progression or full gameplay.
The level picker offers only supplied GAMs with prepared geometry, a player and
original STRT records. It currently offers33 scenes; Level3B/E are absent because
their registered geometry is unavailable. No substitute geometry is supplied.
Load checks terrain support at the chosen start before requesting a scene rebuild.
Task/inventory/score state carries through the existing transition path. Source
start triggers run normally; use Skip Current Cutscene when needed. Unsupported
scene classes and remaining physics/render limitations are unchanged.
Diagnostics show level/start, original actor root XYZ, yaw, speed, grounded state,
energy, score, SCENE, control, current cutscene, director issue count, far plane
and camera mode. Values describe the paused live scene, independently of staged
level/start/task choices.
The menu captures keyboard and mouse input before gameplay/practice handling.
Held keys stay captured until release after closing; repeated Escape cannot quit
the game through the menu. F1 repeats do not toggle it repeatedly. Input clocks
reset at both boundaries so paused wall time does not become simulation backlog.
Implementation: Application/DebugMenu.cs owns selection/staged values;
DebugMenuOverlay.cs appends bounded screen-space glyph quads after the HUD.
The generated5x7 font uses the existing Vulkan overlay pipeline and fixed buffers.
SdlAudio/SceneAudio pause all stream categories, including replacements created
while paused. The original assets and original HUD extraction are unchanged.
Checks: DebugMenuTests covers navigation/repeat/staged edits and original scene
coverage; DebugOverlayTests covers composition/visibility/bounds; AudioPauseTests
uses actual SDL dummy-device queues to verify freeze/resume for all stream types.
`--debug-menu` opens the menu immediately, including headless captures.
`--smoke-debug-menu` runs a16-frame window test: open during a source MCA, pause,
skip/refill/grant/apply task, close with held/repeated input, resume and resize.
Native Linux GTX1070 window test passes with zero Vulkan validation errors:
artifacts/debug-window.log. GPU screenshots debug-menu.png and debug-window.open.ppm
show the menu. Source/build/regression evidence does not constitute new native
Windows verification. Full regression and package status is in progress.md.
+5
View File
@@ -79,3 +79,8 @@
NC-prefixed shape names. Use prepared shape metadata for player and actor
terrain queries; retain rendered geometry and null-material proxies. Do not
infer a generic water-material rule or full water gameplay from this finding.
19. **Keep user-requested debug tools explicit.** F1 opens a modern diagnostic menu
with code-generated glyphs, separate from recovered UI assets. Pause gameplay
and audio together, capture held input until release and stage SCENE edits until
Enter. Invoke existing source-state consumers for actions; offer only prepared
geometry and source startpoints. No debug behavior is attributed to the original.
+17
View File
@@ -4,6 +4,23 @@
user-verified Windows rendering checkpoint into an interactive original lab and
jet pack tutorial flow. This is not a verified faithful complete scene or release.
## User-requested F1 debug menu
F1 opens a modern debug overlay with live player/scene/task diagnostics. Keyboard
actions cover camera, cutscene skip, energy refill, jet-pack grant, staged SCENE
editing,33 prepared levels/original starts, reset and resume. Gameplay, cutscene
clocks and SDL audio pause while open; input is captured through release after
closing. No new asset/dependency or original-game behavior is claimed.
Targeted menu/overlay and actual SDL pause tests pass. Native Linux GTX1070
16-frame SDL test passes pause, actions, Escape/held-input capture, resume and
800x600 resize with zero Vulkan validation errors (artifacts/debug-window.log).
Headless menu GPU readback was visually inspected. Complete scripts/test.sh passes,
including41 Python checks, all managed/gameplay/GPU/audio regressions and539
unchanged original hashes (artifacts/debug-menu-full-tests.log). Both platform
executables are republished successfully. No new Windows/Wine runtime check was run,
consistent with the user's earlier preference. See debug-menu.md.
## RETURN placement and underground passage
Recovered and integrated the next lab checkpoint:
+2
View File
@@ -29,6 +29,8 @@ compile, runtime and original-fidelity verification are separate.
- [x] Source RETURN departure-root/TSK identity, player/companion restoration and
one-time STRT suppression; source NC-shape terrain exclusion; input-only
underground passage both ways from explicit riverlab/SCENE65 fixture.
- [x] User-requested F1 debug menu with diagnostics, paused audio/gameplay,
camera/cutscene/energy/jetpack/task/scene/start/reset controls and input capture.
## Immediate continuation