Crate mcdata

mcdata

A Rust library providing traits and types representing various Minecraft NBT structures.

Overview

Currently, this crate provides three traits along with some implementations of those traits:

• BlockState for block states. See the block_state module for more.
• Entity for normal entities. See the entity module for more.
• BlockEntity for block entities. See the block_entity module for more.

There’s one “generic” implementation for each of these in the corresponding module. Other implementations are locked behind features.

With serde support enabled, all types in this crate can be full serialized and deserialized from/to NBT. The recommended crate for that is fastnbt which is also internally used by the types in this crate. For example entity::GenericEntity is almost fully represented by a fastnbt::Value.

Features

• serde — Provide implementations of serde’s Serialize and Deserialize traits for the various types
• block-states — Include lists for known, typed block states
• entities — Include lists for known, typed entities
• block-entities — Include lists for known, typed block entities
• docs — Enable this when building the docs
• latest — Enable lists for the latest supported Minecraft version
• 1.14 — Enable lists for Minecraft 1.14, extracted from Minecraft 1.14.4
• 1.15 — Enable lists for Minecraft 1.15, extracted from Minecraft 1.15.2
• 1.16 — Enable lists for Minecraft 1.16, extracted from Minecraft 1.16.5
• 1.17-1.18 — Enable lists for Minecraft 1.17-1.18, extracted from Minecraft 1.18.2
• 1.19 — Enable lists for Minecraft 1.19, extracted from Minecraft 1.19.2
• 1.19.3 — Enable lists for Minecraft 1.19.3, extracted from Minecraft 1.19.3
• 1.19.4 — Enable lists for Minecraft 1.19.4, extracted from Minecraft 1.19.4
• 1.20 — Enable lists for Minecraft 1.20, extracted from Minecraft 1.20.1
• 1.20.2 — Enable lists for Minecraft 1.20.2, extracted from Minecraft 1.20.2
• 1.20.3 — Enable lists for Minecraft 1.20.3, extracted from Minecraft 1.20.4
• 1.20.5 — Enable lists for Minecraft 1.20.5, extracted from Minecraft 1.20.6

Re-exports

• pub use block_entity::BlockEntity;
• pub use block_state::BlockState;
• pub use entity::Entity;

Modules

• block_entity
  Types and traits describing Minecraft block entities, a.k.a. tile entities.
• block_state
  Types and traits describing Minecraft block states.
• entity
  Types and traits describing Minecraft entities.
• util
  Other Minecraft related types.