split color scheme ID & colors into separate settings

That will simplify making the color scheme ID editable in-game.

Author: Pathoschild

src/SMAPI.Installer/InteractiveInstaller.cs

@@ -191,8 +191,8 @@ public void Run(string[] args)
             ** show theme selector
             ****/
             // get theme writers
-            ColorfulConsoleWriter lightBackgroundWriter = new(context.Platform, ColorfulConsoleWriter.GetDefaultColorSchemeConfig(MonitorColorScheme.LightBackground));
-            ColorfulConsoleWriter darkBackgroundWriter = new(context.Platform, ColorfulConsoleWriter.GetDefaultColorSchemeConfig(MonitorColorScheme.DarkBackground));
+            ColorfulConsoleWriter lightBackgroundWriter = new(context.Platform, MonitorColorScheme.LightBackground, ColorfulConsoleWriter.GetDefaultColorSchemeConfig(MonitorColorScheme.LightBackground));
+            ColorfulConsoleWriter darkBackgroundWriter = new(context.Platform, MonitorColorScheme.DarkBackground, ColorfulConsoleWriter.GetDefaultColorSchemeConfig(MonitorColorScheme.DarkBackground));
 
             // print question
             this.PrintPlain("Which text looks more readable?");

src/SMAPI.Internal/ConsoleWriting/ColorSchemeConfig.cs

@@ -25,22 +25,23 @@ internal class ColorfulConsoleWriter : IConsoleWriter
     /// <summary>Construct an instance.</summary>
     /// <param name="platform">The target platform.</param>
     public ColorfulConsoleWriter(Platform platform)
-        : this(platform, ColorfulConsoleWriter.GetDefaultColorSchemeConfig(MonitorColorScheme.AutoDetect)) { }
+        : this(platform, MonitorColorScheme.AutoDetect, ColorfulConsoleWriter.GetDefaultColorSchemeConfig(MonitorColorScheme.AutoDetect)) { }
 
     /// <summary>Construct an instance.</summary>
     /// <param name="platform">The target platform.</param>
+    /// <param name="colorSchemeId">The color scheme ID in <paramref name="colorConfig"/> to use, or <see cref="MonitorColorScheme.AutoDetect"/> to select one automatically.</param>
     /// <param name="colorConfig">The colors to use for text written to the SMAPI console.</param>
-    public ColorfulConsoleWriter(Platform platform, ColorSchemeConfig colorConfig)
+    public ColorfulConsoleWriter(Platform platform, MonitorColorScheme colorSchemeId, Dictionary<MonitorColorScheme, Dictionary<ConsoleLogLevel, ConsoleColor>> colorConfig)
     {
-        if (colorConfig.UseScheme == MonitorColorScheme.None)
+        if (colorSchemeId == MonitorColorScheme.None)
         {
             this.SupportsColor = false;
             this.Colors = null;
         }
         else
         {
             this.SupportsColor = this.TestColorSupport();
-            this.Colors = this.GetConsoleColorScheme(platform, colorConfig);
+            this.Colors = this.GetConsoleColorScheme(platform, colorSchemeId, colorConfig);
         }
     }
 
@@ -73,34 +74,31 @@ public void WriteLine(string message, ConsoleLogLevel level)
     /// <summary>Get the default color scheme config for cases where it's not configurable (e.g. the installer).</summary>
     /// <param name="useScheme">The default color scheme ID to use, or <see cref="MonitorColorScheme.AutoDetect"/> to select one automatically.</param>
     /// <remarks>The colors here should be kept in sync with the SMAPI config file.</remarks>
-    public static ColorSchemeConfig GetDefaultColorSchemeConfig(MonitorColorScheme useScheme)
+    public static Dictionary<MonitorColorScheme, Dictionary<ConsoleLogLevel, ConsoleColor>> GetDefaultColorSchemeConfig(MonitorColorScheme useScheme)
     {
-        return new ColorSchemeConfig(
-            useScheme: useScheme,
-            schemes: new Dictionary<MonitorColorScheme, IDictionary<ConsoleLogLevel, ConsoleColor>>
+        return new Dictionary<MonitorColorScheme, Dictionary<ConsoleLogLevel, ConsoleColor>>
+        {
+            [MonitorColorScheme.DarkBackground] = new()
+            {
+                [ConsoleLogLevel.Trace] = ConsoleColor.DarkGray,
+                [ConsoleLogLevel.Debug] = ConsoleColor.DarkGray,
+                [ConsoleLogLevel.Info] = ConsoleColor.White,
+                [ConsoleLogLevel.Warn] = ConsoleColor.Yellow,
+                [ConsoleLogLevel.Error] = ConsoleColor.Red,
+                [ConsoleLogLevel.Alert] = ConsoleColor.Magenta,
+                [ConsoleLogLevel.Success] = ConsoleColor.DarkGreen
+            },
+            [MonitorColorScheme.LightBackground] = new()
             {
-                [MonitorColorScheme.DarkBackground] = new Dictionary<ConsoleLogLevel, ConsoleColor>
-                {
-                    [ConsoleLogLevel.Trace] = ConsoleColor.DarkGray,
-                    [ConsoleLogLevel.Debug] = ConsoleColor.DarkGray,
-                    [ConsoleLogLevel.Info] = ConsoleColor.White,
-                    [ConsoleLogLevel.Warn] = ConsoleColor.Yellow,
-                    [ConsoleLogLevel.Error] = ConsoleColor.Red,
-                    [ConsoleLogLevel.Alert] = ConsoleColor.Magenta,
-                    [ConsoleLogLevel.Success] = ConsoleColor.DarkGreen
-                },
-                [MonitorColorScheme.LightBackground] = new Dictionary<ConsoleLogLevel, ConsoleColor>
-                {
-                    [ConsoleLogLevel.Trace] = ConsoleColor.DarkGray,
-                    [ConsoleLogLevel.Debug] = ConsoleColor.DarkGray,
-                    [ConsoleLogLevel.Info] = ConsoleColor.Black,
-                    [ConsoleLogLevel.Warn] = ConsoleColor.DarkYellow,
-                    [ConsoleLogLevel.Error] = ConsoleColor.Red,
-                    [ConsoleLogLevel.Alert] = ConsoleColor.DarkMagenta,
-                    [ConsoleLogLevel.Success] = ConsoleColor.DarkGreen
-                }
+                [ConsoleLogLevel.Trace] = ConsoleColor.DarkGray,
+                [ConsoleLogLevel.Debug] = ConsoleColor.DarkGray,
+                [ConsoleLogLevel.Info] = ConsoleColor.Black,
+                [ConsoleLogLevel.Warn] = ConsoleColor.DarkYellow,
+                [ConsoleLogLevel.Error] = ConsoleColor.Red,
+                [ConsoleLogLevel.Alert] = ConsoleColor.DarkMagenta,
+                [ConsoleLogLevel.Success] = ConsoleColor.DarkGreen
             }
-        );
+        };
     }
 
 
@@ -123,22 +121,22 @@ private bool TestColorSupport()
 
     /// <summary>Get the color scheme to use for the current console.</summary>
     /// <param name="platform">The target platform.</param>
+    /// <param name="colorSchemeId">The color scheme ID in <paramref name="colorConfig"/> to use, or <see cref="MonitorColorScheme.AutoDetect"/> to select one automatically.</param>
     /// <param name="colorConfig">The colors to use for text written to the SMAPI console.</param>
-    private IDictionary<ConsoleLogLevel, ConsoleColor> GetConsoleColorScheme(Platform platform, ColorSchemeConfig colorConfig)
+    private IDictionary<ConsoleLogLevel, ConsoleColor> GetConsoleColorScheme(Platform platform, MonitorColorScheme colorSchemeId, Dictionary<MonitorColorScheme, Dictionary<ConsoleLogLevel, ConsoleColor>> colorConfig)
     {
         // get color scheme ID
-        MonitorColorScheme schemeId = colorConfig.UseScheme;
-        if (schemeId == MonitorColorScheme.AutoDetect)
+        if (colorSchemeId == MonitorColorScheme.AutoDetect)
         {
-            schemeId = platform == Platform.Mac
+            colorSchemeId = platform == Platform.Mac
                 ? MonitorColorScheme.LightBackground // macOS doesn't provide console background color info, but it's usually white.
                 : ColorfulConsoleWriter.IsDark(Console.BackgroundColor) ? MonitorColorScheme.DarkBackground : MonitorColorScheme.LightBackground;
         }
 
         // get colors for scheme
-        return colorConfig.Schemes.TryGetValue(schemeId, out IDictionary<ConsoleLogLevel, ConsoleColor>? scheme)
+        return colorConfig.TryGetValue(colorSchemeId, out Dictionary<ConsoleLogLevel, ConsoleColor>? scheme)
             ? scheme
-            : throw new NotSupportedException($"Unknown color scheme '{schemeId}'.");
+            : throw new NotSupportedException($"Unknown color scheme '{colorSchemeId}'.");
     }
 
     /// <summary>Get whether a console color should be considered dark, which is subjectively defined as 'white looks better than black on this text'.</summary>

src/SMAPI.Internal/ConsoleWriting/ColorfulConsoleWriter.cs

@@ -10,7 +10,6 @@
   </PropertyGroup>
   <ItemGroup>
     <Compile Include="$(MSBuildThisFileDirectory)ConsoleWriting\ColorfulConsoleWriter.cs" />
-    <Compile Include="$(MSBuildThisFileDirectory)ConsoleWriting\ColorSchemeConfig.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)ConsoleWriting\ConsoleLogLevel.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)ConsoleWriting\IConsoleWriter.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)ConsoleWriting\MonitorColorScheme.cs" />

src/SMAPI.Internal/SMAPI.Internal.projitems

@@ -47,18 +47,19 @@ internal class LogManager : IDisposable
     ****/
     /// <summary>Construct an instance.</summary>
     /// <param name="logPath">The log file path to write.</param>
+    /// <param name="colorSchemeId">The color scheme ID in <paramref name="colorConfig"/> to use, or <see cref="MonitorColorScheme.AutoDetect"/> to select one automatically.</param>
     /// <param name="colorConfig">The colors to use for text written to the SMAPI console.</param>
     /// <param name="writeToConsole">Whether to output log messages to the console.</param>
     /// <param name="verboseLogging">The log contexts for which to enable verbose logging, which may show a lot more information to simplify troubleshooting.</param>
     /// <param name="isDeveloperMode">Whether to enable full console output for developers.</param>
     /// <param name="getScreenIdForLog">Get the screen ID that should be logged to distinguish between players in split-screen mode, if any.</param>
-    public LogManager(string logPath, ColorSchemeConfig colorConfig, bool writeToConsole, HashSet<string> verboseLogging, bool isDeveloperMode, Func<int?> getScreenIdForLog)
+    public LogManager(string logPath, MonitorColorScheme colorSchemeId, Dictionary<MonitorColorScheme, Dictionary<ConsoleLogLevel, ConsoleColor>> colorConfig, bool writeToConsole, HashSet<string> verboseLogging, bool isDeveloperMode, Func<int?> getScreenIdForLog)
     {
         // init log file
         this.LogFile = new LogFileManager(logPath);
 
         // init monitor
-        this.GetMonitorImpl = (id, name) => new Monitor(id, name, this.LogFile, colorConfig, verboseLogging.Contains("*") || verboseLogging.Contains(id), getScreenIdForLog)
+        this.GetMonitorImpl = (id, name) => new Monitor(id, name, this.LogFile, colorSchemeId, colorConfig, verboseLogging.Contains("*") || verboseLogging.Contains(id), getScreenIdForLog)
         {
             WriteToConsole = writeToConsole,
             ShowTraceInConsole = isDeveloperMode,

src/SMAPI/Framework/Logging/LogManager.cs

@@ -95,8 +95,11 @@ internal class SConfig
     /// <summary>Whether to include more technical details about broken mods in the TRACE logs. This is mainly useful for creating compatibility rewriters.</summary>
     public bool LogTechnicalDetailsForBrokenMods { get; set; }
 
+    /// <summary>The color scheme ID in <see cref="ConsoleColorSchemes"/> to use, or <see cref="MonitorColorScheme.AutoDetect"/> to select one automatically.</summary>
+    public MonitorColorScheme ConsoleColorScheme { get; set; }
+
     /// <summary>The colors to use for text written to the SMAPI console.</summary>
-    public ColorSchemeConfig ConsoleColors { get; set; }
+    public Dictionary<MonitorColorScheme, Dictionary<ConsoleLogLevel, ConsoleColor>> ConsoleColorSchemes { get; set; }
 
     /// <summary>Whether to prevent mods from enabling Harmony's debug mode, which impacts performance and creates a file on your desktop. Debug mode should never be enabled by a released mod.</summary>
     public bool SuppressHarmonyDebugMode { get; set; }
@@ -131,7 +134,8 @@ internal class SConfig
     /// <param name="useCaseInsensitivePaths"><inheritdoc cref="UseCaseInsensitivePaths" path="/summary" /></param>
     /// <param name="logNetworkTraffic"><inheritdoc cref="LogNetworkTraffic" path="/summary" /></param>
     /// <param name="logTechnicalDetailsForBrokenMods"><inheritdoc cref="LogTechnicalDetailsForBrokenMods" path="/summary" /></param>
-    /// <param name="consoleColors"><inheritdoc cref="ConsoleColors" path="/summary" /></param>
+    /// <param name="consoleColorScheme"><inheritdoc cref="ConsoleColorScheme" path="/summary" /></param>
+    /// <param name="consoleColorSchemes"><inheritdoc cref="ConsoleColorSchemes" path="/summary" /></param>
     /// <param name="suppressHarmonyDebugMode"><inheritdoc cref="SuppressHarmonyDebugMode" path="/summary" /></param>
     /// <param name="suppressUpdateChecks"><inheritdoc cref="SuppressUpdateChecks" path="/summary" /></param>
     /// <param name="modsToLoadEarly"><inheritdoc cref="ModsToLoadEarly" path="/summary" /></param>
@@ -153,7 +157,8 @@ public SConfig(
         bool? useCaseInsensitivePaths,
         bool? logNetworkTraffic,
         bool? logTechnicalDetailsForBrokenMods,
-        ColorSchemeConfig consoleColors,
+        MonitorColorScheme consoleColorScheme,
+        Dictionary<MonitorColorScheme, Dictionary<ConsoleLogLevel, ConsoleColor>>? consoleColorSchemes,
         bool? suppressHarmonyDebugMode,
         string[]? suppressUpdateChecks,
         string[]? modsToLoadEarly,
@@ -176,7 +181,8 @@ public SConfig(
         this.UseCaseInsensitivePaths = useCaseInsensitivePaths ?? (bool)SConfig.DefaultValues[nameof(this.UseCaseInsensitivePaths)];
         this.LogNetworkTraffic = logNetworkTraffic ?? (bool)SConfig.DefaultValues[nameof(this.LogNetworkTraffic)];
         this.LogTechnicalDetailsForBrokenMods = logTechnicalDetailsForBrokenMods ?? (bool)SConfig.DefaultValues[nameof(this.LogTechnicalDetailsForBrokenMods)];
-        this.ConsoleColors = consoleColors;
+        this.ConsoleColorScheme = consoleColorScheme;
+        this.ConsoleColorSchemes = consoleColorSchemes ?? [];
         this.SuppressHarmonyDebugMode = suppressHarmonyDebugMode ?? (bool)SConfig.DefaultValues[nameof(this.SuppressHarmonyDebugMode)];
         this.SuppressUpdateChecks = new HashSet<string>(suppressUpdateChecks ?? [], StringComparer.OrdinalIgnoreCase);
         this.ModsToLoadEarly = new HashSet<string>(modsToLoadEarly ?? [], StringComparer.OrdinalIgnoreCase);

src/SMAPI/Framework/Models/SConfig.cs

@@ -73,10 +73,11 @@ internal class Monitor : IMonitor
     /// <param name="modId">The mod ID, if applicable.</param>
     /// <param name="source">The name of the module which logs messages using this instance.</param>
     /// <param name="logFile">The log file to which to write messages.</param>
+    /// <param name="colorSchemeId">The color scheme ID in <paramref name="colorConfig"/> to use, or <see cref="MonitorColorScheme.AutoDetect"/> to select one automatically.</param>
     /// <param name="colorConfig">The colors to use for text written to the SMAPI console.</param>
     /// <param name="isVerbose">Whether verbose logging is enabled. This enables more detailed diagnostic messages than are normally needed.</param>
     /// <param name="getScreenIdForLog">Get the screen ID that should be logged to distinguish between players in split-screen mode, if any.</param>
-    public Monitor(string modId, string source, LogFileManager logFile, ColorSchemeConfig colorConfig, bool isVerbose, Func<int?> getScreenIdForLog)
+    public Monitor(string modId, string source, LogFileManager logFile, MonitorColorScheme colorSchemeId, Dictionary<MonitorColorScheme, Dictionary<ConsoleLogLevel, ConsoleColor>> colorConfig, bool isVerbose, Func<int?> getScreenIdForLog)
     {
         // validate
         if (string.IsNullOrWhiteSpace(source))
@@ -86,7 +87,7 @@ public Monitor(string modId, string source, LogFileManager logFile, ColorSchemeC
         this.ModId = modId;
         this.Source = source;
         this.LogFile = logFile ?? throw new ArgumentNullException(nameof(logFile), "The log file manager cannot be null.");
-        this.ConsoleWriter = new ColorfulConsoleWriter(Constants.Platform, colorConfig);
+        this.ConsoleWriter = new ColorfulConsoleWriter(Constants.Platform, colorSchemeId, colorConfig);
         this.IsVerbose = isVerbose;
         this.GetScreenIdForLog = getScreenIdForLog;
     }

src/SMAPI/Framework/Monitor.cs

@@ -206,7 +206,7 @@ public SCore(string modsPath, bool writeToConsole, bool? developerMode)
         }
 
         // init basics
-        this.LogManager = new LogManager(logPath: logPath, colorConfig: this.Settings.ConsoleColors, writeToConsole: writeToConsole, verboseLogging: this.Settings.VerboseLogging, isDeveloperMode: this.Settings.DeveloperMode, getScreenIdForLog: this.GetScreenIdForLog);
+        this.LogManager = new LogManager(logPath: logPath, colorSchemeId: this.Settings.ConsoleColorScheme, colorConfig: this.Settings.ConsoleColorSchemes, writeToConsole: writeToConsole, verboseLogging: this.Settings.VerboseLogging, isDeveloperMode: this.Settings.DeveloperMode, getScreenIdForLog: this.GetScreenIdForLog);
         this.CommandManager = new CommandManager(this.Monitor);
         this.EventManager = new EventManager(this.ModRegistry);
         SCore.DeprecationManager = new DeprecationManager(this.Monitor, this.ModRegistry);