diff --git a/.planning/REQUIREMENTS.md b/.planning/REQUIREMENTS.md new file mode 100644 index 0000000..2f63ee7 --- /dev/null +++ b/.planning/REQUIREMENTS.md @@ -0,0 +1,89 @@ +# Requirements: Neutron GamePort + +**Defined:** 2026-11-12 +**Core Value:** Match original behavior and presentation as accurately as possible, governed by authoritative evidence and explicit verification. + +## v1 Requirements — Remaining Full Reconstruction + +The release scope is the full original game. Existing bounded implementations are foundations; unchecked items represent their remaining full-scope acceptance, not absence of all implementation. Original means behavior established from authoritative binaries/assets and observed execution, including significant quirks. Approximation and unavailable comparison evidence must stay explicit; neither is silently counted as verified parity. + +### Reference and Fidelity Baseline + +- [ ] **EVID-01**: Every original file remains byte-identical to the recorded inventory throughout recovery, testing and release preparation; generated copies and outputs remain separate. +- [ ] **EVID-02**: Reviewers can reproduce identified original-game reference scenarios from an isolated generated installation, with input/event, visual and audio captures where applicable; unresolved execution limitations are recorded and leave comparison acceptance open. +- [ ] **EVID-03**: Reviewers can identify each capability's source evidence, implementation revision, runtime platform, current discrepancy and acceptance condition in a maintained full-game coverage ledger. +- [ ] **EVID-04**: Testers can repeat the baseline movement/route scenarios on native Linux and native Windows with revision-specific receipts; cross-publish, Wine, component execution and native gameplay remain separately labeled. + +### Movement, Contacts and Scene Ownership + +- [ ] **MOVE-01**: Jimmy's intended original keyboard/mouse/controller inputs, where supported by the original, produce source-faithful movement, facing, jumps, gravity and effect behavior across required movement modes and frame rates. +- [ ] **MOVE-02**: Jimmy and participating bodies resolve static/dynamic support, walls, ceilings and special contacts using evidenced real actor responses, live callback reads, ordered physical membership and helper lifetimes before broader scene admission. +- [ ] **MOVE-03**: Players retain the original action/animation acceptance, playback, interruption and completion behavior through movement, landing, conversation and control changes. +- [ ] **MOVE-04**: Players experience original camera/input/control handoffs through scripts, pause, fresh entry, LOAD and RETURN, preserving correct object/state ownership without invented orientation resets. +- [ ] **MOVE-05**: Players can complete lab → VR04 → lab → outside under fresh and retained entry with natural/skipped dialogue, banked jumping, landing, held input and gadget cleanup, preserving implemented startup-order corrections and legitimate landing bank. + +### Actors, Hazards and Combat + +- [ ] **ACT-01**: Original NPC/enemy classes exhibit their evidenced sensing, action transitions, movement, animation and RNG-dependent behavior in their intended scenes. +- [ ] **ACT-02**: Players and actors receive original health, damage, immunity, hazard, death and recovery behavior through real gameplay consumers. +- [ ] **ACT-03**: Enter/stay/leave and special actor interactions perform original task, score, control and class-specific side effects in the evidenced order. + +### Gadgets, Vehicles and Inventory + +- [ ] **GAD-01**: Players acquire and select all original gadgets/items through original gameplay paths with faithful inventory, energy and availability rules. +- [ ] **GAD-02**: Players can use every original gadget against its intended actors/objects with source-faithful aiming, firing, state, projectile and effect behavior; existing bounded gadget implementations retain their verified behavior. +- [ ] **GAD-03**: Players can summon, mount, drive/fly and dismount original vehicles through intended modes, inputs, camera, passenger, collision and cleanup behavior. +- [ ] **GAD-04**: Gadget/vehicle/companion state follows original interruption, death, script, LOAD/RETURN and save/resume lifetimes across intended scenes. + +### Campaign and Authored Content + +- [ ] **CAMP-01**: Players can enter and traverse every evidenced reachable original campaign and optional/practice level with its intended original assets and entry/exit rules. +- [ ] **CAMP-02**: Original missions, authored scripts/cutscenes, tasks, objectives, collectibles and level-specific mechanisms advance through ordinary gameplay in their intended order. +- [ ] **CAMP-03**: Players can complete every original campaign route and evidenced optional branch through original completion/win/loss outcomes without debug grants or warps. +- [ ] **CAMP-04**: The content ledger accounts for every supplied level/resource and distinguishes reachable content, unreachable/unused content and unresolved missing dependencies using evidence; absent assets are never silently substituted. + +### Frontend, Configuration and Persistence + +- [ ] **UI-01**: Players can use original startup, new-game, menu, pause, objective/HUD, prompt and ending flows through source-supported input and timing; modern diagnostics remain distinguishable. +- [ ] **UI-02**: Players can change and persist original-supported configuration, including relevant input/display/audio settings, with source-faithful defaults and bounds. +- [ ] **SAVE-01**: Players can save, load and resume through original player-facing workflows with faithful checkpoint, task, inventory, health/energy and progression state, preserving required original-format fields. +- [ ] **SAVE-02**: Fresh start, repeated load, scene return and resume reproduce correct retained/reset actor, helper, companion, gadget, script and camera state, verified by equivalent continued gameplay. + +### Visual, Animation and Audio Fidelity + +- [ ] **VIS-01**: Players see original geometry, textures, model hierarchy/pivots, morphs, sprites, animation and UI layout at faithful authored positions and playback timing. +- [ ] **VIS-02**: Original lighting, materials, fog, texture stages/sampling, blending, alpha/depth/culling and render-layer behavior are reproduced by Vulkan equivalents and compared against identified original references. +- [ ] **VIS-03**: Original gameplay/script cameras, projection, clipping, aspect behavior and transitions reproduce authored presentation without distorting the scene. +- [ ] **AUD-01**: Players hear original music, speech and contextual sound banks/events with faithful selection, timing, channel priority, looping and interruption through gameplay and transitions. +- [ ] **AUD-02**: Players hear faithful volume, panning, attenuation, positional/frequency behavior and listener ownership, validated through physical audible output as well as event/stream checks. + +### Full-Game Acceptance and Local Delivery + +- [ ] **REL-01**: Players can run clean, self-contained Linux x64 and Windows x64 packages offline with required SDL3/resources/shaders, without development tools, original installation paths or runtime online services. +- [ ] **REL-02**: Current packages pass integrated full campaign/optional-content, input, audio, window/focus/resize/fullscreen and resource-lifecycle checks on native Linux and native Windows, with exact source/package identities and recorded Vulkan diagnostics. +- [ ] **REL-03**: The final discrepancy audit compares the reconstructed game against original reference scenarios across gameplay, timing, visuals, audio and progression; unresolved differences and verification gaps remain explicit and prevent unsupported full-fidelity completion claims. +- [ ] **REL-04**: Maintainers can reproduce local builds/tests/packages and review current evidence, compatibility and known limitations; verified source/tools/docs are pushed to existing Gitea while originals, generated traces and packages stay local. + +## Deferred Requirements + +No original-required feature category is deferred outside the full reconstruction release. Phase-level deferral only establishes dependency order; unknown original behavior is investigated rather than invented. New-gadget expansion remains behind the current movement/route stabilization gate. + +## Out of Scope + +| Feature | Reason | +|---------|--------| +| Creative mechanics, replacement movement tuning or visual modernization | Original fidelity governs the reconstruction. | +| Online runtime services, telemetry, cloud CI | Shared native offline implementation and local builds/tests are mandatory. | +| Uploading originals, generated traces or release packages | Source-control authorization covers verified source/tools/docs only. | +| Treating third-party remakes as behavior authority | Only original evidence establishes faithful behavior. | + +## Definition of Done + +Each requirement requires evidence recovery, integrated implementation, appropriate regressions and runtime verification, and a verified source revision. Preserve source addresses/offsets and complete REA evidence for binary investigations. Native Windows execution is not replaced by Wine or cross-publishing. Component parity is not whole-original execution. Capture comparison tolerances per system with an evidence-backed reason; never assume blanket pixel/bit identity. All original-required content must be accounted for before full-game completion, and unresolved reference/platform access is an open acceptance dependency. + +## Traceability + +Pending roadmap creation: every v1 requirement will map to exactly one accountable phase. Cross-cutting checks continue in later phases without changing that ownership. + +--- +*Last updated: 2026-11-12 after full-scope research and playable-slice selection*