yog-cli 0.48.0

Yog build tool — `yog build` compiles a mod and packages it as .yog.
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

//! How the mod's blocks and items look in the editors: a block's faces
//! and model, an item's appearance and icon, a potion's colour.

use std::path::Path;
use yog_data::{Map, Value};
use yog_ids::Format;

use super::{ICON_SLOTS, content_file, model_textures, texture_bytes};
use crate::design::project::mod_root;

/// The textures of the mod's block `id` (its `.yblock` model's), per face:
/// up, down, north, south, west, east — as png bytes. `None`: not a block
/// of the mod.
pub fn content_block_faces(root: &Path, id: &str) -> Option<[Option<Vec<u8>>; 6]> {
    let (file, doc) = content_file(root, id, &[Format::Block])?;
    let textures = model_textures(root, &doc, yog_ids::content_field::MODEL);
    let pick = |keys: &[&str]| {
        keys.iter()
            .find_map(|k| textures.get(k).and_then(Value::as_str))
            .or_else(|| textures.values().find_map(Value::as_str))
            .and_then(|t| texture_bytes(&file, t).ok())
    };
    Some(crate::design::blocks3d::FACE_TEXTURES.map(pick))
}

/// A block's model: its elements, and its textures by variable (png bytes).
pub type BlockModel = (Vec<Value>, std::collections::HashMap<String, Vec<u8>>);

/// The model of the mod's block `id` as its `.yblock` gives it: its
/// `elements` and its textures by variable (png bytes). `None`: not a
/// block of the mod, or its model has no elements of its own.
pub fn content_block_model(root: &Path, id: &str) -> Option<BlockModel> {
    let (file, doc) = content_file(root, id, &[Format::Block])?;
    let elements = match crate::design::data::at(
        &doc,
        &[yog_ids::content_field::MODEL, yog_ids::model::ELEMENTS],
    )
    .and_then(Value::as_list)
    {
        Some(elements) => elements.to_vec(),
        None if doc
            .get(yog_ids::content_field::KIND)
            .and_then(Value::as_str)
            == Some("stairs") =>
        {
            vec![
                stair_element([0, 0, 0], [16, 8, 16]),
                stair_element([0, 8, 8], [16, 16, 16]),
            ]
        }
        None => return None,
    };
    let textures = model_textures(root, &doc, yog_ids::content_field::MODEL)
        .iter()
        .filter_map(|(k, v)| Some((k.to_string(), texture_bytes(&file, v.as_str()?).ok()?)))
        .collect();
    Some((elements, textures))
}

fn stair_element(from: [u8; 3], to: [u8; 3]) -> Value {
    use yog_ids::direction as d;
    let face = |texture: &str| -> Value {
        let slot = format!("{}{texture}", yog_formats::content::SLOT_MARK);
        Map::from_iter([(yog_ids::model::TEXTURE, Value::from(slot))]).into()
    };
    let corner = |c: [u8; 3]| Value::List(c.iter().map(|&n| Value::Int(n.into())).collect());
    let faces = Map::from_iter([
        (d::UP, face("top")),
        (d::DOWN, face("bottom")),
        (d::NORTH, face("side")),
        (d::SOUTH, face("side")),
        (d::WEST, face("side")),
        (d::EAST, face("side")),
    ]);
    Map::from_iter([
        (yog_ids::model::FROM, corner(from)),
        (yog_ids::model::TO, corner(to)),
        (yog_ids::model::FACES, faces.into()),
    ])
    .into()
}

/// A mod item's definition and, for potions, its effect-derived color.
pub fn content_item_appearance(root: &Path, id: &str) -> Option<(Value, Option<u32>)> {
    let ns = crate::design::project::mod_id(root)?;
    let (want_ns, want) = yog_ids::split(id);
    let want = if want_ns == yog_ids::ns::YOG {
        want.strip_prefix(yog_ids::split(yog_ids::yog::POTION_ALIAS).1)?
    } else if want_ns == ns {
        want
    } else {
        return None;
    };
    for file in crate::files::of(&root.join("content/items"), Format::Item) {
        let Ok(text) = crate::files::read_source(&file) else {
            continue;
        };
        let Some(doc) = crate::design::data::read_object(&text) else {
            continue;
        };
        let Some(fid) = doc
            .get(yog_ids::content_field::ID)
            .and_then(Value::as_str)
            .or_else(|| file.file_stem().and_then(|s| s.to_str()))
        else {
            continue;
        };
        if fid.split_once(':').map_or(fid, |(_, p)| p) != want {
            continue;
        }
        let definition = doc;
        let color = potion_effect_color(root, &definition);
        return Some((definition, color));
    }
    None
}

fn potion_effect_color(root: &Path, item: &Value) -> Option<u32> {
    let effects = crate::design::data::at(
        item,
        &[
            yog_ids::content_field::ITEM,
            yog_ids::content_field::POTION,
            yog_ids::content_field::EFFECTS,
        ],
    )?
    .as_list()?;
    let mut channels = [0u64; 3];
    let mut count = 0u64;
    for effect in effects {
        let Some(id) = effect
            .get(yog_ids::content_field::EFFECT)
            .and_then(Value::as_str)
        else {
            continue;
        };
        let Some(color) = content_effect_color(root, id) else {
            continue;
        };
        channels[0] += u64::from((color >> 16) & 0xFF);
        channels[1] += u64::from((color >> 8) & 0xFF);
        channels[2] += u64::from(color & 0xFF);
        count += 1;
    }
    (count > 0).then(|| {
        (((channels[0] / count) as u32) << 16)
            | (((channels[1] / count) as u32) << 8)
            | (channels[2] / count) as u32
    })
}

/// The color of the potion effect(s) defined by this `.yitem`.
pub fn item_potion_color(file: &Path) -> Option<u32> {
    let root = mod_root(file)?;
    let text = crate::files::read_source(file).ok()?;
    let item = crate::design::data::read_object(&text)?;
    potion_effect_color(&root, &item)
}

fn content_effect_color(root: &Path, reference: &str) -> Option<u32> {
    let mod_ns = crate::design::project::mod_id(root)?;
    let id = reference.strip_prefix("@effect:").unwrap_or(reference);
    let (ns, want) = yog_ids::split(id);
    if ns != mod_ns {
        return None;
    }
    for file in crate::files::of(&root.join("content/effects"), Format::Def) {
        let Ok(text) = crate::files::read_source(&file) else {
            continue;
        };
        let Some(doc) = crate::design::data::read_object(&text) else {
            continue;
        };
        let Some(id) = doc
            .get(yog_ids::content_field::ID)
            .and_then(Value::as_str)
            .or_else(|| file.file_stem().and_then(|s| s.to_str()))
        else {
            continue;
        };
        if id.split_once(':').map_or(id, |(_, p)| p) == want {
            return doc
                .get(yog_ids::content_field::COLOR)
                .and_then(Value::as_i64)
                .and_then(|v| u32::try_from(v).ok());
        }
    }
    None
}

/// The icon of the mod's item or block `id` as its `content/` file draws
/// it: the model's `layer0` (else its first texture), as png bytes.
pub fn content_icon(root: &Path, id: &str) -> Option<Vec<u8>> {
    let ns = crate::design::project::mod_id(root)?;
    let (want_ns, want) = yog_ids::split(id);
    if want_ns != ns {
        return None;
    }
    let files = [
        crate::files::of(&root.join(yog_ids::project::CONTENT), Format::Item),
        crate::files::of(&root.join(yog_ids::project::CONTENT), Format::Block),
    ]
    .concat();
    for file in files {
        let Ok(text) = crate::files::read_source(&file) else {
            continue;
        };
        let Some(doc) = crate::design::data::read_object(&text) else {
            continue;
        };
        let fid = doc
            .get(yog_ids::content_field::ID)
            .and_then(Value::as_str)
            .map(str::to_string)
            .or_else(|| file.file_stem().map(|s| s.to_string_lossy().into_owned()))?;
        let fid = fid
            .split_once(':')
            .map_or(fid.as_str(), |(_, p)| p)
            .to_string();
        if fid != want {
            continue;
        }
        let textures = model_textures(root, &doc, yog_ids::content_field::MODEL);
        let tex = textures
            .get(yog_ids::model::LAYER0)
            .or_else(|| ICON_SLOTS.iter().find_map(|k| textures.get(k)))
            .or_else(|| textures.values().next())?
            .as_str()?;
        return texture_bytes(&file, tex).ok();
    }
    None
}