298
edits
Modding:Mod Configuration: Difference between revisions
Jump to navigation
Jump to search
Modding:Mod Configuration (view source)
Revision as of 07:18, 26 October 2023
, 07:18, 26 October 2023Further changes
(Add table of contents) |
(Further changes) |
||
| Line 1: | Line 1: | ||
{{tocright}} | {{tocright}} | ||
{{Modding Info}} | {{Modding Info}} | ||
There are a number of configuration files that can be associated with a mod. | There are a number of configuration files that can be associated with a mod. They are all placed in the root folder of the mod and are all optional. | ||
=manifest.json= | =<code>manifest.json</code>= | ||
[[File:ModManagerMock.png|thumb|right|Mod Manager mock]] | [[File:ModManagerMock.png|thumb|right|Mod Manager mock]] | ||
The manifest.json | The <code>manifest.json</code> is primarily used for display in the game's Mod Manager. | ||
== | ==Structure== | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
| Line 16: | Line 15: | ||
|- | |- | ||
| '''id''' | | '''id''' | ||
| Internal ID of the mod, used | | 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 your ID to alphanumeric characters, as different operating systems will refuse certain characters for their file names. || | ||
* Defaults to config.json's <code> | * Defaults to <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>. || | ||
* Defaults to config.json's <code> | * Defaults to <code>config.json</code>'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]]. | ||
* Defaults to workshop.json's <code>Title</code>. | * Defaults to <code>workshop.json</code>'s <code>Title</code> field. | ||
|- | |- | ||
| '''description''' | | '''description''' | ||
| Line 33: | Line 32: | ||
|- | |- | ||
| '''tags''' | | '''tags''' | ||
| Comma-delimited list of tags, only for display in the mod manager and has no effect on | | Comma-delimited list of tags, only for display in the mod manager and has no effect on tags used in the workshop. || | ||
* Defaults to workshop.json's <code>Tags</code>. | * Defaults to <code>workshop.json</code>'s <code>Tags</code> field. | ||
|- | |- | ||
| '''version''' | | '''version''' | ||
| Line 44: | Line 43: | ||
|- | |- | ||
| '''previewImage''' | | '''previewImage''' | ||
| Relative path to an image used as an icon for | | 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.|| | ||
* Defaults to workshop.json's <code>ImagePath</code>. | * Defaults to <code>workshop.json</code>'s <code>ImagePath</code> field. | ||
|} | |} | ||
==Example== | ==Example <code>manifest.json</code>== | ||
An example manifest.json | An example <code>manifest.json</code>, taken from the [[Modding:Tutorial_-_Snapjaw_Mages|snapjaw mages]] tutorial. | ||
<syntaxhighlight lang="json"> | <syntaxhighlight lang="json"> | ||
{ | { | ||
"id": "Pyovya_SnapjawMage", | |||
"title": "Snapjaw Mages!", | |||
"description": "Adds the new Snapjaw Mage creature to Caves of Qud.", | |||
"version": "0.1.0", | |||
"author": "Pyovya", | |||
"tags": "Creature", | |||
"PreviewImage": "preview.png" | |||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
=<code>workshop.json</code>= | |||
[[Category:Modding]] | [[Category:Modding]] | ||
{{Modding Navbox}} | {{Modding Navbox}} | ||