Crate golden_apple[−][src]
Expand description
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
Usage
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
, in case it isn’t striaghtforward to do so.
Modules
generalized
contains many repetetive and unnecisary functions for reading and writing data.
For sake of completion and inclusiveness, all standard types that may be written over the
stream, no matter how easy to parse, are included here.
Provides tools for reading, writing, and managing NBT types.
Structs
Represents a position in the Minecraft world. Not the floating point values used for player movement, but the whole number values used for things like block positions.
Represents a Java Int (i32) using between 1-5 bytes.
Represents a Java Long (i64) using between 1-10 bytes.
Enums
Represents an error that can occur while using one of the libraries functions.