Modding:Mod Configuration

This page is about modding. See the modding overview for an abstract on modding.

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

Mod Manager mock

The manifest.json is primarily used for display in the game's Mod Manager.

Structure

Field	Description	Properties
id	Internal ID of the mod, primarily used 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 ID field.
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 LoadOrder field.
title	Title of the mod, displayed in the mod manager.	Accepts color shaders. Defaults to workshop.json's Title field.
description	Short description of the mod, displayed in the mod manager.	Accepts color shaders.
tags	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 Tags field.
version	Mod's version, displayed in the mod manager.
author	Creator(s) of the mod.	Accepts color shaders.
previewImage	Relative path to an image used as an icon for the mod in the manager, recommended size 512x512. 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 ImagePath field.

Example manifest.json

An example manifest.json, taken from the snapjaw mages tutorial.

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