298
edits
Modding:Mod Configuration: Difference between revisions
Jump to navigation
Jump to search
m
Modding:Mod Configuration (view source)
Revision as of 08:45, 26 October 2023
, 08:45, 26 October 2023links
(More content) |
m (links) |
||
| Line 18: | Line 18: | ||
| '''ID''' | | '''ID''' | ||
| Internal ID of the mod, primarily used for generating files such as <code>modcheck-[id].json</code> when the mod is approved.<br/>Try to restrict the ID to alphanumeric characters, as different operating systems will refuse certain characters for their file names. || | | Internal ID of the mod, primarily used for generating files such as <code>modcheck-[id].json</code> when the mod is approved.<br/>Try to restrict the ID to alphanumeric characters, as different operating systems will refuse certain characters for their file names. || | ||
* Falls back to <code>config.json</code>'s <code>ID</code> field. | * Falls back to [[#config.json|<code>config.json</code>'s]] <code>ID</code> field. | ||
|- | |- | ||
| '''LoadOrder''' | | '''LoadOrder''' | ||
| Whole number indicating the mod's load priority in ascending order: smaller values load before larger ones.<br/>E.g. a mod with a loadorder of <code>-1</code> loads before one with <code>1</code>. || | | Whole number indicating the mod's load priority in ascending order: smaller values load before larger ones.<br/>E.g. a mod with a loadorder of <code>-1</code> loads before one with <code>1</code>. || | ||
* Falls back to <code>config.json</code>'s <code>LoadOrder</code> field. | * Falls back to [[#config.json|<code>config.json</code>'s]]'s <code>LoadOrder</code> field. | ||
|- | |- | ||
| '''Title''' | | '''Title''' | ||
| Title of the mod, displayed in the mod manager. || | | Title of the mod, displayed in the mod manager. || | ||
* Accepts [[Modding:Text Color Codes & Object Rendering|color shaders]]. | * Accepts [[Modding:Text Color Codes & Object Rendering|color shaders]]. | ||
* Falls back to <code>workshop.json</code>'s <code>Title</code> field. | * Falls back to [[#workshop.json|<code>workshop.json</code>'s]] <code>Title</code> field. | ||
|- | |- | ||
| '''Description''' | | '''Description''' | ||
| Line 35: | Line 35: | ||
| '''Tags''' | | '''Tags''' | ||
| Comma-delimited list of tags, only for display in the mod manager and has no effect on tags used in the workshop. || | | Comma-delimited list of tags, only for display in the mod manager and has no effect on tags used in the workshop. || | ||
* Falls back to <code>workshop.json</code>'s <code>Tags</code> field. | * Falls back to [[#workshop.json|<code>workshop.json</code>'s]] <code>Tags</code> field. | ||
|- | |- | ||
| '''Version''' | | '''Version''' | ||
| Line 46: | Line 46: | ||
| '''PreviewImage''' | | '''PreviewImage''' | ||
| Relative path to an image used as an icon for the mod in the manager, recommended size 512x512.<br/>The largest Caves of Qud displays on default scale is 128x128, but if also used as the steam workshop preview image, that can display at up to 435x435 on the "Most Popular Items" front page.|| | | Relative path to an image used as an icon for the mod in the manager, recommended size 512x512.<br/>The largest Caves of Qud displays on default scale is 128x128, but if also used as the steam workshop preview image, that can display at up to 435x435 on the "Most Popular Items" front page.|| | ||
* Falls back to <code>workshop.json</code>'s <code>ImagePath</code> | * Falls back to [[#workshop.json|<code>workshop.json</code>'s]] <code>ImagePath</code> field. | ||
|} | |} | ||