summaryrefslogtreecommitdiff
path: root/src/SMAPI/SMAPI.config.json
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2019-11-24 13:49:30 -0500
committerJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2019-11-24 13:49:30 -0500
commita3f21685049cabf2d824c8060dc0b1de47e9449e (patch)
treead9add30e9da2a50e0ea0245f1546b7378f0d282 /src/SMAPI/SMAPI.config.json
parent6521df7b131924835eb797251c1e956fae0d6e13 (diff)
parent277bf082675b98b95bf6184fe3c7a45b969c7ac2 (diff)
downloadSMAPI-a3f21685049cabf2d824c8060dc0b1de47e9449e.tar.gz
SMAPI-a3f21685049cabf2d824c8060dc0b1de47e9449e.tar.bz2
SMAPI-a3f21685049cabf2d824c8060dc0b1de47e9449e.zip
Merge branch 'develop' into stable
Diffstat (limited to 'src/SMAPI/SMAPI.config.json')
-rw-r--r--src/SMAPI/SMAPI.config.json114
1 files changed, 114 insertions, 0 deletions
diff --git a/src/SMAPI/SMAPI.config.json b/src/SMAPI/SMAPI.config.json
new file mode 100644
index 00000000..bccac678
--- /dev/null
+++ b/src/SMAPI/SMAPI.config.json
@@ -0,0 +1,114 @@
+/*
+
+
+
+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.
+
+
+
+*/
+{
+ /**
+ * Whether SMAPI should log more information about the game context.
+ */
+ "VerboseLogging": false,
+
+ /**
+ * Whether SMAPI should check for newer versions of SMAPI and mods when you load the game. If new
+ * versions are available, an alert will be shown in the console. This doesn't affect the load
+ * time even if your connection is offline or slow, because it happens in the background.
+ */
+ "CheckForUpdates": true,
+
+ /**
+ * Whether to enable features intended for mod developers. Currently this only makes TRACE-level
+ * messages appear in the console.
+ */
+ "DeveloperMode": true,
+
+ /**
+ * Whether to add a section to the 'mod issues' list for mods which directly use potentially
+ * sensitive .NET APIs like file or shell access. Note that many mods do this legitimately as
+ * part of their normal functionality, so these warnings are meaningless without further
+ * investigation. When this is commented out, it'll be true for local debug builds and false
+ * otherwise.
+ */
+ //"ParanoidWarnings": true,
+
+ /**
+ * Whether SMAPI should show newer beta versions as an available update. When this is commented
+ * out, it'll be true if the current SMAPI version is beta, and false otherwise.
+ */
+ //"UseBetaChannel": true,
+
+ /**
+ * SMAPI's GitHub project name, used to perform update checks.
+ */
+ "GitHubProjectName": "Pathoschild/SMAPI",
+
+ /**
+ * The base URL for SMAPI's web API, used to perform update checks.
+ * Note: the protocol will be changed to http:// on Linux/Mac due to OpenSSL issues with the
+ * game's bundled Mono.
+ */
+ "WebApiBaseUrl": "https://api.smapi.io",
+
+ /**
+ * Whether SMAPI should log network traffic (may be very verbose). Best combined with VerboseLogging, which includes network metadata.
+ */
+ "LogNetworkTraffic": false,
+
+ /**
+ * Whether to generate a 'SMAPI-latest.metadata-dump.json' file in the logs folder with the full mod
+ * metadata for detected mods. This is only needed when troubleshooting some cases.
+ */
+ "DumpMetadata": false,
+
+ /**
+ * The colors to use for text written to the SMAPI console.
+ *
+ * The possible values for 'UseScheme' are:
+ * - AutoDetect: SMAPI will assume a light background on Mac, and detect the background color
+ * automatically on Linux or Windows.
+ * - LightBackground: use darker text colors that look better on a white or light background.
+ * - DarkBackground: use lighter text colors that look better on a black or dark background.
+ *
+ * For available color codes, see https://docs.microsoft.com/en-us/dotnet/api/system.consolecolor.
+ *
+ * (These values are synched with ColorfulConsoleWriter.GetDefaultColorSchemeConfig in the
+ * SMAPI code.)
+ */
+ "ConsoleColors": {
+ "UseScheme": "AutoDetect",
+
+ "Schemes": {
+ "DarkBackground": {
+ "Trace": "DarkGray",
+ "Debug": "DarkGray",
+ "Info": "White",
+ "Warn": "Yellow",
+ "Error": "Red",
+ "Alert": "Magenta",
+ "Success": "DarkGreen"
+ },
+ "LightBackground": {
+ "Trace": "DarkGray",
+ "Debug": "DarkGray",
+ "Info": "Black",
+ "Warn": "DarkYellow",
+ "Error": "Red",
+ "Alert": "DarkMagenta",
+ "Success": "DarkGreen"
+ }
+ }
+ },
+
+ /**
+ * The mod IDs SMAPI should ignore when performing update checks or validating update keys.
+ */
+ "SuppressUpdateChecks": [
+ "SMAPI.ConsoleCommands",
+ "SMAPI.SaveBackup"
+ ]
+}