Skip to content

validation.md

Latest commit

 

History

History
49 lines (38 loc) · 3.22 KB

validation.md

File metadata and controls

49 lines (38 loc) · 3.22 KB
Raw

Validation

All inputs needed for parity are included. On Linux x64 or Windows x64, install .NET 10, Node.js, and GCC; NuGet supplies Unicorn 2 on Linux, and Windows builds download it. Then run:

dotnet build AIL2.NET.slnx -c Release
dotnet test --project tests/AIL2.NET.Tests -c Release --no-build
dotnet run --project tools/AIL2.NET.Parity -c Release --no-build -- --profile all
dotnet run --project tools/AIL2.NET.Parity -c Release --no-build -- --samples

The build compiles reference/A214_D3/SOUNDFX.C. The music and sample comparisons execute the REL105 WR modules under Unicorn, and the tests also run the A214 real-mode .ADV drivers. Default scenarios generate their XMIDI, VOC, and instrument inputs; no game data is required.

The 1991 driver tests compare against Star Trek: 25th Anniversary's own drivers and songs. Copy them to the ignored game_files/st25th/ as drivers/*.ADV and music/* (the .AD, .MT and .PC songs, GTL.AD and INIT.MT); without them those tests are skipped and the asset-free 1991 contract tests still run.

Parity reports are written under artifacts/parity/. Each report records the input and driver paths and SHA-256 identities, selected profile, observed event or block counts, completion state, timing assumptions, and whether the run passed. See oracle-boundaries.md for the exact hardware substitutions and normalization limits.

The validation runs on 2026-10-27, with the Star Trek: 25th Anniversary files present, produced:

Check Linux x64 Windows x64
Release solution build Zero warnings and errors Zero warnings and errors
Test suite 191 passed; the Windows-only host test skipped 192 passed; zero failures or skips
Music parity 36 comparisons passed across all nine profiles 36 comparisons passed across all nine profiles
Sample parity Four profile comparisons passed; 22 blocks compared Four profile comparisons passed; 22 blocks compared
Player publish (run on 2026-09-06, not repeated) Completed with notices and no oracle or test assemblies Not run

Rendering comparisons feed both event streams through the same NukedOPL3Sharp dependency. They test AIL scheduling, routing, and mixing; they do not establish the synthesizer package's correctness. Avalonia lifecycle tests use its headless backend. The NativeAOT player was compiled on Linux x64, but native window interaction was not exercised without a display.

Windows

The UnicornEngine.Unicorn package ships no Windows library. A Windows build of the parity harness downloads Unicorn 2.1.3's PyPI wheel, checks its pinned SHA-256 and caches its unicorn.dll in artifacts/unicorn/2.1.3/, so the first build needs network access.

Unicorn leaves its generated code through a register-restoring longjmp. Control Flow Guard and CET shadow stacks treat that as hijacked control flow and terminate the process with 0xC0000409 (Unicorn issue 2281). tools/UnicornHost.targets therefore builds the parity and test executables without both, which dotnet run and dotnet test start. dotnet.exe keeps Control Flow Guard, so dotnet AIL2.NET.Parity.dll fails with a message naming it instead of starting Unicorn.