summaryrefslogtreecommitdiff
path: root/docs/mod-build-config.md
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2019-06-19 13:47:05 -0400
committerJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2019-09-14 18:16:13 -0400
commita54db1b33019645f862b0552ad2cd0700074c592 (patch)
tree3956e1c91b99ecc4b314a62d769e8038d1418880 /docs/mod-build-config.md
parenta07e2de9a031f3d5e79202eeea726a65065f1481 (diff)
downloadSMAPI-a54db1b33019645f862b0552ad2cd0700074c592.tar.gz
SMAPI-a54db1b33019645f862b0552ad2cd0700074c592.tar.bz2
SMAPI-a54db1b33019645f862b0552ad2cd0700074c592.zip
add optional Harmony reference to mod build package
Diffstat (limited to 'docs/mod-build-config.md')
-rw-r--r--docs/mod-build-config.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/mod-build-config.md b/docs/mod-build-config.md
index 87e0cf30..9121c175 100644
--- a/docs/mod-build-config.md
+++ b/docs/mod-build-config.md
@@ -49,6 +49,12 @@ non-mod projects like unit tests, you can set this property:
<CopyModReferencesToBuildOutput>true</CopyModReferencesToBuildOutput>
```
+If your mod uses [Harmony](https://github.com/pardeike/Harmony) (not recommended for most mods),
+the package can add a reference to SMAPI's Harmony DLL for you:
+```xml
+<EnableHarmony>true</EnableHarmony>
+```
+
### Copy files into the `Mods` folder and create release zip
<dl>
<dt>Files considered part of your mod</dt>
@@ -269,6 +275,7 @@ If you need to copy the referenced DLLs into your build output, add this too:
* added GAC to assembly search paths to fix references to XNA Framework.
* Added option to disable game debugging config.
* Added `.pdb` files to builds by default (to enable line numbers in error stack traces).
+* Added optional Harmony reference.
* Fixed `Newtonsoft.Json.pdb` included in release zips when Json.NET is referenced directly.
* Fixed `<IgnoreModFilePatterns>` not working for `i18n` files.
* Dropped support for older versions of SMAPI and Visual Studio.