Modding:Installing a mod: Difference between revisions

Modding:Installing a mod (view source)

Revision as of 17:14, 22 July 2019

1,476 bytes added , 17:14, 22 July 2019

Improved instructions, resolved outstanding questions, added sample Mods directory structure

Egocarib

Bureaucrats, Interface administrators, Administrators

8,290

edits

@@ Line 16: / Line 16: @@
 =Manual Download=
-Before following any of the other instructions in this section, do the following:
+Mods can also be downloaded manually from a variety of other locations.
-# Go to the game's configuration directory on your system. On Windows, this is usually <code>C:\Users\''[Username]''\AppData\LocalLow\Freehold Games\CavesOfQud\</code>. On Linux, this is usually <code>/home/''[Username]''/.config/unity3d/Freehold Games/CavesOfQud/</code>.
+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.
-# Create a <code>Mods</code> directory.
-{{Template:Missing info|What is the directory for Mac OS X?}}
+=== <u>Set Up Your Mods Folder</u> ===
+To install manually downloaded mods, you must first create a <code>Mods</code> folder in the game directory:
-==Nexus Mods==
+# Go to the game's configuration directory on your system. The default paths for each 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/User/Library/Application Support/com.FreeholdGames.CavesOfQud/</code>
+# Create a <code>Mods</code> folder in that directory if one doesn't already exist.
+=== <u>Download the Mod</u> ===
+==== Nexus Mods ====
 # 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.
 # 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 ====
-{{Template:Missing info|We need someone with a Nexus Mods account to verify what happens after pressing "Manual Download".}}
+# Press "Downloads" on the left sidebar.
+# Press "Download repository" to download a <code>.zip</code> archive of the mod.
-==Code Hosting Sites==
+==== Other 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.
+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.
-First, navigate to the repository for the mod.
+=== <u>Install the Mod</u> ===
-===GitHub===
+Now that you have a <code>.zip</code> archive of the mod, you can install it in the <code>Mods</code> directory you created earlier.
-# Press "Clone or download".
-# Press "Download ZIP".
-# Save the file somewhere.
 # 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.
-===Bitbucket===
+For example, your <code>Mods</code> directory might look like this if you have 3 mods installed:
-# Press "Downloads" on the left sidebar.
+<syntaxhighlight lang="">
-# Press "Download repository".
+<Caves of Qud App Directory>
-# Save the file somewhere.
+    Mods
-# Unzip the file into the <code>Mods</code> directory.
+        SampleMod1
+            CodeFile.cs
+            ObjectBlueprints.xml
+            Textures
+                character_tile.png
+        SampleMod2
+            CodeFile1.cs
+            CodeFile2.cs
+            ObjectBlueprints.xml
+            Mutations.xml
+        SampleMod3
+            ObjectBlueprints.xml
+</syntaxhighlight>
 [[Category:Guides]][[Category:Modding]]