VOOZH about

URL: https://www.nuget.org/packages/Yarhl.Plugins

⇱ NuGet Gallery | Yarhl.Plugins 4.1.0




👁 Image
Yarhl.Plugins 4.1.0

dotnet add package Yarhl.Plugins --version 4.1.0
 
 
NuGet\Install-Package Yarhl.Plugins -Version 4.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="Yarhl.Plugins" Version="4.1.0" />
 
 
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Yarhl.Plugins" Version="4.1.0" />
 
Directory.Packages.props
<PackageReference Include="Yarhl.Plugins" />
 
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 Yarhl.Plugins --version 4.1.0
 
 
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Yarhl.Plugins, 4.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 Yarhl.Plugins@4.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=Yarhl.Plugins&version=4.1.0
 
Install as a Cake Addin
#tool nuget:?package=Yarhl.Plugins&version=4.1.0
 
Install as a Cake Tool
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Yarhl, A format ResearcH Library

Yarhl is a set of libraries that helps to implement and convert file formats It empowers you with...

  • ♻️ ... APIs to easily convert between custom formats.
  • 📚 ... guidelines to implement and test custom format converters.
  • 🔢 ... advance binary and text reading / writing, encoding and serialization.
  • 📃 ... standard formats implementation like PO for translations.
  • 📂 ... virtual file system to unpack and pack containers efficiently.
  • 🔌... plugin API to find formats and converters in .NET assemblies.

Usage

The project has the following .NET libraries (NuGet packages via nuget.org). The libraries support .NET (Core) LTS versions.

  • 👁 Yarhl
    • Yarhl.FileFormat: format conversion APIs.
    • Yarhl.FileSystem: virtual file system.
    • Yarhl.IO: streams, binary and text reading / writing.
  • 👁 Yarhl.Media.Text
    • Yarhl.Media.Text: translation formats and converters (Po), table replacer.
    • Yarhl.Media.Text.Encoding: euc-jp and token-escaped encodings.
  • 👁 Yarhl.Plugins
    • Yarhl.Plugins: load nearby .NET assemblies and find type implementations.
    • Yarhl.Plugins.FileFormat: find formats and converters from loaded assemblies.

Are you planning to try a preview version?
Check-out the project README for details on how to set up the NuGet preview feed for SceneGate projects.

Quick demo

Yarhl allows you to work with different file formats with a unified API for conversion into binary (serialization / deserialization). Let's try to create a new translatable file format PO from and save it into disk.

[!code-csharp]

It's frequent to find formats that are containers. Yarhl allows having a virtual file system to work with its content without having to extract it into disk (saving space and time). For instance, let's open a game file from Nintendo DS that contains thousand of files. Then we will navigate through its files, unpacking, decompressing and finally converting one file into PO. We can use the following libraries for this task:

  • Ekona: support of NDS game file system.
  • LayTea: support of formats from Professor Layton games.

[!code-csharp]

Showcase

Some cool projects built with Yarhl:

  • Texim: experimental API for image file formats.
  • Ekona: support Nintendo DS file formats.
  • Lemon: support Nintendo 3DS file formats.
  • LayTea: modding tools for Professor Layton games.
  • Attack of Friday Monsters tools: modding tools for Attack of the Friday Monsters game.
  • Metatron: translation framework for Shin Megami Tensei saga games.

License

The software is licensed under the terms of the MIT license.

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

  • net8.0

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
4.1.0 143 4/16/2026
4.0.0 315 1/31/2024

Check the project site