Changes between Version 28 and Version 29 of Modding_Guide

Timestamp:

Apr 18, 2018, 2:07:44 PM (6 years ago)

Author:

Itms

Comment:

Updated guide after r21723

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 `.zip` file for compression and ease of distribution.
+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.
 
 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.
+
+For those preferring the command line, that operation is equivalent to running
+{{{
+#!sh
+pyrogenesis modfile.pyromod
+# or
+pyrogenesis modfile.zip
+}}}
+
+You will then land in the mod selection screen, described in the next section.
 
 == How are mods used? ==
@@ -103 +117 @@
 {{{
 #!sh
-binaries/system/pyrogenesis -mod=mod -archivebuild=binaries/data/mods/mymod -archivebuild-output=mymod.zip -archivebuild-compress
+binaries/system/pyrogenesis -mod=mod -archivebuild=binaries/data/mods/mymod -archivebuild-output=mymod.pyromod -archivebuild-compress
 }}}
 
-This produces the distributable mymod.zip in your working directory. If users now install it like the distributed public mod (i.e. under mods/mymod/mymod.zip), they can run it with the "-mod=mymod" command line argument as explained above.
+This produces the distributable mymod.pyromod in your working directory. If users now install it as explained [#Howtoinstallmods above], they can run it with the "-mod=mymod" command line argument as explained [#Howaremodsused above].
 
 == Tutorials ==