Changes between Version 30 and Version 31 of Modding_Guide

Timestamp:

May 20, 2018, 3:44:39 AM (6 years ago)

Author:

s0600204

Comment:

Clarify where user-created mods are/should be stored.

Modding_Guide

@@ -17 +17 @@
 == Where are the mods? ==
 
-Mods are located in the game's installation directory (or relative to checkout for SVN users). Typically mods are located in `binaries/data/mods/`, but you can also add them to the mods (data) directory as noted in GameDataPaths. A mod is defined by a folder inside the `mods` directory with the relevant files inside of it. Files are expected in certain locations, so a mod should follow the same structure as the `public` mod included with the game. Mods can be archived into a `.pyromod` file (which is actually a `.zip` file, with a specific extension to associate it with 0 A.D.) for compression and ease of distribution.
+Mods distributed with, or as part of, 0 A.D. are located within the game's installation directory, under `binaries/data/mods/`.
 
-See the [wiki:Mod_Layout mod layout] or [wiki:Finding_Your_Way_Around Finding Your Way Around] pages for more details.
+User created mods should be located in a user's mods directory. The exact location differs depending on which Operating System you're running:
+
+* On Windows (Vista or newer): `C:\Users\{name_of_user}\Documents\My Games\0ad\mods\`
+* On OSX: `~/Library/Application Support/0ad/mods/`
+* On Linux: `~/.local/share/0ad/mods/`
+
+(Mods acquired via the **mod.io** interface will be stored here by 0 A.D.)
+
+Each mod is contained within its **own** folder, which should have the same name as the mod. Thus, a mod named `my_awesome_mod` would be placed in the folder `./0ad/mods/my_awesome_mod/`.
+
+This folder then contains all files belonging to the mod, either as a collection of subfolders and files:
+
+[[Image(modfolder_collection.jpg, 50%)]]
+
+Or, once ready for distribution, packaged as a single `.zip` or `.pyromod` file:
+
+[[Image(modfolder_packaged.jpg, 50%)]]
+
+Files are expected in certain locations, so a mod should follow the same structure as the `public` mod included with the game. See the [wiki:Mod_Layout mod layout] or [wiki:Finding_Your_Way_Around Finding Your Way Around] pages for more details.
+
 
 == How to install mods? ==
 
-You can of course place mods manually into the locations listed above. However, mod files can be directly opened with 0 A.D., which copies the data to those locations automatically. `.pyromod` files should be associated with 0 A.D. depending on your operating system, but you can also install `.zip` files that way: right-click on them and open them with 0 A.D.
+You can place mods manually into the mods folder as described above. However, mod files can be directly opened with 0 A.D., which copies the data to those locations automatically. `.pyromod` files should be associated with 0 A.D. depending on your operating system, but you can also install `.zip` files that way: right-click on them and open them with 0 A.D.
 
 For those preferring the command line, that operation is equivalent to running