skyline/balatro-mod-index
1
0
Fork 0
Code Actions 1 Activity

Update README.md to include folderName parameter

Browse Source 
Document new optional parameter folderName.
Also add clarification of required vs optional parameters, and Categories requiring at least one item from the valid Category list.
This commit is contained in:
Breezebuilder
2025-03-07 13:21:33 +11:00
committed by GitHub
parent a1a15af0e6
commit ea45924a8f
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -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.