summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <github@jplamondonw.com>2017-10-08 18:05:47 -0400
committerJesse Plamondon-Willard <github@jplamondonw.com>2017-10-08 18:05:47 -0400
commit475efa12febcb1f1f0976cb6c84e445a263daed9 (patch)
treeb71c96f395dde92d46134d404ed2fe2a5c909be9 /docs
parentcd93382c645da3c6d3ce4e532307f42704ba4c76 (diff)
downloadSMAPI-475efa12febcb1f1f0976cb6c84e445a263daed9.tar.gz
SMAPI-475efa12febcb1f1f0976cb6c84e445a263daed9.tar.bz2
SMAPI-475efa12febcb1f1f0976cb6c84e445a263daed9.zip
rewrite mod build package per new docs
Diffstat (limited to 'docs')
-rw-r--r--docs/mod-build-config.md14
1 files changed, 10 insertions, 4 deletions
diff --git a/docs/mod-build-config.md b/docs/mod-build-config.md
index b091c2c0..f02981b9 100644
--- a/docs/mod-build-config.md
+++ b/docs/mod-build-config.md
@@ -71,6 +71,11 @@ Finally, you can disable the zip creation with this:
<EnableModZip>False</EnableModZip>
```
+Or only create it in release builds with this:
+```xml
+<EnableModZip Condition="$(Configuration) != 'Release'">False</EnableModZip>
+```
+
### Game path
The package usually detects where your game is installed automatically. If it can't find your game
or you have multiple installs, you can specify the path yourself. There's two ways to do that:
@@ -118,14 +123,15 @@ still compile on a different computer).
## Troubleshoot
### "Failed to find the game install path"
-That error means the package couldn't find your game. You need to specify the game path yourself;
-see _[Game path](#game-path)_ above.
+That error means the package couldn't find your game. You can specify the game path yourself; see
+_[Game path](#game-path)_ above.
## Release notes
### 2.0
-* Mods are now copied into the `Mods` folder automatically (configurable).
-* The release zip is now created automatically in your build output folder (configurable).
+* Added: mods are now copied into the `Mods` folder automatically (configurable).
+* Added: release zips are now created automatically in your build output folder (configurable).
* Added mod's version to release zip filename.
+* Improved errors to simplify troubleshooting.
* Fixed release zip not having a mod folder.
* Fixed release zip failing if mod name contains characters that aren't valid in a filename.