diff --git a/src/SpaceWarp.Core/API/Mods/JSON/ModInfo.cs b/src/SpaceWarp.Core/API/Mods/JSON/ModInfo.cs index 49b94b3..6be09bd 100644 --- a/src/SpaceWarp.Core/API/Mods/JSON/ModInfo.cs +++ b/src/SpaceWarp.Core/API/Mods/JSON/ModInfo.cs @@ -108,4 +108,10 @@ public string Name /// [JsonProperty("conflicts", Required = Required.DisallowNull)] public List Conflicts { get; internal set; } = new(); + + /// + /// The filenames of patcher assemblies of the mod. + /// + [JsonProperty("patchers", Required = Required.DisallowNull)] + public List Patchers { get; internal set; } = new(); } \ No newline at end of file diff --git a/src/SpaceWarp.Core/API/Mods/JSON/SpecVersion.cs b/src/SpaceWarp.Core/API/Mods/JSON/SpecVersion.cs index 0deb260..1c32280 100644 --- a/src/SpaceWarp.Core/API/Mods/JSON/SpecVersion.cs +++ b/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); /// - /// 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. /// public static SpecVersion V2_0 { get; } = new(2, 0); + /// + /// Specification version 2.1 (SpaceWarp 1.8.x) - requires that mods specify their preload patchers in the + /// swinfo.json file. + /// + public static SpecVersion V2_1 { get; } = new(2, 1); + + // ReSharper restore InconsistentNaming /// diff --git a/src/SpaceWarp.Preloader/Entrypoint.cs b/src/SpaceWarp.Preloader/Entrypoint.cs index 81bee39..92882c1 100644 --- a/src/SpaceWarp.Preloader/Entrypoint.cs +++ b/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 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(); + var disablePatchers = new List(); + + 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 patchers) ReadSwinfo(string swinfoPath) + { + _logger.LogDebug($"Reading {swinfoPath}..."); + + var swinfo = JObject.Parse(File.ReadAllText(swinfoPath)); + + var guid = swinfo["mod_id"]?.Value(); + if (guid == null) + { + throw new Exception($"{swinfoPath} does not contain a mod_id."); + } + + var patchers = swinfo["patchers"]?.Values().ToList(); + if (patchers == null) + { + _logger.LogInfo($"{guid} does not contain patchers, skipping."); + } + + return (guid, patchers); + } + + private static void RenameAllPatchers(ICollection enablePatchers, ICollection 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 } \ No newline at end of file diff --git a/src/SpaceWarp.Preloader/Logger.cs b/src/SpaceWarp.Preloader/Logger.cs new file mode 100644 index 0000000..fcfea00 --- /dev/null +++ b/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); + } +} \ No newline at end of file diff --git a/src/SpaceWarp.Preloader/SpaceWarp.Preloader.csproj b/src/SpaceWarp.Preloader/SpaceWarp.Preloader.csproj index 2242dd5..68b83e8 100644 --- a/src/SpaceWarp.Preloader/SpaceWarp.Preloader.csproj +++ b/src/SpaceWarp.Preloader/SpaceWarp.Preloader.csproj @@ -1,12 +1,13 @@  - - + + + - ..\..\plugin_template\BepInEx\core\BepInEx.Preloader.dll + $(SolutionDir)/plugin_template/BepInEx/core/BepInEx.Preloader.dll diff --git a/src/SpaceWarp/Directory.Build.targets b/src/SpaceWarp/Directory.Build.targets index d3973e5..35a1ded 100644 --- a/src/SpaceWarp/Directory.Build.targets +++ b/src/SpaceWarp/Directory.Build.targets @@ -83,11 +83,17 @@ - + + + + + + @@ -139,9 +145,9 @@ Directories="$(KSP2DIR)/BepInEx/plugins/$(ProjectName)"/> - -