Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/owengage/fastnbt
Fast serde serializer and deserializer for Minecraft's NBT and Anvil formats
https://github.com/owengage/fastnbt
hacktoberfest minecraft nbt rust
Last synced: 5 days ago
JSON representation
Fast serde serializer and deserializer for Minecraft's NBT and Anvil formats
- Host: GitHub
- URL: https://github.com/owengage/fastnbt
- Owner: owengage
- License: mit
- Created: 2020-05-24T14:36:43.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-08-26T07:41:34.000Z (3 months ago)
- Last Synced: 2024-10-28T23:13:31.117Z (18 days ago)
- Topics: hacktoberfest, minecraft, nbt, rust
- Language: Rust
- Homepage:
- Size: 16.4 MB
- Stars: 195
- Watchers: 4
- Forks: 36
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-minecraft - FastNBT
README
# fastnbt project
![fastnbt-shield]
[![fastnbt-version-shield]][fastnbt-crates]
[![fastnbt-docs-shield]][fastnbt-docs]
[![build-status-shield]][github-actions]
![fastsnbt-shield]
[![fastsnbt-version-shield]][fastsnbt-crates]
[![fastsnbt-docs-shield]][fastsnbt-docs]
![fastanvil-shield]
[![fastanvil-version-shield]][fastanvil-crates]
[![fastanvil-docs-shield]][fastanvil-docs]
[fastnbt-shield]: https://img.shields.io/badge/%20-FastNBT-blue
[fastnbt-version-shield]: https://img.shields.io/crates/v/fastnbt.svg
[fastnbt-docs]: https://docs.rs/fastnbt/latest/fastnbt/index.html
[fastnbt-docs-shield]: https://img.shields.io/docsrs/fastnbt
[fastnbt-crates]: https://crates.io/crates/fastnbt
[fastsnbt-shield]: https://img.shields.io/badge/%20-FastSNBT-blue
[fastsnbt-version-shield]: https://img.shields.io/crates/v/fastsnbt.svg
[fastsnbt-docs]: https://docs.rs/fastsnbt/latest/fastsnbt/index.html
[fastsnbt-docs-shield]: https://img.shields.io/docsrs/fastsnbt
[fastsnbt-crates]: https://crates.io/crates/fastsnbt
[build-status-shield]: https://img.shields.io/github/actions/workflow/status/owengage/fastnbt/rust.yml?branch=master
[github-actions]: https://github.com/owengage/fastnbt/actions?query=branch%3Amaster
[fastanvil-shield]: https://img.shields.io/badge/%20-FastAnvil-blue
[fastanvil-version-shield]: https://img.shields.io/crates/v/fastanvil.svg
[fastanvil-crates]: https://crates.io/crates/fastanvil
[fastanvil-docs-shield]: https://img.shields.io/docsrs/fastanvil
[fastanvil-docs]: https://docs.rs/fastanvil/latest/fastanvil/index.html
FastNBT is a [serde](https://serde.rs/) serializer and deserializer for
_Minecraft: Java Edition's_ NBT format, including
[`Value`](https://docs.rs/fastnbt/latest/fastnbt/enum.Value.html) type and
[`nbt!`](https://docs.rs/fastnbt/latest/fastnbt/macro.nbt.html) macro. For
stringified NBT (sNBT) see FastSNBT.
FastAnvil allows rendering maps of worlds, and a
[`Region`](https://docs.rs/fastanvil/latest/fastanvil/struct.Region.html) for
using the Region file format. Supports 1.20 down to 1.13 inclusive, and slightly
flaky support for 1.12.
An in-browser Rust-to-WASM powered Minecraft map renderer demo is below.
# Demos
Demo of Hermitcraft season 8 and more at [owengage.com/anvil](https://owengage.com/anvil/?world=hermitcraft8)
The `anvil` binary from `fastnbt-tools` can render your world leveraging all of
your CPU.
# Examples
A bunch of examples can be found in
[`fastnbt/examples`](https://github.com/owengage/fastnbt/tree/master/fastnbt/examples),
[`fastanvil/examples`](https://github.com/owengage/fastnbt/tree/master/fastanvil/examples) and [`tools/src`](https://github.com/owengage/fastnbt/tree/master/tools/src/bin). Some examples are recreated below.
# Example: editing level.dat
The following edits the world spawn to 250, 200, 250 (probably not a good
idea!). Full example in fastnbt/examples directory.
```rust
#[derive(Serialize, Deserialize)]
struct LevelDat {
#[serde(rename = "Data")]
data: Data,
}
#[derive(Serialize, Deserialize)]
#[serde(rename_all = "PascalCase")]
struct Data {
spawn_x: i32,
spawn_y: i32,
spawn_z: i32,
#[serde(flatten)]
other: HashMap,
}
fn main() {
let args: Vec<_> = std::env::args_os().collect();
let file = std::fs::File::open(&args[1]).unwrap();
let mut decoder = GzDecoder::new(file);
let mut bytes = vec![];
decoder.read_to_end(&mut bytes).unwrap();
let mut leveldat: LevelDat = fastnbt::from_bytes(&bytes).unwrap();
leveldat.data.spawn_x = 250;
leveldat.data.spawn_y = 200;
leveldat.data.spawn_z = 250;
let new_bytes = fastnbt::to_bytes(&leveldat).unwrap();
let outfile = std::fs::File::create("level.dat").unwrap();
let mut encoder = GzEncoder::new(outfile, Compression::fast());
encoder.write_all(&new_bytes).unwrap();
}
```
# Example: print player inventory
This example demonstrates printing out a players inventory and ender chest contents from the [player dat
files](https://minecraft.wiki/w/Player.dat_format) found in worlds. We
- use serde's renaming attribute to have rustfmt conformant field names,
- use lifetimes to save on string allocations, and
- use the `Value` type to deserialize a field we don't specify the exact
structure of.
```rust
#[derive(Deserialize, Debug)]
#[serde(rename_all = "PascalCase")]
struct PlayerDat<'a> {
data_version: i32,
#[serde(borrow)]
inventory: Vec>,
ender_items: Vec>,
}
#[derive(Deserialize, Debug)]
struct InventorySlot<'a> {
id: &'a str, // We avoid allocating a string here.
tag: Option, // Also get the less structured properties of the object.
// We need to rename fields a lot.
#[serde(rename = "Count")]
count: i8,
}
fn main() {
let args: Vec<_> = std::env::args().skip(1).collect();
let file = std::fs::File::open(args[0].clone()).unwrap();
// Player dat files are compressed with GZip.
let mut decoder = GzDecoder::new(file);
let mut data = vec![];
decoder.read_to_end(&mut data).unwrap();
let player: Result = from_bytes(data.as_slice());
println!("{:#?}", player);
}
```
## Usage
For the libraries
```toml
[dependencies]
fastnbt = "2"
fastanvil = "0.31"
```
For the `anvil` executable
```bash
cargo install fastnbt-tools
```