diff --git a/README.md b/README.md index 59ebff2d..d65c60a5 100644 --- a/README.md +++ b/README.md @@ -35,17 +35,19 @@ This file stores essential metadata in JSON format. **Make sure you adhere to th "categories": ["Content"], "author": "Joe Mama", "repo": "https://github.com/joemama/extended-cards", - "downloadURL": "https://github.com/joemama/extended-cards/releases/latest/extended-cards.tar.gz" + "downloadURL": "https://github.com/joemama/extended-cards/releases/latest/extended-cards.tar.gz", + "folderName": "ExtendedCards" } ``` - **title**: The name of your mod. - **requires-steamodded**: If your mod requires the [Steamodded](https://github.com/Steamodded/smods) mod loader, set this to `true`. -- **requires-talisman**: If your mod requires the [Talisman](https://github.com/MathIsFun0/Talisman) mod, set this to `true`. -- **categories**: Must be of `Content`, `Joker`, `Quality of Life`, `Technical`, `Miscellaneous`, `Resource Packs` or `API`. +- *requires-talisman*: (*Optional*) If your mod requires the [Talisman](https://github.com/MathIsFun0/Talisman) mod, set this to `true`. +- **categories**: Must contain at least one of `Content`, `Joker`, `Quality of Life`, `Technical`, `Miscellaneous`, `Resource Packs` or `API`. - **author**: Your chosen username or handle. - **repo**: A link to your mod's repository. - **downloadURL**: A direct link to the latest version of your released mod. (Can be same as `repo` if no separate download link exists.) +- *folderName*: (*Optional*) The name for the mod's install folder. This must not contain characters `<` `>` `:` `"` `/` `\` `|` `?` `*` ### 3. thumbnail.jpg (Optional) If included, this image will appear alongside your mod in the index. Maximum and recommended size is 1920x1080 pixels. diff --git a/mods/MathIsFun0@Cryptid/meta.json b/mods/MathIsFun0@Cryptid/meta.json index 886ce022..979e3a7a 100644 --- a/mods/MathIsFun0@Cryptid/meta.json +++ b/mods/MathIsFun0@Cryptid/meta.json @@ -5,5 +5,6 @@ "categories": ["Content"], "author": "MathIsFun0", "repo":"https://github.com/MathIsFun0/Cryptid", - "downloadURL": "https://github.com/MathIsFun0/Cryptid/archive/refs/heads/main.zip" + "downloadURL": "https://github.com/MathIsFun0/Cryptid/archive/refs/heads/main.zip", + "folderName": "Cryptid" } diff --git a/mods/MathIsFun0@Talisman/meta.json b/mods/MathIsFun0@Talisman/meta.json index 25d67289..5c74007d 100644 --- a/mods/MathIsFun0@Talisman/meta.json +++ b/mods/MathIsFun0@Talisman/meta.json @@ -5,5 +5,6 @@ "categories": ["API", "Technical", "Quality of Life"], "author": "MathIsFun0", "repo":"https://github.com/MathIsFun0/Talisman", - "downloadURL": "https://github.com/MathIsFun0/Talisman/releases/latest/download/Talisman.zip" + "downloadURL": "https://github.com/MathIsFun0/Talisman/releases/latest/download/Talisman.zip", + "folderName": "Talisman" } diff --git a/mods/MathIsFun0@Trance/meta.json b/mods/MathIsFun0@Trance/meta.json index 0bf2a70c..f58f6e6b 100644 --- a/mods/MathIsFun0@Trance/meta.json +++ b/mods/MathIsFun0@Trance/meta.json @@ -5,5 +5,6 @@ "categories": ["Miscellaneous"], "author": "MathIsFun0", "repo":"https://github.com/MathIsFun0/Trance", - "downloadURL": "https://github.com/MathIsFun0/Trance/archive/refs/heads/main.zip" + "downloadURL": "https://github.com/MathIsFun0/Trance/archive/refs/heads/main.zip", + "folderName": "Trance" } diff --git a/schema/meta.schema.json b/schema/meta.schema.json index e033fca8..6586bae4 100644 --- a/schema/meta.schema.json +++ b/schema/meta.schema.json @@ -31,6 +31,10 @@ "downloadURL": { "type": "string", "format": "uri" + }, + "folderName": { + "type": "string", + "pattern": "^[^<>:\"/\\|?*]+$" } }, "required": ["title", "requires-steamodded", "categories", "author", "repo", "downloadURL"]