diff options
| author | Jesse Plamondon-Willard <github@jplamondonw.com> | 2017-05-16 23:29:56 -0400 |
|---|---|---|
| committer | Jesse Plamondon-Willard <github@jplamondonw.com> | 2017-05-16 23:29:56 -0400 |
| commit | 741796a4f82146f0130fb6965bf03742497458d7 (patch) | |
| tree | d375e2224811bf5be6094750d98477065ca31704 | |
| parent | 2d5d9c7c53fa2f1564103971c340643789dbb2bb (diff) | |
| download | SMAPI-741796a4f82146f0130fb6965bf03742497458d7.tar.gz SMAPI-741796a4f82146f0130fb6965bf03742497458d7.tar.bz2 SMAPI-741796a4f82146f0130fb6965bf03742497458d7.zip | |
document compile flags in readme
| -rw-r--r-- | README.md | 10 |
1 files changed, 10 insertions, 0 deletions
@@ -157,3 +157,13 @@ argument | purpose -------- | ------- `--log-path "path"` | The relative or absolute path of the log file SMAPI should write. `--no-terminal` | SMAPI won't write anything to the console window. (Messages will still be written to the log file.) + +### Compile flags +SMAPI uses a small number of conditional compilation constants, which you can set by editing the +`<DefineConstants>` element in `StardewModdingAPI.csproj`. Supported constants: + +flag | purpose +---- | ------- +`EXPERIMENTAL` | Enables preview features that aren't officially released yet. +`SMAPI_FOR_WINDOWS` | Indicates that SMAPI is being compiled on Windows for players on Windows. Set automatically in `crossplatform.targets`. + |