Getting started

Prerequisites

No game files are required for the test suite — tests generate synthetic discs.

Install the CLI

Download rvzsharp_v<version>_<rid>.zip from the GitHub Releases page, unzip it and run RVZSharp (RVZSharp.exe on Windows):

   
rvzsharp_v<version>_win-x64.zip Windows 10/11, x64
rvzsharp_v<version>_win-arm64.zip Windows 11, arm64
rvzsharp_v<version>_linux-x64.zip Linux, x64
rvzsharp_v<version>_linux-arm64.zip Linux, arm64
rvzsharp_v<version>_osx-x64.zip macOS, Intel
rvzsharp_v<version>_osx-arm64.zip macOS, Apple Silicon

Each bundle holds the single-file executable plus LICENSE, README.md, WhatsNew.md and THIRD-PARTY-NOTICES.md. The executables are framework-dependent — the .NET runtime is not embedded — so install the .NET 10 Runtime first (the SDK works too). Verify with RVZSharp --help (also prints the product version). Each release page also carries SHA256SUMS.txt to verify a download. To build from source instead, see Building below.

Repository layout

CSharp_RVZSharp.sln        solution file (fast test suite runs solution-wide)
Directory.Build.props       net10.0, Nullable, ImplicitUsings, TreatWarningsAsErrors
RVZSharp/                   the library
RVZSharp.Cli/               the header/verify/convert/extract tool
RVZSharp.Tests/             fast unit + end-to-end tests (609, ×3 frameworks)
RVZSharp.Cli.Tests/         CLI tests (57: parsing, extract paths, completions, update checker)
RVZSharp.Slow.Tests/        real-file tests (97) — kept out of the solution; run explicitly
RVZSharp.Benchmarks/        BenchmarkDotNet throughput suite (net10.0, in the solution)
References/dolphin-master/  Dolphin source (C++) — format reference
References/rvz-1.0.3/       Go RVZ reader — cross-check reference
docs/                       the wiki (this documentation)

Building

dotnet build CSharp_RVZSharp.sln -c Release

The build treats warnings as errors, so a clean build means zero warnings.

Running the tests

dotnet test CSharp_RVZSharp.sln -c Release

Expected result: Passed: 609, Failed: 0 on each of net8.0, net9.0 and net10.0 (the suite runs once per target framework). The real-file suite is not part of the solution and runs only when requested:

dotnet test RVZSharp.Slow.Tests -c Release   # 276 real-game tests, ~30 min when mounted

To run a single test class:

dotnet test CSharp_RVZSharp.sln -c Release --filter "FullyQualifiedName~RvzWriterTests"

First commands

The CLI speaks the same command surface as Dolphin’s dolphin-tool (plus the legacy info/decode commands):

dotnet run --project RVZSharp.Cli -c Release -- header -i game.iso
dotnet run --project RVZSharp.Cli -c Release -- header -i game.rvz
dotnet run --project RVZSharp.Cli -c Release -- verify -i game.rvz -a sha1
dotnet run --project RVZSharp.Cli -c Release -- convert -i game.wia -o game.rvz -f rvz -c zstd -l 5 -b 131072
dotnet run --project RVZSharp.Cli -c Release -- convert -i game.iso -o game.wia -f wia -c lzma2 -l 5 -b 2097152
dotnet run --project RVZSharp.Cli -c Release -- convert -i game.rvz -o game.iso -f iso

convert accepts any supported input (plain ISO or any legacy format) and writes a fully self-contained RVZ or WIA file (-f iso decodes back to a plain ISO). See the CLI reference for all options.

Notes for contributors