Modding:Installing a mod: Difference between revisions

→‎Set Up Your Mods Folder: update heading to reflect that the Mods directory is now automatically created
(→‎Set Up Your Mods Folder: add note about itch sandbox)
(→‎Set Up Your Mods Folder: update heading to reflect that the Mods directory is now automatically created)
Line 20: Line 20:
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.
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.


=== <u>Set Up Your Mods Folder</u> ===
=== Locate Your Mods Folder ===
To install manually downloaded mods, you must first create a <code>Mods</code> folder in the game directory:


# Go to the game's configuration directory on your system. The default paths for each operating system are:
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>
# Create a <code>Mods</code> folder in that directory if one doesn't already exist.


'''Note:''' If you are using the Itch desktop client's sandbox feature or another sandbox, the directory may be elsewhere. In Itch's case, it may be under another user account on the system.
* 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.


=== <u>Download the Mod</u> ===
=== <u>Download the Mod</u> ===