YellowDogMan.Verify.ssimulacra2 0.1.0

Prefix Reserved
dotnet add package YellowDogMan.Verify.ssimulacra2 --version 0.1.0
                    
NuGet\Install-Package YellowDogMan.Verify.ssimulacra2 -Version 0.1.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="YellowDogMan.Verify.ssimulacra2" Version="0.1.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="YellowDogMan.Verify.ssimulacra2" Version="0.1.0" />
                    
Directory.Packages.props
<PackageReference Include="YellowDogMan.Verify.ssimulacra2" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add YellowDogMan.Verify.ssimulacra2 --version 0.1.0
                    
#r "nuget: YellowDogMan.Verify.ssimulacra2, 0.1.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package YellowDogMan.Verify.ssimulacra2@0.1.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=YellowDogMan.Verify.ssimulacra2&version=0.1.0
                    
Install as a Cake Addin
#tool nuget:?package=YellowDogMan.Verify.ssimulacra2&version=0.1.0
                    
Install as a Cake Tool

Verify.ssimulacra2

Enables you to use Ssimulacra2.Net as a Verify, Image Comparer.

Status

WIP, see issue list.

Setup

If you are new to Verify we recommend following Verify's Setup Guide.

Once you're setup and comfortable, you'll need to register the Ssimulacra2 comparer. There's a couple of ways to do this depending on your needs.

Statically

If you want to use the Ssimulacra2 comparer statically, you can use the following code:

[ModuleInitializer]
public static void Init()
{
    VerifySsimulacra2.Initialize();
}

Which will automatically register the comparer.

TODO: This might also occur if you use, VerifierSettings.InitializePlugins(), e.g.

[ModuleInitializer]
    public static void InitOther() =>
        VerifierSettings.InitializePlugins();

We need to double check.

Dynamically when you need it

await VerifyFile("carrots.png")
        .WithSsimulacra2(90);
    await VerifyFile("carrots.png")
        .WithSsimulacra2(Ssimulacra2Quality.VisuallyLossless);

Scores

Scoring is based on the original Ssimulacra2 tool's Readme and is formally defined in the Ssimulacra2.Net Enum Ssimulacra2Quality. You can always use it as a number(e.g. 50), or an enum value such as Ssimulacra2Quality.VisuallyLossless.

By default the threshold is set to Ssimulacra2Quality.VisuallyLossless or 90.

Test Images

Test images are from TestImages.Org.

Contributing

If you have any suggestions or improvements, please feel free to open an issue or submit a pull request. We're new to making extensions for Verify and would love to improve things.

Product Compatible and additional computed target framework versions.
.NET net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.1.0 121 7/17/2025

Initial release