Skip to content

HMCL-dev/HelloNBT

Repository files navigation

HelloNBT

codecov javadoc

A powerful library for reading and writing Minecraft NBT data.

It supports:

  • Supports reading and writing NBT (Named Binary Tag), in both big-endian (used by Minecraft Java Edition) and little-endian (used by Minecraft Bedrock Edition) formats.
  • Supports reading and writing Anvil files and region files, including chunk data over 1MiB.
  • Supports reading NBT compressed by GZip, Zlib, and LZ4.
  • Supports reading and writing SNBT (Stringified Named Binary Tag).
  • Supports NBTPath (a query language for NBT data).

To get started, check out the following tutorials:

We also provide detailed documentation for all APIs, which can be found here: HelloNBT Javadoc.

This library is used for the Hello! Minecraft Launcher. The API is currently unstable.

Download

Gradle:

dependencies {
    implementation("org.glavo:HelloNBT:0.2.0")
}

Maven:

<dependency>
    <groupId>org.glavo</groupId>
    <artifactId>HelloNBT</artifactId>
    <version>0.2.0</version>
</dependency>

License

This project is licensed under the Apache License, Version 2.0.

About

A modern Java library for reading and writing Minecraft NBT files.

Topics

Resources

License

Stars

Watchers

Forks

Contributors

Languages