From 4ce572fca6b37851b6070d82f1f0a2b94a04df44 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com>
Date: Sat, 5 Sep 2020 00:14:13 -0400
Subject: add mod build package option to change the Mods path

---
 docs/technical/mod-package.md | 50 ++++++++++++++++++++++++++-----------------
 1 file changed, 30 insertions(+), 20 deletions(-)

(limited to 'docs')

diff --git a/docs/technical/mod-package.md b/docs/technical/mod-package.md
index 0f3afe9e..5ac22167 100644
--- a/docs/technical/mod-package.md
+++ b/docs/technical/mod-package.md
@@ -115,8 +115,17 @@ These are the options you can set:
 <td><code>GamePath</code></td>
 <td>
 
-The absolute path to the Stardew Valley folder. This is auto-detected, so you shouldn't need to
-change it in most cases.
+The absolute path to the Stardew Valley folder. This is auto-detected, so you usually shouldn't
+need to change it.
+
+</td>
+</tr>
+<tr>
+<td><code>GameModsPath</code></td>
+<td>
+
+The absolute path to the folder containing the game's installed mods (defaults to
+`$(GamePath)/Mods`), used when deploying the mod files.
 
 </td>
 </tr>
@@ -148,34 +157,34 @@ Whether to add a reference to [Harmony](https://stardewvalleywiki.com/Modding:Mo
 </td>
 </tr>
 <tr>
-<td><code>ModFolderName</code></td>
+<td><code>EnableModDeploy</code></td>
 <td>
 
-The mod name for its folder under `Mods` and its release zip (defaults to the project name).
+Whether to copy the mod files into your game's `Mods` folder (default `true`).
 
 </td>
 </tr>
 <tr>
-<td><code>EnableModDeploy</code></td>
+<td><code>EnableModZip</code></td>
 <td>
 
-Whether to copy the mod files into your game's `Mods` folder (default `true`).
+Whether to create a release-ready `.zip` file in the mod project's `bin` folder (default `true`).
 
 </td>
 </tr>
 <tr>
-<td><code>ModZipPath</code></td>
+<td><code>ModFolderName</code></td>
 <td>
 
-The folder path where the release zip is created (defaults to the project's `bin` folder).
+The mod name for its folder under `Mods` and its release zip (defaults to the project name).
 
 </td>
 </tr>
 <tr>
-<td><code>EnableModZip</code></td>
+<td><code>ModZipPath</code></td>
 <td>
 
-Whether to create a release-ready `.zip` file in the mod project's `bin` folder (default `true`).
+The folder path where the release zip is created (defaults to the project's `bin` folder).
 
 </td>
 </tr>
@@ -195,6 +204,16 @@ Whether to create a release-ready `.zip` file in the mod project's `bin` folder
 Whether to copy game and framework DLLs into the mod folder (default `false`). This is useful for
 unit test projects, but not needed for mods that'll be run through SMAPI.
 
+</td>
+</tr>
+<tr>
+<td><code>EnableGameDebugging</code></td>
+<td>
+
+Whether to configure the project so you can launch or debug the game through the _Debug_ menu in
+Visual Studio (default `true`). There's usually no reason to change this, unless it's a unit test
+project.
+
 </td>
 </tr>
 <tr>
@@ -210,16 +229,6 @@ For example, this excludes all `.txt` and `.pdf` files, as well as the `assets/p
 <IgnoreModFilePatterns>\.txt$, \.pdf$, assets[/\\]paths.png</IgnoreModFilePatterns>
 ```
 
-</td>
-</tr>
-<tr>
-<td><code>EnableGameDebugging</code></td>
-<td>
-
-Whether to configure the project so you can launch or debug the game through the _Debug_ menu in
-Visual Studio (default `true`). There's usually no reason to change this, unless it's a unit test
-project.
-
 </td>
 </tr>
 </table>
@@ -349,6 +358,7 @@ which can be uploaded to NuGet or referenced directly.
 
 ## Release notes
 ### Upcoming release
+* Added option to change `Mods` folder path.
 * Rewrote documentation to make it easier to read.
 
 ### 3.1
-- 
cgit