Modding:Mod Configuration

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.

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.

By convention, all JSON keys will be referred to using the casing used in the game's code. However, the configuration file keys are case-insensitive.

manifest.json

Mod Manager mock

The manifest.json file 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 the ID to alphanumeric characters, as different operating systems will refuse certain characters for their file names.	Falls back 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.	Falls back to config.json's's LoadOrder field.
Title	Title of the mod, displayed in the mod manager.	Accepts color shaders. Falls back 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.	Falls back 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.	Falls back to workshop.json's ImagePath field.

Example manifest.json

An example manifest.json, taken from the snapjaw mages tutorial and modified to demonstrate more of the file's options.

{
    "id": "Pyovya_SnapjawMage",
    "loadOrder": 1,
    "title": "{{R|Snapjaw}} {{C|Mages}}!",
    "description": "Adds the new {{Y|snapjaw}} {{R|fire}} {{Y|mage}} and {{Y|snapjaw}} {{C|ice}} {{Y|mage}} creatures to Caves of Qud.",
    "version": "0.1.0",
    "author": "{{M|Pyovya}}",
    "tags": "Creature",
    "previewImage": "preview.png"
}

workshop.json

The workshop.json file configures a mod's upload to the Caves of Qud Steam Workshop. It is usually manipulated through the game's Workshop Uploader.

Structure

Field	Description	Properties
WorkshopId	The mod's unique ID on the workshop.
Title	Title of the mod, displayed on the workshop.
Description	Description of the mod, displayed on the workshop.	Accepts formatting tags.
Tags	Comma-delimited list of tags, displayed on the workshop.	Pre-defined tags can be filtered on.
Visibility	Stringed integer, detailing the mod's visibility on the workshop. "0": The mod is private (visible only to the mod's creator). "1": The mod is visible to friends only. "2": The mod is public.
ImagePath	Relative path to an image used as an icon for the mod in the workshop, recommended size 512x512.

Example workshop.json

An example workshop.json for the snapjaw mages tutorial mod.

{
  "WorkshopId": 708258860,
  "Title": "Snapjaw Mages",
  "Description": "[h1]Snapjaw Mages[/h1]\n\nThis mod adds the new [b]Snapjaw Mage[/b] creature to Caves of Qud.",
  "Tags": "Creatures",
  "Visibility": "2",
  "ImagePath": "Preview.png"
}

modconfig.json

The modconfig.json file configures a mod's properties for all textures located within the mod's folder.

Structure

Field	Description	Properties
ShaderMode	An integer representing the mod's textures' shader mode. 0: The default texture shader. 1: The true color texture shader. Note: This currently only works for textures rendered in the world. Most UI elements do not support this mode.
TextureWidth	The width of the mod's textures, in pixels.
TextureHeight	The height of the mod's textures, in pixels.

Example modconfig.json

An example modconfig.json.

{
  "shaderMode": 0,
  "textureWidth": 16,
  "textureHeight": 24
}

config.json

The config.json file was obsoleted in version 2.0.201.44 and was subsumed by the manifest.json file.