Fully working preloader (hopefully)

src/SpaceWarp.Core/API/Mods/JSON/ModInfo.cs

@@ -108,4 +108,10 @@ public string Name
     /// </summary>
     [JsonProperty("conflicts", Required = Required.DisallowNull)]
     public List<DependencyInfo> Conflicts { get; internal set; } = new();
+
+    /// <summary>
+    /// The filenames of patcher assemblies of the mod.
+    /// </summary>
+    [JsonProperty("patchers", Required = Required.DisallowNull)]
+    public List<string> Patchers { get; internal set; } = new();
 }

src/SpaceWarp.Core/API/Mods/JSON/SpecVersion.cs

@@ -45,11 +45,18 @@ public sealed record SpecVersion
     public static SpecVersion V1_3 { get; } = new(1, 3);
 
     /// <summary>
-    /// Specification version 2.0 (SpaceWarp 1.5.x and 2.0.x) - removes support for version checking from .csproj files,
-    ///
+    /// Specification version 2.0 (SpaceWarp 1.5 - 1.7.x) - removes support for version checking from .csproj files,
+    /// adds support for specifying mod conflicts. Switched to semantic versioning.
     /// </summary>
     public static SpecVersion V2_0 { get; } = new(2, 0);
 
+    /// <summary>
+    /// Specification version 2.1 (SpaceWarp 1.8.x) - requires that mods specify their preload patchers in the
+    /// swinfo.json file.
+    /// </summary>
+    public static SpecVersion V2_1 { get; } = new(2, 1);
+
+
     // ReSharper restore InconsistentNaming
 
     /// <summary>

src/SpaceWarp.Preloader/Entrypoint.cs

@@ -1,28 +1,158 @@
-using System;
-using System.IO;
-using System.Reflection;
+using System.Reflection;
 using JetBrains.Annotations;
+using Newtonsoft.Json.Linq;
 
 namespace SpaceWarp.Preloader;
 
 internal static class Entrypoint
 {
-	private static string _gameFolder;
+    private static readonly List<string> PreloadAssemblyPaths =
+    [
+        Path.Combine("KSP2_x64_Data", "Managed", "Newtonsoft.Json.dll"),
+        Path.Combine("BepInEx", "core", "BepInEx.Preloader.dll"),
+    ];
 
-	[UsedImplicitly]
-	public static void Main(string[] args)
-	{
-		_gameFolder = Path.GetDirectoryName(Environment.GetCommandLineArgs()[0])!;
+    private static string _gameFolder;
+    private static Logger _logger;
 
-		StartBepinex();
-	}
+    [UsedImplicitly]
+    public static void Main(string[] args)
+    {
+        _gameFolder = Path.GetDirectoryName(Environment.GetCommandLineArgs()[0])!;
+        _logger = new Logger(_gameFolder);
 
-	private static void StartBepinex()
-	{
-		var bepinexFolder = Path.Combine(_gameFolder, "BepInEx", "core");
-		var bepinexPreloaderPath = Path.Combine(bepinexFolder, "BepInEx.Preloader.dll");
+        PreloadAssemblies();
+        ProcessAllPatchers();
+        StartBepinex();
+    }
 
-		Assembly.LoadFile(bepinexPreloaderPath);
-		BepInEx.Preloader.Entrypoint.Main();
-	}
+    private static void PreloadAssemblies()
+    {
+        foreach (var fullPath in PreloadAssemblyPaths.Select(assemblyPath => Path.Combine(_gameFolder, assemblyPath)))
+        {
+            try
+            {
+                _logger.LogDebug($"Preloading {fullPath}...");
+                Assembly.LoadFile(fullPath);
+            }
+            catch (Exception ex)
+            {
+                _logger.LogException(ex, $"An error occurred while preloading the assembly {fullPath}:");
+            }
+        }
+    }
+
+    private static void StartBepinex()
+    {
+        BepInEx.Preloader.Entrypoint.Main();
+    }
+
+    #region Disabling patchers of disabled plugins
+
+    private static void ProcessAllPatchers()
+    {
+        var disabledPluginGuids = GetDisabledPluginGuids();
+
+        var swinfoPaths = Directory
+            .EnumerateFiles(
+                Path.Combine(_gameFolder, "BepInEx", "plugins"),
+                "swinfo.json",
+                SearchOption.AllDirectories
+            );
+
+        var enablePatchers = new List<string>();
+        var disablePatchers = new List<string>();
+
+        foreach (var swinfoPath in swinfoPaths)
+        {
+            try
+            {
+                var (guid, patchers) = ReadSwinfo(swinfoPath);
+
+                if (patchers == null)
+                {
+                    continue;
+                }
+
+                if (!disabledPluginGuids.Contains(guid))
+                {
+                    enablePatchers.AddRange(patchers.Select(StripExtension));
+                }
+                else
+                {
+                    disablePatchers.AddRange(patchers.Select(StripExtension));
+                }
+            }
+            catch (Exception ex)
+            {
+                _logger.LogException(ex, $"An error occurred while processing {swinfoPath}:");
+            }
+        }
+
+        RenameAllPatchers(enablePatchers, disablePatchers);
+    }
+
+    private static string[] GetDisabledPluginGuids()
+    {
+        var disabledPluginsPath = Path.Combine(_gameFolder, "BepInEx", "disabled_plugins.cfg");
+
+        return File.Exists(disabledPluginsPath)
+            ? File.ReadAllLines(disabledPluginsPath)
+            : [];
+    }
+
+    private static (string guid, List<string> patchers) ReadSwinfo(string swinfoPath)
+    {
+        _logger.LogDebug($"Reading {swinfoPath}...");
+
+        var swinfo = JObject.Parse(File.ReadAllText(swinfoPath));
+
+        var guid = swinfo["mod_id"]?.Value<string>();
+        if (guid == null)
+        {
+            throw new Exception($"{swinfoPath} does not contain a mod_id.");
+        }
+
+        var patchers = swinfo["patchers"]?.Values<string>().ToList();
+        if (patchers == null)
+        {
+            _logger.LogInfo($"{guid} does not contain patchers, skipping.");
+        }
+
+        return (guid, patchers);
+    }
+
+    private static void RenameAllPatchers(ICollection<string> enablePatchers, ICollection<string> disablePatchers)
+    {
+        var patchers = Directory
+            .EnumerateFiles(Path.Combine(_gameFolder, "BepInEx", "patchers"), "*", SearchOption.AllDirectories)
+            .Where(file => file.EndsWith(".dll") || file.EndsWith(".dll.disabled"));
+
+        foreach (var patcher in patchers)
+        {
+            var patcherName = StripExtension(Path.GetFileName(patcher));
+
+            if (enablePatchers.Contains(patcherName) && patcher.EndsWith(".dll.disabled"))
+            {
+                _logger.LogDebug($"Enabling {patcherName}...");
+                File.Move(patcher, patcher.Replace(".dll.disabled", ".dll"));
+            }
+            else if (disablePatchers.Contains(patcherName) && patcher.EndsWith(".dll"))
+            {
+                _logger.LogDebug($"Disabling {patcherName}...");
+                File.Move(patcher, patcher.Replace(".dll", ".dll.disabled"));
+            }
+            else
+            {
+                _logger.LogDebug($"Skipping {patcherName}...");
+            }
+        }
+    }
+
+    private static string StripExtension(string filename)
+    {
+        return filename.Replace(".disabled", "").Replace(".dll", "");
+    }
+
+    #endregion
 }

src/SpaceWarp.Preloader/Logger.cs

@@ -0,0 +1,79 @@
+using System.ComponentModel;
+
+namespace SpaceWarp.Preloader;
+
+internal enum LogLevel
+{
+    Debug,
+    Info,
+    Warning,
+    Error
+}
+
+internal static class LogLevelExtensions
+{
+    public static string ToLogString(this LogLevel logLevel)
+    {
+        return logLevel switch
+        {
+            LogLevel.Debug => "DEBUG",
+            LogLevel.Info => "INFO ",
+            LogLevel.Warning => "WARN ",
+            LogLevel.Error => "ERR  ",
+            _ => throw new InvalidEnumArgumentException(nameof(logLevel), (int)logLevel, typeof(LogLevel))
+        };
+    }
+}
+
+internal class Logger
+{
+    private readonly string _logPath;
+
+    public Logger(string gamePath)
+    {
+        _logPath = Path.Combine(gamePath, "BepInEx", "SpaceWarp.Preload.log");
+
+        if (File.Exists(_logPath))
+        {
+            File.Delete(_logPath);
+        }
+    }
+
+    private void Log(object message, LogLevel logLevel = LogLevel.Info)
+    {
+        var logMessage =
+            $"[{logLevel.ToLogString()}: {DateTime.Now:yyyy-MM-dd HH:mm:ss.fff}] {message}{Environment.NewLine}";
+        File.AppendAllText(_logPath, logMessage);
+    }
+
+    public void LogDebug(object message)
+    {
+        Log(message, LogLevel.Debug);
+    }
+
+    public void LogInfo(object message)
+    {
+        Log(message, LogLevel.Info);
+    }
+
+    public void LogWarning(object message)
+    {
+        Log(message, LogLevel.Warning);
+    }
+
+    public void LogError(object message)
+    {
+        Log(message, LogLevel.Error);
+    }
+
+    public void LogException(Exception ex, string message = null)
+    {
+        var logMessage = $"{ex.Message}{Environment.NewLine}{ex.StackTrace}";
+        if (message != null)
+        {
+            logMessage = $"{message}{Environment.NewLine}{logMessage}";
+        }
+
+        LogError(logMessage);
+    }
+}

src/SpaceWarp.Preloader/SpaceWarp.Preloader.csproj

@@ -1,12 +1,13 @@
 <Project Sdk="Microsoft.NET.Sdk">
     <!-- References -->
     <ItemGroup Label="NuGet package references">
-        <PackageReference Include="BepInEx.AssemblyPublicizer.MSBuild" Version="0.4.1" PrivateAssets="all" Private="false"/>
-        <PackageReference Include="JetBrains.Annotations" Version="2023.3.0" PrivateAssets="all" Private="false"/>
+        <PackageReference Include="BepInEx.AssemblyPublicizer.MSBuild" Version="0.4.1" Private="false"/>
+        <PackageReference Include="JetBrains.Annotations" Version="2023.3.0" Private="false"/>
+        <PackageReference Include="Newtonsoft.Json" Version="13.0.3" Private="false"/>
     </ItemGroup>
     <ItemGroup>
       <Reference Include="BepInEx.Preloader" Publicize="true" PrivateAssets="all" Private="false">
-        <HintPath>..\..\plugin_template\BepInEx\core\BepInEx.Preloader.dll</HintPath>
+        <HintPath>$(SolutionDir)/plugin_template/BepInEx/core/BepInEx.Preloader.dll</HintPath>
       </Reference>
     </ItemGroup>
 </Project>

src/SpaceWarp/Directory.Build.targets

@@ -83,11 +83,17 @@
         <!-- Copying compiled preloader to build directory -->
         <Message Text="Copying preloader DLLs to build directory"/>
         <ItemGroup Label="Preloader DLLs to be copied">
-            <PreloaderDLLs Include="$(PreloaderBinPath)/**/*.dll" Exclude="$(PreloaderBinPath)/**/*.pdb"/>
+            <PreloaderDLLs Include="$(PreloaderBinPath)/**/*.dll"/>
         </ItemGroup>
         <Copy SourceFiles="@(PreloaderDLLs)"
               DestinationFolder="$(SolutionDir)/dist/$(ConfigurationName)/BepInEx/core"/>
 
+        <ItemGroup Label="Preloader PDBs to be copied">
+            <PreloaderPDBs Include="$(PreloaderBinPath)/**/*.pdb"/>
+        </ItemGroup>
+        <Copy SourceFiles="@(PreloaderPDBs)"
+              DestinationFolder="$(SolutionDir)/dist/$(ConfigurationName)/BepInEx/core"/>
+
         <!-- Copying compiled restarter to build directory -->
         <Message Text="Copying restarter to build directory"/>
         <ItemGroup Label="Restarter files to be copied">
@@ -139,9 +145,9 @@
                    Directories="$(KSP2DIR)/BepInEx/plugins/$(ProjectName)"/>
         <RemoveDir Condition="$(ConfigurationName) == Deploy Or $(ConfigurationName) == DeployAndRun"
                    Directories="$(KSP2DIR)/BepInEx/patchers/$(ProjectName)"/>
-        <Delete Files="$(KSP2DIR)/SpaceWarp.Preloader.dll"
+        <Delete Files="$(KSP2DIR)/BepInEx/core/SpaceWarp.Preloader.dll"
                 Condition="$(ConfigurationName) == Deploy Or $(ConfigurationName) == DeployAndRun"/>
-        <Delete Files="$(KSP2DIR)/SpaceWarp.Preloader.pdb"
+        <Delete Files="$(KSP2DIR)/BepInEx/core/SpaceWarp.Preloader.pdb"
                 Condition="$(ConfigurationName) == Deploy Or $(ConfigurationName) == DeployAndRun"/>
 
         <ItemGroup Label="Dist folder to be copied">