summaryrefslogtreecommitdiff
path: root/src/SMAPI/SMAPI.config.json
blob: 450a32ccdf4175ade5e71a755503b78064ed7eea (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
/*



This file contains advanced configuration for SMAPI. You generally shouldn't change this file.



*/
{
    /**
     * The console color theme to use. The possible values 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.
     */
    "ColorScheme": "AutoDetect",

    /**
     * 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 more information about the game context.
     */
    "VerboseLogging": false,

    /**
     * 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 mod IDs SMAPI should ignore when performing update checks or validating update keys.
     */
    "SuppressUpdateChecks": [
        "SMAPI.ConsoleCommands",
        "SMAPI.SaveBackup"
    ]
}