modcrawl 0.2.0

Detect, inspect, and analyze Minecraft mods and plugins from JAR files
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

use std::collections::HashMap;
use std::fmt;

use serde::{Deserialize, Serialize};
use serde_json::Value;

use crate::error::Result;

pub fn parse(input: &str) -> Result<ModsTomlMetadata> {
    Ok(toml::from_str(input)?)
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct ModsTomlMetadata {
    #[serde(rename = "modLoader")]
    pub mod_loader: Option<String>,
    #[serde(rename = "loaderVersion")]
    pub loader_version: Option<String>,
    #[serde(rename = "issueTrackerURL")]
    pub issue_tracker_url: Option<String>,
    pub license: Option<String>,
    #[serde(default)]
    pub mods: Vec<ModsTomlMod>,
    #[serde(default)]
    pub dependencies: HashMap<String, Vec<ModsTomlDependency>>,
    #[serde(rename = "displayURL")]
    pub display_url: Option<String>,
    #[serde(rename = "logoFile")]
    pub logo_file: Option<String>,
    pub authors: Option<String>,
    pub credits: Option<String>,
    #[serde(rename = "showAsResourcePack")]
    pub show_as_resource_pack: Option<bool>,
    #[serde(rename = "clientSideOnly")]
    pub client_side_only: Option<bool>,
    #[serde(default)]
    pub mixins: Vec<ModsTomlMixin>,
    #[serde(default)]
    pub modproperties: HashMap<String, Value>,
    #[serde(rename = "enumExtensions")]
    pub enum_extensions: Option<String>,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct ModsTomlMod {
    #[serde(rename = "modId")]
    pub mod_id: String,
    pub version: Option<String>,
    #[serde(rename = "displayName")]
    pub display_name: Option<String>,
    #[serde(rename = "displayURL")]
    pub display_url: Option<String>,
    pub authors: Option<Value>,
    pub description: Option<String>,
    #[serde(rename = "logoFile")]
    pub logo_file: Option<String>,
    pub license: Option<String>,
    pub credits: Option<String>,
    #[serde(rename = "updateJSONURL")]
    pub update_jsonurl: Option<String>,
    #[serde(rename = "displayTest")]
    pub display_test: Option<String>,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct ModsTomlDependency {
    #[serde(rename = "modId")]
    pub mod_id: String,
    #[serde(rename = "type")]
    pub dep_type: Option<String>,
    pub mandatory: Option<bool>,
    #[serde(rename = "versionRange")]
    pub version_range: Option<String>,
    pub ordering: Option<String>,
    pub side: Option<String>,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct ModsTomlMixin {
    pub config: String,
}

impl fmt::Display for ModsTomlMetadata {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        if let Some(l) = &self.mod_loader {
            writeln!(f, "Loader:   {l}")?;
        }
        if let Some(lv) = &self.loader_version {
            writeln!(f, "LoaderV:  {lv}")?;
        }
        for mod_entry in &self.mods {
            writeln!(f, "Mod ID:   {}", mod_entry.mod_id)?;
            if let Some(n) = &mod_entry.display_name {
                writeln!(f, "Name:     {n}")?;
            }
            if let Some(d) = &mod_entry.description {
                writeln!(f, "About:    {d}")?;
            }
            if let Some(v) = &mod_entry.version {
                writeln!(f, "Version:  {v}")?;
            }
            if let Some(a) = &mod_entry.authors {
                writeln!(f, "Authors:  {a}")?;
            }
        }
        if !self.dependencies.is_empty() {
            use std::collections::{HashMap, HashSet};
            writeln!(f, "Dependencies:")?;
            let mut merged: HashMap<&str, (&str, HashSet<Option<&str>>)> = HashMap::new();
            for deps in self.dependencies.values() {
                for dep in deps {
                    let (vr, sides) = merged.entry(dep.mod_id.as_str()).or_insert_with(|| {
                        (dep.version_range.as_deref().unwrap_or("*"), HashSet::new())
                    });
                    sides.insert(dep.side.as_deref());
                    let new_vr = dep.version_range.as_deref().unwrap_or("*");
                    if new_vr != *vr {
                        *vr = new_vr;
                    }
                }
            }
            for (mod_id, (vr, sides)) in &merged {
                let suffix = match sides.len() {
                    1 => match sides.iter().next().and_then(|s| *s) {
                        Some("CLIENT") => " (Client)",
                        Some("SERVER") => " (Server)",
                        _ => "",
                    },
                    _ => "",
                };
                writeln!(f, "  - {mod_id} ({vr}){suffix}")?;
            }
        }
        Ok(())
    }
}