/Yarhl

Yet Another ROM Hacking Library

Primary LanguageC#MIT LicenseMIT

Yarhl: Yet Another ROM Hacking Library MIT License

Yarhl Logo

Yarhl is a library for ROM Hacking and fan-translation projects. It provides a virtual file system, file format and format conversion features and plugin support. It's built in C# / .NET and works in Windows, Linux and Mac OS X.

NuGet Nuget NuGet Alpha
Build & Test Build Status Azure DevOps tests Azure DevOps coverage
Quality report CII Best Practices Total alerts

Documentation

Check our on-line API overview: Mastering Yarhl and the API documentation here.

Install

Stable releases are available from nuget.org:

Alpha releases can be found in this GitHub package repository.

Build

Since the unit tests are valited against .NET Core and .NET Framework or Mono both runtime must be installed on the machine.

Linux & Mac OS X

Requirements: Mono and .NET Core.

  1. Clone the repository.

  2. Run ./build.sh

Windows

Requirements: .NET Framework and .NET Core.

  1. Clone the repository. You can use the GitHub client or the command-line.

  2. Run .\build.ps1

You can also validate a Linux build using Docker with: docker build .