Modding:Manifest.json: Difference between revisions
Jump to navigation
Jump to search
(Create stubby manifest page) |
(No difference)
|
Revision as of 02:16, 8 August 2020
![]() |
This page is about modding. See the modding overview for an abstract on modding. |
This page is about modding. See the modding overview for an abstract on modding.
This page is about modding. See the modding overview for an abstract on modding.
![]() |
This article is a stub. You can help Caves of Qud Wiki by expanding it. |
This article is a stub. You can help Caves of Qud Wiki by expanding it.
The manifest.json is a file containing metadata about your mod, located in the root of your mod folder.
The file is completely optional and primarily used for display in the game's Mod Manager.
Overview
![]() |
This section contains modding information that is only applicable to the in-development beta branch of Caves of Qud on Steam. |
This section contains modding information that is only applicable to the in-development beta branch of Caves of Qud on Steam.
Field | Description | Properties |
---|---|---|
id | Internal ID of the mod, used primarily for generating files such as modcheck-[id].json when the mod is approved.Try to restrict your ID to alphanumeric characters, as different operating systems will refuse certain characters for their file names. |
|
loadorder | Whole number indicating the mod's load priority in ascending order: smaller values load before larger ones. E.g. a mod with a loadorder of -1 loads before one with 1 . |
|
title | Title of the mod, displayed in the mod manager. |
|
description | Short description of the mod, displayed in the mod manager. |
|
tags | Comma-delimited list of workshop tags, only for display in the mod manager and has no effect on your actual workshop tags. |
|
version | Mod's version, displayed in the mod manager. | |
author | Creator(s) of the mod. |
|
previewImage | Relative path to an image used as an icon for your mod in the mod manager. |
|
Example
An example manifest.json for the Blue Ctesiphus tutorial mod.
{
"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"
}