nucleation 0.10.8

A high-performance Minecraft schematic parser and utility library
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236

//! Assemble a build's blocks into a local-origin schematic plus its provenance.
//! Pure: the caller supplies the exact blocks; this never reads the world.

use std::collections::BTreeMap;

use crate::block_entity::BlockEntity;
use crate::block_position::BlockPosition;
use crate::universal_schematic::UniversalSchematic;
use crate::world_segment::ids::ContentId;
use crate::world_segment::provenance::{Provenance, StableBuildId};
use crate::world_segment::score::Tier;
use crate::world_segment::stitch::Build;
use crate::BlockState;
use crate::{ProvenanceBounds, SchematicProvenance};

pub struct MaterializeCtx<'a> {
    pub source_id: &'a str,
    pub snapshot_id: &'a str,
    pub config_hash: ContentId,
    pub profile_hash: ContentId,
    pub extracted_at: i64,
}

pub fn materialize(
    build: &Build,
    blocks: &BTreeMap<(i32, i32, i32), BlockState>,
    tier: Tier,
    stable_id: StableBuildId,
    ctx: &MaterializeCtx,
) -> (UniversalSchematic, Provenance) {
    materialize_with_block_entities(build, blocks, &BTreeMap::new(), tier, stable_id, ctx)
}

/// Materialize a build while retaining NBT-bearing blocks. Block-entity keys
/// and their embedded positions are translated from world space to the
/// schematic's local origin alongside the block states.
pub fn materialize_with_block_entities(
    build: &Build,
    blocks: &BTreeMap<(i32, i32, i32), BlockState>,
    block_entities: &BTreeMap<(i32, i32, i32), BlockEntity>,
    tier: Tier,
    stable_id: StableBuildId,
    ctx: &MaterializeCtx,
) -> (UniversalSchematic, Provenance) {
    debug_assert!(
        blocks.len() as u64 == build.block_count,
        "materialize: {} blocks vs build.block_count {}",
        blocks.len(),
        build.block_count
    );
    let min = build.bbox.0;
    let mut schem = UniversalSchematic::new(stable_id.to_string());
    // BTreeMap iteration is sorted → deterministic placement.
    for (&(x, y, z), state) in blocks.iter() {
        schem.set_block(x - min.0, y - min.1, z - min.2, state);
    }
    for (&(x, y, z), block_entity) in block_entities {
        if !blocks.contains_key(&(x, y, z)) {
            continue;
        }
        let local = (x - min.0, y - min.1, z - min.2);
        let mut translated = block_entity.clone();
        translated.position = local;
        schem.set_block_entity(
            BlockPosition {
                x: local.0,
                y: local.1,
                z: local.2,
            },
            translated,
        );
    }
    let fp = crate::fingerprint::fingerprint(&schem, &fingerprint_spec());
    let prov = Provenance {
        stable_build_id: stable_id,
        snapshot_build_id: build.id,
        source_id: ctx.source_id.to_string(),
        snapshot_id: ctx.snapshot_id.to_string(),
        world_bbox: build.bbox,
        origin_offset: min,
        partition_id: build.partition_id.clone(),
        // Provenance describes the schematic actually materialized from `blocks`,
        // not the build's nominal count; the debug_assert above is the dev-time
        // signal that a caller assembled `blocks` incorrectly for `build`.
        block_count: blocks.len() as u64,
        // Counts the build's member clusters; a cluster that contributed zero
        // blocks (e.g. fully subtracted) is still counted here. Benign.
        cluster_count: build.cluster_ids.len() as u32,
        fingerprint: fp.0,
        tier,
        config_hash: ctx.config_hash,
        profile_hash: ctx.profile_hash,
        extracted_at: ctx.extracted_at,
    };
    let mut embedded =
        SchematicProvenance::new(ctx.source_id).expect("world-segment source_id must be non-empty");
    embedded.snapshot_id = Some(ctx.snapshot_id.to_string());
    embedded.world_bbox = Some(
        ProvenanceBounds::new(
            [build.bbox.0 .0, build.bbox.0 .1, build.bbox.0 .2],
            [build.bbox.1 .0, build.bbox.1 .1, build.bbox.1 .2],
        )
        .expect("build bbox is ordered"),
    );
    embedded.origin = Some([min.0, min.1, min.2]);
    embedded.partition_id = build.partition_id.clone();
    embedded.stable_build_id = Some(stable_id.to_string());
    embedded.extracted_at = Some(ctx.extracted_at);
    embedded.config_hash = Some(ctx.config_hash.to_string());
    embedded.profile_hash = Some(ctx.profile_hash.to_string());
    schem.metadata.provenance = Some(embedded);
    (schem, prov)
}

/// The most exact fingerprint preset, so a content change always shows.
fn fingerprint_spec() -> crate::fingerprint::FingerprintSpec {
    // Most exact preset (verified to exist): block-entities on, no rotation
    // tolerance, so any content change bumps the fingerprint.
    crate::fingerprint::FingerprintSpec::exact()
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::world_segment::ids::{ClusterId, ContentId, TileId};
    use crate::world_segment::provenance::StableBuildId;
    use crate::world_segment::score::Tier;
    use crate::world_segment::stitch::Build;
    use crate::BlockState;
    use std::collections::BTreeMap;

    fn build() -> Build {
        let id = ClusterId::new(
            ContentId::of(&[b"b"]),
            TileId { x: 0, z: 0 },
            None,
            (0, 0, 0),
        );
        Build {
            id,
            cluster_ids: vec![id],
            bbox: ((10, -60, 10), (11, -60, 10)),
            block_count: 2,
            cell_count: 1,
            partition_id: None,
        }
    }

    fn ctx() -> MaterializeCtx<'static> {
        MaterializeCtx {
            source_id: "w",
            snapshot_id: "s",
            config_hash: ContentId::of(&[b"c"]),
            profile_hash: ContentId::of(&[b"p"]),
            extracted_at: 100,
        }
    }

    #[test]
    fn schematic_is_local_origin_normalized() {
        let mut blocks = BTreeMap::new();
        blocks.insert((10, -60, 10), BlockState::new("minecraft:redstone_wire"));
        blocks.insert((11, -60, 10), BlockState::new("minecraft:repeater"));
        let sid = StableBuildId::seed("w", build().id);
        let (schem, prov) = materialize(&build(), &blocks, Tier::Confident, sid, &ctx());
        // Block at world (10,-60,10) lands at local (0,0,0).
        assert_eq!(
            schem.get_block(0, 0, 0).map(|b| b.get_name().to_string()),
            Some("minecraft:redstone_wire".to_string())
        );
        assert_eq!(
            schem.get_block(1, 0, 0).map(|b| b.get_name().to_string()),
            Some("minecraft:repeater".to_string())
        );
        assert_eq!(prov.origin_offset, (10, -60, 10));
        assert_eq!(prov.world_bbox, ((10, -60, 10), (11, -60, 10)));
        assert_eq!(prov.block_count, 2);
        assert_eq!(prov.tier, Tier::Confident);
    }

    #[test]
    fn materialize_is_deterministic() {
        let mut blocks = BTreeMap::new();
        blocks.insert((10, -60, 10), BlockState::new("minecraft:redstone_wire"));
        blocks.insert((11, -60, 10), BlockState::new("minecraft:repeater"));
        let sid = StableBuildId::seed("w", build().id);
        let (_, p1) = materialize(&build(), &blocks, Tier::Confident, sid, &ctx());
        let (_, p2) = materialize(&build(), &blocks, Tier::Confident, sid, &ctx());
        assert_eq!(
            p1, p2,
            "same inputs → identical provenance (incl. fingerprint)"
        );
    }

    #[test]
    fn materialize_translates_and_preserves_block_entities() {
        let mut blocks = BTreeMap::new();
        blocks.insert((10, -60, 10), BlockState::new("minecraft:chest"));
        blocks.insert((11, -60, 10), BlockState::new("minecraft:repeater"));
        let mut block_entities = BTreeMap::new();
        block_entities.insert(
            (10, -60, 10),
            BlockEntity::new("minecraft:chest".to_string(), (10, -60, 10)),
        );
        let sid = StableBuildId::seed("w", build().id);
        let (schem, _) = materialize_with_block_entities(
            &build(),
            &blocks,
            &block_entities,
            Tier::Confident,
            sid,
            &ctx(),
        );
        let entities = schem.get_block_entities_as_list();
        assert_eq!(entities.len(), 1);
        assert_eq!(entities[0].position, (0, 0, 0));
        assert_eq!(entities[0].id, "minecraft:chest");
    }

    /// provenance.block_count tracks the materialized `blocks` map, not
    /// `build.block_count` — they happen to agree here (the debug_assert
    /// requires it), but the assertion is written against `blocks.len()` to
    /// document the actual source of truth. In release builds (where the
    /// debug_assert compiles out), a caller-supplied `blocks` map of a
    /// different length would still produce a correct `provenance.block_count`
    /// because it's derived from `blocks`, not from `build`.
    #[test]
    fn provenance_block_count_tracks_materialized_blocks_not_build() {
        let mut blocks = BTreeMap::new();
        blocks.insert((10, -60, 10), BlockState::new("minecraft:redstone_wire"));
        blocks.insert((11, -60, 10), BlockState::new("minecraft:repeater"));
        let sid = StableBuildId::seed("w", build().id);
        let (_, prov) = materialize(&build(), &blocks, Tier::Confident, sid, &ctx());
        assert_eq!(prov.block_count, blocks.len() as u64);
    }
}