feat: add more stuff to mod project config

Author: Crauzer

crates/mod-project/Cargo.toml

@@ -6,3 +6,4 @@ edition = "2021"
 [dependencies]
 serde = { version = "1.0", features = ["derive"] }
 toml = "0.8.19"
+serde_json = "1.0"

crates/mod-project/src/lib.rs

@@ -1,45 +1,157 @@
 use serde::{Deserialize, Serialize};
+use std::collections::HashMap;
 
-#[derive(Serialize, Deserialize, Debug, PartialEq, PartialOrd)]
+/// Describes a mod project configuration file
+#[derive(Serialize, Deserialize, Debug, PartialEq)]
 pub struct ModProject {
+    /// The name of the mod
+    /// Must not contain spaces or special characters except for underscores and hyphens
+    ///
+    /// Example: `my_mod`
     pub name: String,
+
+    /// The display name of the mod.
+    ///
+    /// Example: `My Mod`
     pub display_name: String,
+
+    /// The version of the mod
+    ///
+    /// Example: `1.0.0`
     pub version: String,
+
+    /// The description of the mod
+    ///
+    /// Example: `This is a mod for my game`
     pub description: String,
+
+    /// The authors of the mod
     pub authors: Vec<ModProjectAuthor>,
+
+    /// File transformers to be applied during the build process
+    /// Optional field - if not provided, no transformers will be applied
+    #[serde(default, skip_serializing_if = "Vec::is_empty")]
+    pub transformers: Vec<FileTransformer>,
+
+    /// Layers of the mod project
+    /// Layers are loaded in order of priority (highest priority last)
+    /// If not specified, a default "base" layer with priority 0 is assumed
+    #[serde(default = "default_layers")]
+    pub layers: Vec<ModLayer>,
+}
+
+/// Returns the default layers for a mod project
+fn default_layers() -> Vec<ModLayer> {
+    vec![ModLayer {
+        name: "base".to_string(),
+        priority: 0,
+        description: Some("Base layer of the mod".to_string()),
+    }]
 }
 
-#[derive(Serialize, Deserialize, Debug, PartialEq, PartialOrd)]
+/// Represents a layer in a mod project
+#[derive(Serialize, Deserialize, Debug, PartialEq, Clone)]
+pub struct ModLayer {
+    /// The name of the layer
+    /// Must not contain spaces or special characters except for underscores and hyphens
+    ///
+    /// Example: `base`, `high_res_textures`, `gameplay_overhaul`
+    pub name: String,
+
+    /// The priority of the layer
+    /// Higher priority layers override lower priority layers when they modify the same files
+    /// Default is 0 for the base layer
+    pub priority: i32,
+
+    /// Optional description of the layer
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub description: Option<String>,
+}
+
+#[derive(Serialize, Deserialize, Debug, PartialEq)]
 #[serde(untagged)]
 pub enum ModProjectAuthor {
     Name(String),
     Role { name: String, role: String },
 }
 
+/// Represents a file transformer that can be applied to files during the build process
+#[derive(Serialize, Deserialize, Debug, PartialEq, Clone)]
+pub struct FileTransformer {
+    /// The name of the transformer to use.
+    pub name: String,
+
+    /// File patterns to apply this transformer to.
+    /// At least one of `patterns` or `files` must be provided
+    #[serde(default, skip_serializing_if = "Vec::is_empty")]
+    pub patterns: Vec<String>,
+
+    /// Specific files to apply this transformer to.
+    /// At least one of `patterns` or `files` must be provided
+    #[serde(default, skip_serializing_if = "Vec::is_empty")]
+    pub files: Vec<String>,
+
+    /// Transformer-specific configuration
+    /// This is an optional field that can be used to configure the transformer
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub options: Option<FileTransformerOptions>,
+}
+
+pub type FileTransformerOptions = HashMap<String, serde_json::Value>;
+
 #[cfg(test)]
 mod tests {
     use super::*;
 
+    fn create_example_project() -> ModProject {
+        ModProject {
+            name: "old-summoners-rift".to_string(),
+            display_name: "Old Summoners Rift".to_string(),
+            version: "0.1.0-beta.5".to_string(),
+            description:
+                "A mod for League of Legends that changes the map to the old Summoners Rift"
+                    .to_string(),
+            authors: vec![
+                ModProjectAuthor::Name("TheKillerey".to_string()),
+                ModProjectAuthor::Role {
+                    name: "Crauzer".to_string(),
+                    role: "Contributor".to_string(),
+                },
+            ],
+            transformers: vec![FileTransformer {
+                name: "tex-converter".to_string(),
+                patterns: vec!["**/*.dds".to_string(), "**/*.png".to_string()],
+                files: vec![],
+                options: None,
+            }],
+            layers: vec![
+                ModLayer {
+                    name: "base".to_string(),
+                    priority: 0,
+                    description: Some("Base layer of the mod".to_string()),
+                },
+                ModLayer {
+                    name: "chroma1".to_string(),
+                    priority: 20,
+                    description: Some("Chroma 1".to_string()),
+                },
+            ],
+        }
+    }
+
     #[test]
-    fn example_project() {
+    fn test_json_parsing() {
         let project: ModProject =
-            toml::from_str(include_str!("../test-data/modproject.toml")).unwrap();
-
-        assert_eq!(
-            project,
-            ModProject {
-                name: "test".to_string(),
-                display_name: "Test 123".to_string(),
-                version: "0.1.0".to_string(),
-                description: "test".to_string(),
-                authors: vec![
-                    ModProjectAuthor::Name("test".to_string()),
-                    ModProjectAuthor::Role {
-                        name: "test 2".to_string(),
-                        role: "developer".to_string(),
-                    },
-                ],
-            }
-        );
+            serde_json::from_str(include_str!("../test-data/mod.config.json")).unwrap();
+
+        assert_eq!(project, create_example_project());
+    }
+
+    #[test]
+    fn test_toml_parsing() {
+        let project: ModProject =
+            toml::from_str(include_str!("../test-data/mod.config.toml")).unwrap();
+
+        assert_eq!(project, create_example_project());
     }
 }

crates/mod-project/test-data/mod.config.json

@@ -0,0 +1,25 @@
+{
+  "name": "old-summoners-rift",
+  "display_name": "Old Summoners Rift",
+  "version": "0.1.0-beta.5",
+  "description": "A mod for League of Legends that changes the map to the old Summoners Rift",
+  "authors": ["TheKillerey", { "name": "Crauzer", "role": "Contributor" }],
+  "transformers": [
+    {
+      "name": "tex-converter",
+      "patterns": ["**/*.dds", "**/*.png"]
+    }
+  ],
+  "layers": [
+    {
+      "name": "base",
+      "priority": 0,
+      "description": "Base layer of the mod"
+    },
+    {
+      "name": "chroma1",
+      "priority": 20,
+      "description": "Chroma 1"
+    }
+  ]
+}

crates/mod-project/test-data/mod.config.toml

@@ -0,0 +1,20 @@
+name = "old-summoners-rift"
+display_name = "Old Summoners Rift"
+version = "0.1.0-beta.5"
+description = "A mod for League of Legends that changes the map to the old Summoners Rift"
+
+authors = ["TheKillerey", { name = "Crauzer", role = "Contributor" }]
+
+[[transformers]]
+name = "tex-converter"
+patterns = ["**/*.dds", "**/*.png"]
+
+[[layers]]
+name = "base"
+priority = 0
+description = "Base layer of the mod"
+
+[[layers]]
+name = "chroma1"
+priority = 20
+description = "Chroma 1"