summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <github@jplamondonw.com>2018-06-24 23:33:21 -0400
committerJesse Plamondon-Willard <github@jplamondonw.com>2018-06-24 23:33:21 -0400
commitc99237e7451808b41bb598aa5242fd9a49bfcc57 (patch)
treef47a2981a6e250f1d2b8434893f36a3191618a7d /docs
parent06437b80aca329e749da2af79f4ed4d1a24db1b7 (diff)
downloadSMAPI-c99237e7451808b41bb598aa5242fd9a49bfcc57.tar.gz
SMAPI-c99237e7451808b41bb598aa5242fd9a49bfcc57.tar.bz2
SMAPI-c99237e7451808b41bb598aa5242fd9a49bfcc57.zip
add mod build config option to ignore custom files by regex (#549)
Diffstat (limited to 'docs')
-rw-r--r--docs/mod-build-config.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/mod-build-config.md b/docs/mod-build-config.md
index 74ee34e4..32762580 100644
--- a/docs/mod-build-config.md
+++ b/docs/mod-build-config.md
@@ -121,6 +121,16 @@ or you have multiple installs, you can specify the path yourself. There's two wa
The configuration will check your custom path first, then fall back to the default paths (so it'll
still compile on a different computer).
+### Ignore files
+If you don't want to include a file in the mod folder or release zip:
+* Make sure it's not copied to the build output. For a DLL, make sure the reference is [not marked 'copy local'](https://msdn.microsoft.com/en-us/library/t1zz5y8c(v=vs.100).aspx).
+* Or add this to your `.csproj` file under the `<Project` line:
+ ```xml
+ <IgnoreModFilePatterns>\.txt$, \.pdf$</IgnoreModFilePatterns>
+ ```
+ This is a comma-delimited list of regular expression patterns. If any pattern matches a file's
+ relative path in your mod folder, that file won't be included.
+
### Unit test projects
**(upcoming in 2.1)**