Yarhl: Yet Another ROM Hacking Library
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 | |
---|---|
Build & Test | |
Quality report | |
Coverage | |
Project Best Practices | |
Quality Details | |
Code Stats |
Documentation
Check our on-line API overview: Mastering Yarhl and the API documentation here.
Install
Yarhl is available on NuGet:
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.
-
Clone the repository.
-
Run
./build.sh
Windows
Requirements: .NET Framework and .NET Core.
-
Clone the repository. You can use the GitHub client or the command-line.
-
Run
.\build.ps1
You can also validate a Linux build using Docker with:
docker build .