diff --git a/README.md b/README.md index 59ebff2d..21596b32 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`. +- **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.) +- *requires-talisman*: (*Optional*) If your mod requires the [Talisman](https://github.com/MathIsFun0/Talisman) mod, set this to `true`. +- *folderName*: (*Optional*) The name for the mod's install folder. This must not contain any forbidden characters: `<` `>` `:` `"` `/` `\` `|` `?` `*` ### 3. thumbnail.jpg (Optional) If included, this image will appear alongside your mod in the index. Maximum and recommended size is 1920x1080 pixels.