Modding:Installing a mod

From Caves of Qud Wiki
Jump to: navigation, search

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[edit | edit source]

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[edit | edit source]

Mods can also be downloaded manually from a variety of other locations.

For example, the Nexus Mods site has a page for Caves of Qud. You can also download mods from GitHub, Bitbucket, or any other code hosting website where a mod is hosted. Sometimes, mod authors will post links to their code hosting site in the description of the mod on the Steam Workshop, which means it can still be a good idea to check the Steam Workshop even if you don't use Steam.

Locate Your Mods Folder[edit | edit source]

To manually install mods, you must place them in the Mods folder in the game's user data directory, which will exist as long as the game has correctly booted up at least once. The default paths for each major operating system are:

  • Windows – C:\Users\Username\AppData\LocalLow\Freehold Games\CavesOfQud\
  • Linux – /home/Username/.config/unity3d/Freehold Games/CavesOfQud/
  • Mac – Users/Username/Library/Application Support/com.FreeholdGames.CavesOfQud/

where Username is whatever username you log in with.

Note: If you are using the Itch desktop client's sandbox feature, the directory may be under a user account other than the one you log in with.

Download the Mod[edit | edit source]

Nexus Mods[edit | edit source]

  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" to download a .zip archive of the mod.

GitHub[edit | edit source]

  1. Press "Clone or download".
  2. Press "Download ZIP" to download a .zip archive of the mod.

Bitbucket[edit | edit source]

  1. Press "Downloads" on the left sidebar.
  2. Press "Download repository" to download a .zip archive of the mod.

SteamCMD[edit | edit source]

  1. Install & run SteamCMD.
  2. Enter login anonymous.
  3. Enter workshop_download_item 333640 MOD_ID to download a .zip archive of the mod.
    • Replace MOD_ID with the id of the workshop mod you wish to download.
    • The workshop mod Blue Ctesiphus has the id 708258860 for example, visible in the URL.
    • 333640 is the app id of Caves of Qud, visible in the URL of the game's store page.

Other Sites[edit | edit source]

Other code repositories or mod hosting sites should have some option to download the mod's files. You can download the files and put them in your Mods directory, using the folder structure demonstrated below.

Install the Mod[edit | edit source]

Now that you have a .zip archive of the mod, you can install it intor the Mods directory.

  1. Unzip the file into the Mods directory.
  2. Verify that the Mods folder structure looks correct.
    • Each mod's files should be contained in a separate folder in the Mods directory.
    • The folder name for an individual mod doesn't matter - the game loads content from any folder in the Mods directory.

For example, your Mods directory might look like this if you have 3 mods installed:

<Caves of Qud App Directory>
    Mods
        SampleMod1
            CodeFile.cs
            ObjectBlueprints.xml
            Textures
                character_tile.png
        SampleMod2
            CodeFile1.cs
            CodeFile2.cs
            ObjectBlueprints.xml
            Mutations.xml
        SampleMod3
            ObjectBlueprints.xml