Modding:Installing a mod

There are multiple ways to obtain and install mods for Caves of Qud.

Note: Not all mods will be available by all methods.

Steam Workshop

Note: This section applies only to running the game through Steam. (Even if you obtained the game through Steam, running it from outside of Steam will cause it not to load any Steam Workshop mods.)

1. Go to Caves of Qud's Steam Workshop page.
2. If you aren't already logged in, log in to Steam with the account you'll be playing under.
3. Locate the mod you'd like to install and go to its page.
4. Press "Subscribe".

Now, the next time you run the Steam desktop client, it will download the mod and install it where the game will load it.

Manual Download

Before following any of the other instructions in this section, do the following:

1. Go to the game's configuration directory on your system. On Windows, this is usually C:\Users\[Username]\AppData\LocalLow\Freehold Games\CavesOfQud\. On Linux, this is usually /home/[Username]/.config/unity3d/Freehold Games/CavesOfQud/.
2. Create a Mods directory.

This article has information that is missing or not up to par.
Reason: What is the directory for Mac OS X?

Nexus Mods

1. Go to the Nexus Mods page for Caves of Qud.
2. If you aren't already logged in, log in to Nexus Mods.
3. Locate the mod you'd like to install and go to its page.
4. Press "Manual Download".

This article has information that is missing or not up to par.
Reason: We need someone with a Nexus Mods account to verify what happens after pressing "Manual Download".

Code Hosting Sites

There generally isn't one central place to find Caves of Qud mods on code hosting sites. These instructions apply if someone shows you or you find the repository for a Caves of Qud mod. You might also ask mod authors directly if their mods are hosted somewhere.

First, navigate to the repository for the mod.

GitHub

1. Press "Clone or download".
2. Press "Download ZIP".
3. Save the file somewhere.
4. Unzip the file into the Mods directory.

Bitbucket

1. Press "Downloads" on the left sidebar.
2. Press "Download repository".
3. Save the file somewhere.
4. Unzip the file into the Mods directory.