Overview

Read and write NBT data.

Named Binary Tag (NBT) is a structured binary format used throughout Minecraft for a multitude of things. This crate mainly focuses on Minecraft: Bedrock Edition, and supports the little endian and network little endian encoding. Big endian, which is more commonly used in Minecraft: Java Edition, is also supported, however.

Feature flags

• serde - Allows rust types to be serialized and deserialized into NBT using serde.

Examples

NBT data can be constructed and written as follows:

use std::collections::HashMap;
use bytes::BytesMut;
use zuri_nbt::encoding::LittleEndian;
use zuri_nbt::NBTTag;

let mut nbt = HashMap::new();
nbt.insert("name".to_string(), NBTTag::String("Zuri".to_string().into()));
nbt.insert("age".to_string(), NBTTag::Int(18.into()));

let mut buf = BytesMut::new();
NBTTag::Compound(nbt.into()).write(&mut buf, &mut LittleEndian)
    .expect("Something went wrong while writing nbt");

Reading NBT data can be done as follows:

use bytes::Bytes;
use zuri_nbt::encoding::LittleEndian;
use zuri_nbt::NBTTag;

let mut buf = Bytes::from([
   0x08, 0x00, 0x00, 0x0c,
   0x00, 0x48, 0x65, 0x6c,
   0x6c, 0x6f, 0x20, 0x57,
   0x6f, 0x72, 0x6c, 0x64,
   0x21, 0x00, 0x00, 0x00,
].as_ref());

let value = NBTTag::read(&mut buf, &mut LittleEndian)
   .expect("Something went wrong while reading nbt");
assert_eq!(value, NBTTag::String("Hello World!".to_string().into()));