concinnity-cook 0.19.1

Authored world model, validation, and the asset cook pipeline that bakes a Concinnity world into a blob
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

// asset_impls/voxel_chunk.rs

use concinnity_core::components::VoxelChunk;

impl crate::asset::BuildAsset for VoxelChunk {
    fn compile_payload(
        args: &serde_json::Value,
        ctx: &crate::asset::BuildCtx<'_>,
    ) -> std::io::Result<Vec<u8>> {
        let palette_lookup = |bt_name: &str| {
            ctx.all_assets
                .iter()
                .find(|a| {
                    let tn = a.asset_type.to_lowercase().replace('_', "");
                    (tn == "blocktype" || tn == "block") && a.name == bt_name
                })
                .map(|a| a.args.clone())
        };
        crate::compile::geometry::compile_voxel_chunk_payload(args, palette_lookup)
            .map_err(|e| std::io::Error::new(std::io::ErrorKind::InvalidData, e))
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::asset::{BuildAsset, BuildCtx};
    use crate::authoring::world::WorldJsonlAsset;

    fn block_type(name: &str, asset_type: &str) -> WorldJsonlAsset {
        WorldJsonlAsset {
            name: name.to_string(),
            asset_type: asset_type.to_string(),
            args: serde_json::json!({"solid": true}),
        }
    }

    fn args() -> serde_json::Value {
        serde_json::json!({"dim": [1, 1, 1], "palette": ["stone"], "blocks": [0]})
    }

    #[test]
    fn the_palette_resolves_against_sibling_block_type_assets() {
        // The declared type is matched case- and underscore-insensitively.
        for type_name in ["BlockType", "block_type", "block"] {
            let assets = [block_type("stone", type_name)];
            let ctx = BuildCtx {
                name: "chunk",
                platform: concinnity_core::platform::Platform::Metal,
                assets_dir: None,
                artifacts_dir: None,
                all_assets: &assets,
            };
            let payload = VoxelChunk::compile_payload(&args(), &ctx).expect("chunk compiles");
            let expected = crate::compile::geometry::compile_voxel_chunk_payload(&args(), |_| {
                Some(serde_json::json!({"solid": true}))
            })
            .unwrap();
            assert_eq!(payload, expected, "type '{type_name}' should resolve");
        }
    }

    #[test]
    fn a_block_type_with_another_name_does_not_satisfy_the_palette() {
        let assets = [block_type("dirt", "BlockType")];
        let ctx = BuildCtx {
            name: "chunk",
            platform: concinnity_core::platform::Platform::Metal,
            assets_dir: None,
            artifacts_dir: None,
            all_assets: &assets,
        };
        let err = VoxelChunk::compile_payload(&args(), &ctx).unwrap_err();
        assert_eq!(err.kind(), std::io::ErrorKind::InvalidData);
        assert!(
            err.to_string()
                .contains("palette entry 'stone' has no matching BlockType"),
            "got: {err}"
        );
    }

    #[test]
    fn a_compile_error_is_reported_as_invalid_data() {
        let ctx = BuildCtx {
            name: "chunk",
            platform: concinnity_core::platform::Platform::Metal,
            assets_dir: None,
            artifacts_dir: None,
            all_assets: &[],
        };
        let err = VoxelChunk::compile_payload(&serde_json::json!({}), &ctx).unwrap_err();
        assert_eq!(err.kind(), std::io::ErrorKind::InvalidData);
        assert!(err.to_string().contains("dim"), "got: {err}");
    }
}