Tkmm.BymlLibrary 1.0.14

<div align="center"> <img src="https://github.com/EPD-Libraries/BymlLibrary/blob/master/icon.png" width="100vh"> <h1>-   BYML Library   -</h1> </div>

Modern Binary Yml IO library written in managed C#

Supports versions 2-7.

[!NOTE] Some v7 nodes may not be supported, but everything used in TotK is.

• Usage
  • Reading a Byml File
  • Reading a Byml for Read-Only use (Much Faster)
  • Writing a Byml File
• Benchmarks
  • Install
    • NuGet
    • Build From Source

Usage

Reading a Byml File

using BymlLibrary;
using Revrs;

byte[] data = File.ReadAllBytes("path/to/file.byml");
Byml byml = Byml.FromBinary(data);

Reading a Byml for Read-Only use (Much Faster)

using BymlLibrary;
using Revrs;

byte[] data = File.ReadAllBytes("path/to/file.byml");
RevrsReader reader = new(data);
ImmutableByml byml = new(ref reader);

Writing a Byml File

/* ... */

// Avoid writing directly to
// a file stream. Seeking is
// much slower and used extensively
// during serialization.
using MemoryStream ms = new();
byml.WriteBinary(ms, Endianness.Little);

// Write to a byte[]
byte[] data = byml.ToBinary(Endianness.Little);

Benchmarks

Benchmarks for Actors/ActorInfo.product.byml (BotW for Switch | 1.9 MB)

Benchmarks for GameData/GameDataList.Product.110.byml (TotK 1.2.1 | 12.4 MB)

Benchmarks for the test file (contains one of every node in a Map)

[!NOTE] ns (nanoseconds) is not μs (microseconds)

Install

NuGet

Install-Package BymlLibrary

Build From Source

git clone https://github.com/EPD-Libraries/BymlLibrary.git
dotnet build BymlLibrary

Special thanks to Léo Lam for his extensive research on EPD file formats.