diff options
author | Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com> | 2020-01-25 18:22:50 -0500 |
---|---|---|
committer | Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com> | 2020-01-25 18:22:50 -0500 |
commit | fc0b98be4584eec2b06a3af09cc4b85f9e9a9efc (patch) | |
tree | 4a469ca6cbefb5724580ca8ea2cbee8823428bfa /docs | |
parent | 7a6dab7548e7bc32a685e916edec83f6458881c1 (diff) | |
download | SMAPI-fc0b98be4584eec2b06a3af09cc4b85f9e9a9efc.tar.gz SMAPI-fc0b98be4584eec2b06a3af09cc4b85f9e9a9efc.tar.bz2 SMAPI-fc0b98be4584eec2b06a3af09cc4b85f9e9a9efc.zip |
add user settings that override defaults (#693)
Diffstat (limited to 'docs')
-rw-r--r-- | docs/release-notes.md | 1 | ||||
-rw-r--r-- | docs/technical/smapi.md | 13 |
2 files changed, 3 insertions, 11 deletions
diff --git a/docs/release-notes.md b/docs/release-notes.md index fdae4dc5..dc26db2d 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -6,6 +6,7 @@ * For players: * SMAPI now prevents mods from crashing the game with invalid schedule data. * SMAPI now prevents load crashes due to invalid building types. + * Added support for persistent `smapi-internal/config.json` overrides (see info in the file). * Updated minimum game version (1.4 → 1.4.1). * Fixed 'collection was modified' error when returning to title in rare cases. * Fixed update-check error if a mod's Chucklefish page has no version. diff --git a/docs/technical/smapi.md b/docs/technical/smapi.md index d565aeb4..c9d5c07e 100644 --- a/docs/technical/smapi.md +++ b/docs/technical/smapi.md @@ -19,17 +19,8 @@ This document is about SMAPI itself; see also [mod build package](mod-package.md ## Customisation ### Configuration file -You can customise the SMAPI behaviour by editing the `smapi-internal/config.json` file in your game -folder. - -Basic fields: - -field | purpose ------------------ | ------- -`DeveloperMode` | Default `false` (except in _SMAPI for developers_ releases). Whether to enable features intended for mod developers (mainly more detailed console logging). -`CheckForUpdates` | Default `true`. Whether SMAPI should check for a newer version when you load the game. If a new version is available, a small message will appear in the console. This doesn't affect the load time even if your connection is offline or slow, because it happens in the background. -`VerboseLogging` | Default `false`. Whether SMAPI should log more information about the game context. -`ModData` | Internal metadata about SMAPI mods. Changing this isn't recommended and may destabilise your game. See documentation in the file. +You can customise some SMAPI behaviour by editing the `smapi-internal/config.json` file in your +game folder. See documentation in the file for more info. ### Command-line arguments The SMAPI installer recognises three command-line arguments: |