yog-cli 0.49.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

//! The checked books, entities, bodies and fonts: their data and where
//! it's kept under `.yog-build/generated/`.

use yog_ids::Format;
use yog_ids::sep::PATH;

use crate::content::file::generated;

/// Their folders under `.yog-build/generated/`.
const BOOKS_DIR: &str = "books";
const ENTITIES_DIR: &str = yog_ids::word::ENTITIES;
const FONTS_DIR: &str = "fonts";
const BODY_DIR: &str = "body";
const MODELS_DIR: &str = "models";
const ANIMS_DIR: &str = "anims";

/// One checked `.ybook`.
pub(in crate::content) struct BookFile {
    pub(in crate::content) id: String,
    /// The book as the runtime reads it (`yog_formats::book::Book`'s schema), as
    /// binary Yog Data: the mod hands these bytes over as they are.
    pub(in crate::content) data: Vec<u8>,
}

/// One checked `.yentity`.
pub(in crate::content) struct EntityFile {
    pub(in crate::content) id: String,
    pub(in crate::content) file: String,
    /// Its model and clips, ids with their namespace.
    pub(in crate::content) model: Option<String>,
    pub(in crate::content) animations: Option<String>,
    /// `yog_registry::EntityDef`, as binary Yog Data.
    pub(in crate::content) data: Vec<u8>,
}

impl EntityFile {
    /// Its file under `.yog-build/generated/`.
    pub(in crate::content) fn path(&self) -> String {
        generated(ENTITIES_DIR, &self.id, Format::Data)
    }
}

/// One checked `.ymodel` or `.yanim`.
pub(in crate::content) struct BodyFile {
    pub(in crate::content) model: bool,
    /// `<mod>:<path under content/ without the extension>`.
    pub(in crate::content) id: String,
    /// As `yog_body` reads it: binary Yog Data.
    pub(in crate::content) data: Vec<u8>,
}

/// One checked `.yfont`.
pub(in crate::content) struct FontFile {
    /// `<mod>:<path under content/ without the extension>`.
    pub(in crate::content) id: String,
    /// The built `.yfont`, as binary Yog Data.
    pub(in crate::content) data: Vec<u8>,
}

impl FontFile {
    /// Its file under `.yog-build/generated/`.
    pub(in crate::content) fn path(&self) -> String {
        generated(FONTS_DIR, &self.id, Format::Font)
    }
}

impl BodyFile {
    /// Its file under `.yog-build/generated/`.
    pub(in crate::content) fn path(&self) -> String {
        let dir = if self.model { MODELS_DIR } else { ANIMS_DIR };
        generated(&[BODY_DIR, dir].join(PATH), &self.id, Format::Data)
    }
}

impl BookFile {
    /// Its file under `.yog-build/generated/`.
    pub(in crate::content) fn path(&self) -> String {
        generated(BOOKS_DIR, &self.id, Format::Data)
    }
}