Modding:Overview

From Caves of Qud Wiki
Jump to: navigation, search
For information on installing mods, see Modding: Installing a mod.

Caves of Qud presents a broadly extensible engine. The game's core definition files reside in %game directory%\CoQ_Data\StreamingAssets\Base.

You can create mods for the game by creating a Mods folder in your game save directory, and then creating a sub-folder inside of the Mods folder for your new mod. New content can be created and existing content can be modified or replaced via data files and textures placed in this directory.

For example, on Windows: %USERPROFILE%\AppData\LocalLow\Freehold Games\CavesOfQud\Mods\MyAwesomeMod
Likewise, on Mac: ~/Library/Application Support/com.FreeholdGames.CavesOfQud/mods/MyAwesomeMod
On Linux: ~/.config/unity3d/Freehold Games/CavesOfQud/Mods/MyAwesomeMod

A (partial) checklist for getting ready to mod[edit | edit source]


This article is a stub. You can help Caves of Qud Wiki by expanding it.

  • Install a programming text editor, such as Visual Studio Code (all major platforms), Sublime Text (all major platforms), or Notepad++ (Windows only).
    • Word processors, such as Microsoft Word, are not suitable for modding the game, because they save documents in a format intended for formatted text and the like, instead of for plain text, which is what programming tools tend to use, and what Caves of Qud uses.
    • If you must, Notepad is also essentially useable, even though it's missing certain features usually desireable for programming, such as syntax highlighting and line numbering.
  • Set your file manager (such as Windows Explorer) to show file extensions. Being able to inspect file extensions and verify that you're using the correct ones is indispensible.
  • If you plan to mod in your own tiles, familiarize yourself with a pixel editor, such as Piskel.

Modding FAQ/Frequent Issues[edit | edit source]

Q: I keep getting an error when trying to save my game.

A: Most likely, you have a list in your mod. Qud's default method of saving doesn't handle lists, so you need to handle it yourself. To see how, check out this article on how to override Qud's default saving/loading.


Q: I'm stuck and don't know what to do.

A: Feel free to ask for help or guidance in #modding on the official Caves of Qud discord server! There are several modders there who use the channel to talk through and ask for feedback on their mods.


Q: Where can I find 'Player.log'?

A: The location is dependent on your operating system.

  • PC: %USERPROFILE%\AppData\LocalLow\Freehold Games\CavesOfQud\Player.log
  • Mac: ~/Library/Logs/Unity/Player.log
  • Linux: ~/.config/unity3d/Editor/Player.log