https://github.com/hypothermic/erl_nbt

NBT encoding/decoding library for Erlang/OTP and Elixir.
https://github.com/hypothermic/erl_nbt

erlang named-binary-tag nbt nbt-format nbt-library nbt-parser

Last synced: 7 days ago
JSON representation

NBT encoding/decoding library for Erlang/OTP and Elixir.

• Host: GitHub
• URL: https://github.com/hypothermic/erl_nbt
• Owner: hypothermic
• Created: 2021-06-23T21:01:47.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-08-16T15:10:22.000Z (over 3 years ago)
• Last Synced: 2024-10-12T04:22:21.802Z (about 1 month ago)
• Topics: erlang, named-binary-tag, nbt, nbt-format, nbt-library, nbt-parser
• Language: Erlang
• Homepage:
• Size: 34.2 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
erl_nbt [![Hex.pm Badge](https://img.shields.io/hexpm/v/erl_nbt.svg?style=flat)](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