yog-formats 0.7.0

The schemas of Yog's source formats — .yblock/.yitem, .yrecipe, .ydef, .yres, yog.toml — for the build and the editors.
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

//! `yog.toml` — a mod project's manifest (TOML, read into Yog Data).

use yog_data::{Ordered, Schema, Text, Value};

/// `[mod]`.
#[derive(Schema)]
pub struct ModSection {
    /// The mod's id — its namespace (`mymod`).
    pub id: String,
    /// Shown name: text or a `.yres` text (`@Strings.mod_name`).
    pub name: Option<Text>,
    pub version: Option<String>,
    pub description: Option<Text>,
    /// An image source or a `.yres` image (`@Icons.logo`).
    pub icon: Option<yog_data::Image>,
    #[data(default)]
    pub authors: Vec<String>,
    pub license: Option<String>,
    /// License of the generated exports crate (default MIT OR Apache-2.0).
    pub exports_license: Option<String>,
    /// The Minecraft version whose vanilla content the mod names (its
    /// datapack: `1.21.1`) — the newest Yog supports by default. On other
    /// versions renamed content is mapped (`short_grass` is `grass` on 1.20.1).
    pub datapack: Option<String>,
    /// Rust edition (default 2024).
    pub edition: Option<String>,
}

/// `[dev]`.
#[derive(Schema)]
pub struct DevSection {
    /// A local yog-api checkout to build against.
    pub yog_api_path: Option<String>,
}

/// `[run."<name>"]`: a dev instance `yog run <name>` builds into and starts.
#[derive(Schema)]
pub struct RunSection {
    pub name: Option<String>,
    pub export_dir: Option<String>,
    pub command: Option<String>,
    #[data(default)]
    pub args: Vec<String>,
    pub cwd: Option<String>,
    /// `KEY=VALUE` pairs.
    #[data(default)]
    pub env: Vec<String>,
}

/// `[external.<namespace>]`: the other mods' content this mod names.
#[derive(Schema)]
pub struct ExternalSection {
    #[data(default)]
    pub items: Vec<String>,
    #[data(default)]
    pub blocks: Vec<String>,
    #[data(default)]
    pub entities: Vec<String>,
    #[data(default)]
    pub recipes: Vec<String>,
}

/// A whole `yog.toml`.
#[derive(Schema)]
pub struct ManifestFile {
    #[data(rename = "mod")]
    pub module: ModSection,
    pub dev: Option<DevSection>,
    /// Crates as Cargo writes them; `exports` is the other Yog mods'.
    #[data(default)]
    pub dependencies: Ordered<Value>,
    #[data(rename = "dev-dependencies", default)]
    pub dev_dependencies: Ordered<Value>,
    #[data(default)]
    pub run: Ordered<RunSection>,
    #[data(default)]
    pub external: Ordered<ExternalSection>,
}