2,158
edits
Modding:Installing a mod: Difference between revisions
m
toc right
m (Nexus → Nexus Mods) |
m (toc right) |
||
| (17 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
{{tocright}} | |||
There are multiple ways to obtain and install mods for ''Caves of Qud''. | There are multiple ways to obtain and install mods for ''Caves of Qud''. | ||
'''Note:''' Not all mods will be available by all methods. | '''Note:''' Not all mods will be available by all methods. | ||
=Steam Workshop= | == Steam Workshop == | ||
'''Note:''' This section applies only to running the game through Steam. | '''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. | ||
# Go to [https://steamcommunity.com/app/333640/workshop/ ''Caves of Qud'''s Steam Workshop page]. | # Go to [https://steamcommunity.com/app/333640/workshop/ ''Caves of Qud'''s Steam Workshop page]. | ||
| Line 14: | Line 15: | ||
Now, the next time you run the Steam desktop client, it will download the mod and install it where the game will load it. | 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= | == Manual Download == | ||
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 [https://steamcommunity.com/app/333640/workshop/ 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 === | |||
==Nexus Mods== | To manually install mods, you must place them in the <code>Mods</code> 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 – <code>C:\Users\''Username''\AppData\LocalLow\Freehold Games\CavesOfQud\</code> | |||
* Linux – <code>/home/''Username''/.config/unity3d/Freehold Games/CavesOfQud/</code> | |||
* Mac – <code>Users/''Username''/Library/Application Support/com.FreeholdGames.CavesOfQud/</code> | |||
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 === | |||
==== Nexus Mods ==== | |||
# Go to [https://www.nexusmods.com/cavesofqud the Nexus Mods page for ''Caves of Qud'']. | # Go to [https://www.nexusmods.com/cavesofqud the Nexus Mods page for ''Caves of Qud'']. | ||
# If you aren't already logged in, log in to Nexus Mods. | # If you aren't already logged in, log in to Nexus Mods. | ||
# Locate the mod you'd like to install and go to its page. | # Locate the mod you'd like to install and go to its page. | ||
# Press "Manual Download". | # Press "Manual Download" to download a <code>.zip</code> archive of the mod. | ||
==== GitHub ==== | |||
# Press "Clone or download". | |||
# Press "Download ZIP" to download a <code>.zip</code> archive of the mod. | |||
==== Bitbucket ==== | |||
# Press "Downloads" on the left sidebar. | |||
# Press "Download repository" to download a <code>.zip</code> archive of the mod. | |||
==== SteamCMD ==== | |||
# Install & run [https://developer.valvesoftware.com/wiki/SteamCMD SteamCMD]. | |||
# Enter <code>login anonymous</code>. | |||
# Enter <code>workshop_download_item 333640 MOD_ID</code> to download a <code>.zip</code> archive of the mod. | |||
#* Replace <code>MOD_ID</code> with the id of the workshop mod you wish to download. | |||
#* The workshop mod [https://steamcommunity.com/sharedfiles/filedetails/?id=708258860 Blue Ctesiphus] has the id <code>708258860</code> for example, visible in the URL. | |||
#* <code>333640</code> is the app id of Caves of Qud, visible in the URL of the game's [https://store.steampowered.com/app/333640/Caves_of_Qud/ store page]. | |||
== | ==== Other Sites ==== | ||
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 === | |||
Now that you have a <code>.zip</code> archive of the mod, you can install it into the <code>Mods</code> directory. | |||
# Unzip the file into the <code>Mods</code> directory. | # Unzip the file into the <code>Mods</code> directory. | ||
# Verify that the <code>Mods</code> folder structure looks correct. | |||
#* Each mod's files should be contained in a separate folder in the <code>Mods</code> directory. | |||
#* The folder name for an individual mod doesn't matter - the game loads content from any folder in the <code>Mods</code> directory. | |||
For example, your <code>Mods</code> directory might look like this if you have 3 mods installed: | |||
= | <syntaxhighlight lang="yaml"> | ||
<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 | |||
</syntaxhighlight> | |||
{{Modding Navbox}} | |||
[[Category:Guides]][[Category:Modding]] | [[Category:Guides]][[Category:Modding Resources]] | ||