summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <github@jplamondonw.com>2017-07-28 00:10:32 -0400
committerJesse Plamondon-Willard <github@jplamondonw.com>2017-07-28 00:10:32 -0400
commit285c0448fd6f8c90fa05dc668dd27f452fa513ab (patch)
tree888036efab02ee130d9b1fb367367f5e195e6a0a /README.md
parenteca5e56883f3d94e0541710a10e4b2b44d1e38f7 (diff)
downloadSMAPI-285c0448fd6f8c90fa05dc668dd27f452fa513ab.tar.gz
SMAPI-285c0448fd6f8c90fa05dc668dd27f452fa513ab.tar.bz2
SMAPI-285c0448fd6f8c90fa05dc668dd27f452fa513ab.zip
add option to create release zip files (Windows-only)
CodeTaskFactory doesn't seem to be available on Linux/Mac.
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 15 insertions, 4 deletions
diff --git a/README.md b/README.md
index c5e01c91..3c137663 100644
--- a/README.md
+++ b/README.md
@@ -36,12 +36,10 @@ You can copy your mod files into the `Mods` folder automatically each time you b
need to do it manually:
1. Edit your mod's `.csproj` file.
-2. Add this block under the `<Project` line:
+2. Add this block above the first `</PropertyGroup>` line:
```xml
- <PropertyGroup>
- <DeployModFolderName>$(MSBuildProjectName)</DeployModFolderName>
- </PropertyGroup>
+ <DeployModFolderName>$(MSBuildProjectName)</DeployModFolderName>
```
That's it! Each time you build, the files in `<game path>\Mods\<mod name>` will be updated with
@@ -62,6 +60,19 @@ the configuration automatically. To do it:
This will deploy your mod files into the game folder, launch SMAPI, and attach a debugger
automatically. Now you can step through your code, set breakpoints, etc.
+### Create release zips automatically (Windows-only)
+You can create the mod package automatically when you build:
+
+1. Edit your mod's `.csproj` file.
+2. Add this block above the first `</PropertyGroup>` line:
+
+ ```xml
+ <DeployModZipTo>$(SolutionDir)\_releases</DeployModZipTo>
+ ```
+
+That's it! Each time you build, the mod files will be zipped into `_releases\<mod name>.zip`. (You
+can change the value to save the zips somewhere else.)
+
## Troubleshoot
### "Failed to find the game install path"
That error means the package couldn't figure out where the game is installed. You need to specify