Files
Neutron/docs/architecture.md
T

2.5 KiB

Architecture

Use a single .NET 10 C# executable, Silk.NET.Vulkan for Vulkan 1.3 rendering, SDL3 for platform windowing, input and audio. Linux x64 and Windows x64 are equally required. Source is src/GamePort/; root executable csproj allows dotnet build and dotnet run from GamePort. No runtime network dependencies.

Original assets stay in ../Original. Python tools parse undocumented original formats into generated scene resources under artifacts/. The modern application loads these original-derived resources and big endian GAM entity data. Portable asset resolution must handle Windows-authored case differences. Extraction must retain material references, world coordinates, per-corner UVs and animation data; triangulation/render-state approximations require explicit documentation.

Assets/GamLevel.cs independently decodes original gameplay records and exposes player/startpoint/camera and other typed properties. Exact record bytes/unknown types remain accessible; do not normalize unknown flags into invented semantics. tools/levels/gam.py provides a lossless forensic reference and JSON export.

Renderer design follows original fixed-function needs, without PBR or invented visual effects. A headless offscreen rendering path makes actual Vulkan image verification possible without a desktop; this is distinct from SDL presentation. Simulation implementation must follow recovered algorithms and timing. A generic fly camera or rendered model alone does not satisfy the playable-scene requirement.

The completed foundation includes a single synchronous Vulkan renderer supporting offscreen and SDL surface presentation, an independent SDL WAV stream, bounded GAM/PNG/scene readers, and a retained-topology morph sampler. Prepared scene JSON avoids a Python runtime dependency in native packages. Mesh draw ranges omit null materials following the original renderer, while retaining their geometry. Default normal atlas and morph transforms are supported by binary/duplicate-asset evidence.

Physics arithmetic fragments are independent of a full controller; no invented collision/task system has been silently inserted. The main program remains a scene investigation runtime; future simulation must be a separate stateful module with recovered timing, input, collision, triggers and progression.

Subsystem implementation and validated ownership are documented in infrastructure.md, analysis/graphics.md and rendering.md as they become available. Persistent docs distinguish planned architecture from verified behavior.