Overview

golden_apple is a library for decoding, encoding, and using common types found in Minecraft: Java Edition.

Goals

• Provide a generalized format for sharing and using Minecraft's data types
• Simplify the decoding and encoding of network data
• Abstract away enums usually passed as numbers

Usage

Parsing NBT

let mut nbt_file_reader = std::fs::File::open("test.nbt")
    .expect("Unable to open file!");

match golden_apple::nbt::from_reader(&mut nbt_file_reader) {
    Ok(named_tag) => {
        println!("NBT Data: {:#?}", named_tag);
    }
    Err(e) => {
        panic!("Unable to parse NBT! ({:?})", e);
    }
}

Other

Proprietary Minecraft types like VarInt, VarLong, and Position are a part of the top level crate. Types that can be fully represented in Rust have encoders/decoders under golden_apple::generalized for reading and writing from both byte arrays and Rust's Read/Write traits. Communicating with existing servers and clients can be done using the packet format and tools found in the netty module.

Status

This crate is unfinished and some features aren't yet present. Here's an overview of what's still in progress:

• Metadata
• Slot
• Netty (13.1%)
• Other General Enums (~50%)

Cargo Features

There is one Cargo feature flag for this crate, encryption. It is not complete at this time and currently does nothing. Eventually, this will enable methods for handling packets when encryption is enabled between the server and client.

Version Support

Changelog