erl_nbt [](https://hex.pm/packages/erl_nbt)
=====
An Erlang/OTP library which can manipulate NBT (Named Binary Tag) data.
This library currently is up to date with the [1.0 spec](https://web.archive.org/web/20110723210920/http://www.minecraft.net/docs/NBT.txt).
Quick navigation:
[Build](#building-the-library)
[Usage](#using-the-library)
[Documentation](#documentation)
[Legal](#legal-notice)
-----
Building the library
-----
| Operation | Command |
| ------------- | ----------------- |
| Compile | `rebar3 compile` |
| Test | `rebar3 eunit` |
| Verify | `rebar3 dialyzer` |
| Documentation | `rebar3 edoc` |
Using the library
-----
The easiest way to use the library is to declare it as a dependency in your build config.
Your build tool will automatically download the latest version from [Hex](https://hex.pm/packages/erl_nbt).
Depending on your build tool, add the following line to the "dependencies" section:
| Build Tool | Dependency line |
| --------------------- | ------- |
| rebar3 (Erlang/OTP) | `{erl_nbt, "1.0.0"}` |
| mix (Elixir) | `{:erl_nbt "~> 1.0.0"}` |
| erlang.mk (Erlang) | `dep_erl_nbt = hex 1.0.0` |
Documentation
-----
The documentation can be generated locally by running `rebar3 edoc`.
A pre-generated version can be viewed online on [Hex docs](https://hexdocs.pm/erl_nbt/).
Version history
-----
| Version Tag | Notes |
| ----------- | ------------------------------------------------------------------------------ |
| 0.1.0 | Initial release |
| 0.2.0 | Improved Erlang data structure representation, support for typed array tags |
| 1.0.0 | Support for typed lists, let user give encoder/decoder options, solidify API |
Legal notice
-----
erl_nbt Copyright (C) 2021 hypothermic.nl
