Modding:Manifest.json: Difference between revisions

From Caves of Qud Wiki
Jump to navigation Jump to search
No edit summary
(Set up redirect)
Tag: New redirect
 
Line 1: Line 1:
{{Modding Info}}
#REDIRECT [[Modding:Mod Configuration#manifest.json]]
[[File:ModManagerMock.png|thumb|right|Mod Manager mock]]
The manifest.json is a file containing metadata about your mod, located in the root of your mod folder.<br/>
The file is completely optional and primarily used for display in the game's Mod Manager.
 
==Overview==
{| class="wikitable"
|-
! Field
! style="width: 65%" | Description
! Properties
|-
| '''id'''
| Internal ID of the mod, used primarily 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>config.id</code>.
|-
| '''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>. ||
* Defaults to config.json's <code>config.loadorder</code>.
|-
| '''title'''
| Title of the mod, displayed in the mod manager. ||
* Accepts [[Modding:Text Color Codes & Object Rendering|color shaders]].
* Defaults to workshop.json's <code>Title</code>.
|-
| '''description'''
| Short description of the mod, displayed in the mod manager. ||
* Accepts [[Modding:Text Color Codes & Object Rendering|color shaders]].
|-
| '''tags'''
| Comma-delimited list of tags, only for display in the mod manager and has no effect on your actual workshop tags. ||
* Defaults to workshop.json's <code>Tags</code>.
|-
| '''version'''
| Mod's version, displayed in the mod manager. ||
|-
| '''author'''
| Creator(s) of the mod. ||
* Accepts [[Modding:Text Color Codes & Object Rendering|color shaders]].
|-
| '''previewImage'''
| Relative path to an image used as an icon for your mod in the manager, recommended size 512x512.<br/>The largest Caves of Qud displays on default scale is 128x128, but if you use the same image for your steam workshop preview; that can display at up to 435x435 on the "Most Popular Items" front page.||
* Defaults to workshop.json's <code>ImagePath</code>.
|}
[[Category:Modding]]
 
==Example==
An example manifest.json for the [https://steamcommunity.com/sharedfiles/filedetails/?id=708258860 Blue Ctesiphus] tutorial mod.
<syntaxhighlight lang="json">
{
"id": "BlueCtesiphus",
"loadorder": 1,
"title": "{{blue|Blue Ctesiphus}}",
"description": "Turns Ctesiphus blue!\n\nThis is a piece of Freehold Games' mod tutorial.",
"tags": "Ctesiphus,Tutorial",
"version": "1.0",
"author": "AlphaBeard",
"previewImage": "preview.png"
}
</syntaxhighlight>
 
{{Modding Navbox}}

Latest revision as of 06:56, 26 October 2023

Redirect to:

Retrieved from "https://wiki.cavesofqud.com/index.php?title=Modding:Manifest.json&oldid=88735"