diff options
| -rw-r--r-- | docs/release-notes.md | 3 | ||||
| -rw-r--r-- | src/SMAPI/Constants.cs | 6 | ||||
| -rw-r--r-- | src/SMAPI/SMAPI.config.json | 12 |
3 files changed, 12 insertions, 9 deletions
diff --git a/docs/release-notes.md b/docs/release-notes.md index d6d3d1cd..e023cf64 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -8,6 +8,9 @@ --> ## Upcoming release +* For players: + * Added support for overriding SMAPI configuration per `Mods` folder (thanks to Shockah!). + * For mod authors: * Added support for [custom update manifests](https://stardewvalleywiki.com/Modding:Modder_Guide/APIs/Update_checks#Custom_update_manifest) (thanks to Jamie Taylor!). diff --git a/src/SMAPI/Constants.cs b/src/SMAPI/Constants.cs index e5601747..27e9bfd2 100644 --- a/src/SMAPI/Constants.cs +++ b/src/SMAPI/Constants.cs @@ -139,11 +139,11 @@ namespace StardewModdingAPI /// <summary>The file path for the SMAPI configuration file.</summary> internal static string ApiConfigPath => Path.Combine(Constants.InternalFilesPath, "config.json"); - /// <summary>The file path for the overrides file for <see cref="ApiConfigPath"/>, which is applied over it.</summary> + /// <summary>The file path for the per-user <see cref="ApiConfigPath"/> override file, which is applied over it.</summary> internal static string ApiUserConfigPath => Path.Combine(Constants.InternalFilesPath, "config.user.json"); - /// <summary>The mod-group-specific file path for the overrides file for <see cref="ApiConfigPath"/>, which is applied over it.</summary> - internal static string ApiModGroupConfigPath => Path.Combine(ModsPath, "config.json"); + /// <summary>The file path for the per-mods-folder <see cref="ApiConfigPath"/> override file, which is applied over it.</summary> + internal static string ApiModGroupConfigPath => Path.Combine(ModsPath, "SMAPI-config.json"); /// <summary>The file path for the SMAPI metadata file.</summary> internal static string ApiMetadataPath => Path.Combine(Constants.InternalFilesPath, "metadata.json"); diff --git a/src/SMAPI/SMAPI.config.json b/src/SMAPI/SMAPI.config.json index 0d00db4d..c2cffbde 100644 --- a/src/SMAPI/SMAPI.config.json +++ b/src/SMAPI/SMAPI.config.json @@ -2,14 +2,14 @@ -This file contains advanced configuration for SMAPI. You generally shouldn't change this file. -The default values are mirrored in StardewModdingAPI.Framework.Models.SConfig to log custom changes. +This file has advanced configuration for SMAPI. +Don't edit this file directly! It will be reset each time you update or reinstall SMAPI. -This file is overwritten each time you update or reinstall SMAPI. To avoid losing custom settings, -create a 'config.user.json' file in the same folder with *only* the settings you want to change. -That file won't be overwritten, and any settings in it will override the default options. Don't -copy all the settings, or you may cause bugs due to overridden changes in future SMAPI versions. +Instead create a `smapi-internal/config.user.json` or `Mods/SMAPI-config.json` file with *only* the +settings you want to change. That file won't be overwritten, and any settings in it will override +the default options. Don't copy all the settings, or you may cause bugs due to overridden changes +in future SMAPI versions. |