Skip to content

Latest commit

 

History

History
21 lines (12 loc) · 1.42 KB

README.md

File metadata and controls

21 lines (12 loc) · 1.42 KB

Endec

endec is a format-agnostic serialization framework inspired by Rust's serde library and the Codec API from Mojang's DataFixerUpper.

This repository contains the Java implementation. The reference implementation (written in Dart) can be found here.

Repository Structure

This project contains 3 submodules with the root src containing the core endec package which defines the API and contains some base implementations. The nested modules are as follows:

  • gson: Support for Json language using the Gson Library
  • jankson: Support for Json/Json5 language using the Jankson Library
  • netty: Support for the binary format using the Netty Library

Documentation

For the time being, documentation can be found in the owo section of the Wisp Forest docs. The linked document adequately explains the basics but is out-of-date - it will be updated in the future

Acknowledgements

The excellent serde documentation and enjarai's Codec guide on the Fabric Docs have been invaluable during development. Further, glisco is responsible for developing the reference implementation