Modding:Manifest.json

From Caves of Qud Wiki
Jump to: navigation, search
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.

Mod Manager mock

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

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.
  • Defaults to config.json's config.id.
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.
  • Defaults to config.json's config.loadorder.
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 tags, only for display in the mod manager and has no effect on your actual workshop tags.
  • Defaults to workshop.json's 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 manager, recommended size 512x512.
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 ImagePath.

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"
}