mc-snap 0.6.0

Declarative Minecraft server management. Pin Minecraft, loader, mods, Java, and configs in one YAML file; resolve, install, run, and ship a reproducible bundle.
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

use serde::{Deserialize, Serialize};
use std::path::Path;

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct Lock {
    pub schema: u32,
    pub yml_hash: String,
    pub loader: LockLoader,
    #[serde(default, rename = "mods")]
    pub mods: Vec<LockMod>,
    #[serde(default)]
    pub datapacks: Vec<LockMod>,
    #[serde(default)]
    pub jdk: Option<LockJdk>,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct LockLoader {
    #[serde(rename = "type")]
    pub kind: String,
    pub minecraft: String,
    #[serde(default)]
    pub loader_version: Option<String>,
    #[serde(default)]
    pub installer_version: Option<String>,
    pub server_jar_url: String,
    pub server_jar_sha256: String,
    #[serde(default)]
    pub extra: Vec<LockArtifact>,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct LockMod {
    pub id: String,
    pub provider: String,
    pub version: String,
    pub filename: String,
    pub url: String,
    pub sha256: String,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct LockArtifact {
    pub name: String,
    pub url: String,
    pub sha256: String,
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct LockJdk {
    pub major: u32,
    pub source: String,
    #[serde(default)]
    pub url: Option<String>,
    #[serde(default)]
    pub sha256: Option<String>,
}

impl Lock {
    pub fn from_path(p: &Path) -> anyhow::Result<Self> {
        let s = std::fs::read_to_string(p)?;
        Ok(toml::from_str(&s)?)
    }

    pub fn write(&self, p: &Path) -> anyhow::Result<()> {
        let s = toml::to_string_pretty(self)?;
        // Write atomically via tmp+rename so a crash mid-write can't leave a
        // truncated lockfile that subsequent runs fail to parse.
        let tmp = p.with_extension("lock.tmp");
        std::fs::write(&tmp, s)?;
        std::fs::rename(&tmp, p)?;
        Ok(())
    }

    pub fn content_hash(&self) -> anyhow::Result<String> {
        use sha2::{Digest, Sha256};
        let s = toml::to_string_pretty(self)?;
        let mut hasher = Sha256::new();
        hasher.update(s.as_bytes());
        Ok(hex::encode(hasher.finalize()))
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn roundtrip() {
        let lock = Lock {
            schema: 1,
            yml_hash: "a".repeat(64),
            loader: LockLoader {
                kind: "fabric".into(),
                minecraft: "26.1.2".into(),
                loader_version: Some("0.16.9".into()),
                installer_version: Some("1.0.1".into()),
                server_jar_url: "https://example.com/server.jar".into(),
                server_jar_sha256: "b".repeat(64),
                extra: vec![],
            },
            mods: vec![LockMod {
                id: "fabric-api".into(),
                provider: "modrinth".into(),
                version: "0.110.0".into(),
                filename: "fabric-api.jar".into(),
                url: "https://cdn.modrinth.com/x.jar".into(),
                sha256: "c".repeat(64),
            }],
            datapacks: vec![LockMod {
                id: "terralith".into(),
                provider: "modrinth".into(),
                version: "2.5.0".into(),
                filename: "terralith.zip".into(),
                url: "https://cdn.modrinth.com/dp.zip".into(),
                sha256: "d".repeat(64),
            }],
            jdk: None,
        };
        let s = toml::to_string_pretty(&lock).unwrap();
        let parsed: Lock = toml::from_str(&s).unwrap();
        assert_eq!(lock, parsed);
    }
}