Skip to content

Format-agnostic serialization library for Minecraft formats

License

MineJason/serialization

Repository files navigation

MineJason.Serialization

GitHub Actions Workflow Status GitHub commit activity

MineJason.Serialization is a serialization library that deals with DOM and value types through format-agnostic schema.

It was grown out of the need of a robust, schema-based and format-agnostic serialization and deserialization between values, and their DOM format, during the development of MineJason.

The library consists of two critical functions:

  • Encoder and decoders, which encodes CLR primitives to their target DOM equivalent;
  • Schemas, which are responsible for encoding and decoding further, more complex types.

Install

Use NuGet to install the library to the project. To consume pre-release versions, make sure to specify --prerelease or check the "Pre-release" (or similar) box in your NuGet client (e.g. IDE).

Package Version
MineJason.Serialization NuGet Version
MineJason.Serialization.fNbt NuGet Version

Building

The library needs .NET SDK of at least 9.0 to build.

To build the project, navigate to the solution root and run:

dotnet build --configuration "Release"

License

Apache-2.0

About

Format-agnostic serialization library for Minecraft formats

Resources

License

Stars

Watchers

Forks

Languages