Add Debug to properties.yml

LabApi/Features/Console/Logger.cs

@@ -22,12 +22,31 @@ public static class Logger
     /// <param name="color">The color of the message.</param>
     public static void Raw(string message, ConsoleColor color) => ServerConsole.AddLog(message, color);
 
+    /// <summary>
+    /// An O(1) set of Assemblies that should display Debug messages.
+    /// Populated automatically by <see cref="LabApi.Loader.Features.Plugins.Configuration.Properties.Debug"/>
+    /// </summary>
+    public static System.Collections.Generic.HashSet<Assembly> DebugEnabled { get; } = new();
+
+    /// <summary>
+    /// Logs a debug message to the server console.
+    /// Checks <see cref="DebugEnabled"/> before sending the message.
+    /// </summary>
+    /// <param name="message">The message to log.</param>
+    public static void Debug(object message) => Debug(
+        message,
+        Loader.PluginLoader.Config?.DebugOverride == true || DebugEnabled.Contains(Assembly.GetCallingAssembly()));
+
     /// <summary>
     /// Logs a debug message to the server console.
     /// </summary>
     /// <param name="message">The message to log.</param>
     /// <param name="canBePrinted">Whether the message can be printed.</param>
-    public static void Debug(object message, bool canBePrinted = true)
+    /// <remarks>
+    /// Uses explicit <paramref name="canBePrinted"/>.
+    /// Can be replaced with the single parameter overload to use <see cref="LabApi.Loader.Features.Plugins.Configuration.Properties.Debug"/> Property instead.
+    /// </remarks>
+    public static void Debug(object message, bool canBePrinted)
     {
         if (!canBePrinted)
         {

LabApi/Loader/Features/Configuration/LabApiConfig.cs

@@ -27,4 +27,11 @@ public class LabApiConfig
     /// <seealso cref="LabApi.Loader.Features.Plugins.Configuration.Properties.UnsupportedLoading"/>
     [Description("Whether to allow loading plugins even if they were built for a different major version of LabAPI.")]
     public bool LoadUnsupportedPlugins { get; set; }
+
+    /// <summary>
+    /// Whether debug logs should appear regardless of pre-plugin properties.
+    /// </summary>
+    /// <seealso cref="LabApi.Loader.Features.Plugins.Configuration.Properties.Debug"/>
+    [Description("Whether debug logs should be printed regardless of per-plugin properties. Only recommended during Plugin development.")]
+    public bool DebugOverride { get; set; } = false;
 }

LabApi/Loader/Features/Plugins/Configuration/Properties.cs

@@ -20,6 +20,15 @@ public class Properties
     [Description("Whether or not the plugin is enabled.")]
     public bool IsEnabled { get; set; } = true;
 
+    /// <summary>
+    /// Whether <see cref="LabApi.Features.Console.Logger.Debug"/> should print logs.
+    /// </summary>
+    /// <remarks>
+    /// Using the same naming as EXILED to ease transition for devs moving to LabAPI.
+    /// </remarks>
+    [Description("Whether or not [DEBUG] log messages should appear in the console. Default is false.")]
+    public bool Debug { get; set; } = false;
+
     /// <summary>
     /// Whether to allow loading the plugin even if it was built for a different major version of LabAPI.
     /// </summary>

LabApi/Loader/PluginLoader.cs

@@ -14,6 +14,8 @@
 using System.IO;
 using System.Linq;
 using System.Reflection;
+using NorthwoodLib.Pools;
+using Utils.NonAllocLINQ;
 
 namespace LabApi.Loader;
 
@@ -233,6 +235,7 @@ public static void LoadPlugins(IEnumerable<FileInfo> files)
     /// <param name="plugins">The sorted collection of <see cref="Plugin"/>s.</param>
     public static void EnablePlugins(IEnumerable<Plugin> plugins)
     {
+        Logger.DebugEnabled.Clear();
         foreach (Plugin plugin in plugins)
         {
             // We try to load the configuration of the plugin
@@ -253,6 +256,20 @@ public static void EnablePlugins(IEnumerable<Plugin> plugins)
                 continue;
             }
 
+            // Check if the plugin associated with this assembly wants Debug logs enabled.
+            if (plugin.Properties?.Debug == true)
+            {
+                // This body will not be run on most live servers.
+                if (Plugins.TryGetValue(plugin, out Assembly asm))
+                {
+                    if (Logger.DebugEnabled.Add(asm))
+                    {
+                        // Only want to print when the first plugin in an assembly enables Debug
+                        Logger.Info($"Debug logging enabled for {asm.FullName}");
+                    }
+                }
+            }
+
             // We finally enable the plugin
             EnablePlugin(plugin);
         }