Files
Neutron/README.md
T

4.7 KiB

Jimmy Neutron reconstruction

Local reconstruction of the supplied Jimmy Neutron: Boy Genius installation using C#/.NET 10, Silk.NET.Vulkan (Vulkan 1.3), and SDL3. Original files remain untouched in ../Original. There are no Git remotes or runtime online services.

Current milestone: recovered original assets, a native rendered lab scene with an animated Jimmy preview, and Linux/Windows investigation packages. Full playable gameplay has not been reconstructed. Controls, collision, introductory cutscenes, interactions, progression and saves still require implementation and comparison. See progress and compatibility.

Build and run locally

From GamePort/, using an installed .NET 10 SDK or the already provisioned local SDK:

source scripts/env.sh
dotnet build
python3 tools/extractors/prepare.py --audio sounds musicsecretlab
dotnet run -- --with-player

The default scene is the original secret lab (LV1B) with its recorded start camera. Press C to switch between stored and inspection cameras; arrows/WASD orbit, plus/minus zoom, F11 toggles fullscreen, Escape quits. These are investigation controls. Original gameplay controls are documented in docs/analysis/gameplay.md. Without a prepared scene, the app previews the original Jimmy base model.

Headless verification on a machine with Vulkan 1.3 (Mesa lavapipe works):

dotnet run -- --headless --with-player --time 0.05 --screenshot artifacts/lab.ppm
dotnet run -- --headless --model ASE/jimstop.ase --texture png/jimycarl.png
dotnet run -- --audio artifacts/extracted/musicsecretlab/Wave_00000000_HuntingBuildupVar2_11k.wav --loop-audio
dotnet run -- --help

Explicit original paths can be supplied with --assets /path/to/Original. --scene accepts generated scene JSON; --level accepts an original GAM relative to the original root. --original-camera uses its matching startpoint. Player preview uses --with-player or --animation path/to/animation.json. Morph sample interpolation is recovered; loop closure and playback speed remain preview policies.

If tooling is missing on Linux, scripts/bootstrap.sh downloads pinned official SDK/SDL dependencies and obtains build tools using the existing Ubuntu apt index, all under .tools. It needs network access for dependencies, Python 3.12+, CMake, a C compiler and ordinary native runtime libraries. It does not install host packages. Restore uses NuGet; subsequent builds/tests use local caches. The runtime needs a Vulkan 1.3 driver/loader, plus X11/Wayland on Linux for visible windows.

Test and package

scripts/test.sh
scripts/build-linux.sh
scripts/build-windows.sh
scripts/package.sh

The publish scripts perform equivalent self-contained publishes:

dotnet publish -c Release -r linux-x64 --self-contained true
dotnet publish -c Release -r win-x64 --self-contained true

Packages are local directories dist/linux-x64 and dist/win-x64. Run launch-scene.sh or launch-scene.cmd; append --headless --frames 1 for a render smoke test. They include the .NET runtime, SDL3 native library, SPIR-V, original asset copies, prepared lab/Jimmy resources, audio and limitations. Windows cross-publishing is verified; native Windows execution is unverified. These are investigation packages, not a finished game release.

scripts/test.sh runs 20 Python regressions, native C# data/algorithm checks, all PNG/ASE decoders, actual Vulkan GPU readback, dummy-device SDL3 audio, and original SHA-256 verification. Set NEUTRON_WINDOW_TEST=1 with a working DISPLAY to include injected keyboard and swapchain-resize verification. Full OMT audit:

python3 tools/extractors/audit.py ../Original --report artifacts/extracted/audit.json
python3 tools/recon/inventory.py ../Original --verify docs/original-manifest.json

Investigation and continuity

Start with AGENTS.md, tasks, reverse-engineering index, and architecture. Detailed binary/graphics/asset/gameplay reports are under docs/analysis. tools/extractors contains bounded OMT/ASE/PNG decoders; tools/levels/gam.py round-trips all original level records.

Original reference capture uses tools/recon/reference_capture.py with local Wine/Xvfb, bubblewrap and ImageMagick. It executes a separate copy with no network and no original-directory mount. Wine is for investigation only; the port does not use Wine, DirectX or OpenGL. See docs/reference-testing.md for actual results.

All generated extraction output, local SDK/native dependencies, captures and packages are ignored by the nested local Git repository. Never configure a remote, upload assets, or overwrite the original installation.