minetestworld 0.4.0

Read Minetest worlds
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

# minetestworld

This crate lets you read minetest worlds in a low-level way.

[![Build](https://github.com/UgnilJoZ/rust-minetestworld/actions/workflows/rust.yaml/badge.svg)](https://github.com/UgnilJoZ/rust-minetestworld/actions/workflows/rust.yaml)
[![Crates.io](https://img.shields.io/crates/v/minetestworld.svg)](https://crates.io/crates/minetestworld)
[![Documentation](https://docs.rs/minetestworld/badge.svg)](https://docs.rs/minetestworld/latest/minetestworld/)
[![dependency status](https://deps.rs/crate/minetestworld/0.4.0/status.svg)](https://deps.rs/crate/minetestworld/0.4.0)

# Usage
As this crate returns async-std based futures, you have to specify that along the dependencies:
```toml
[dependencies]
minetestworld = "0.4"
async-std = "1"
```

Here is an example that reads all nodes of a specific map block:
```rs
use minetestworld::{World, Position};
use async_std::task;

fn main() {
    let blockpos = Position {
        x: -13,
        y: -8,
        z: 2,
    };
    task::block_on(async {
        let world = World::new("TestWorld");
        let mapdata = world.get_map_data().await.unwrap();
        for (pos, node) in mapdata.iter_mapblock_nodes(blockpos).await.unwrap() {
            println!("{pos:?}, {node:?}");
        }
    });
}
```

## Selectable backends
The Cargo features `sqlite`, `redis`, and `postgres` enable the respective map data backend. They are enabled by default and can be selected individually:
```toml
[dependencies]
minetestworld = { version = "0.4", default-features = false, features = [ "sqlite" ] }
```

This crate only compiles if at least one backend is enabled, because it becomes pointless without.

See [minetest-worldmapper](https://github.com/UgnilJoZ/minetest-worldmapper) for a real-world example.