Support for SKSE launching when running Skyrim (#505)

Author: halgari

src/Games/NexusMods.Games.BethesdaGameStudios/RunGameWithScriptExtender.cs

@@ -0,0 +1,28 @@
+using Microsoft.Extensions.Logging;
+using NexusMods.Common;
+using NexusMods.DataModel.Extensions;
+using NexusMods.DataModel.Games;
+using NexusMods.DataModel.Loadouts;
+using NexusMods.DataModel.Loadouts.LoadoutSynchronizerDTOs;
+using NexusMods.Paths;
+
+namespace NexusMods.Games.BethesdaGameStudios;
+
+/// <summary>
+/// A tool that allows running the game with a script extender.
+/// </summary>
+/// <typeparam name="T"></typeparam>
+public abstract class RunGameWithScriptExtender<T> : RunGameTool<T> where T : AGame {
+    // ReSharper disable once ContextualLoggerProblem
+    protected RunGameWithScriptExtender(ILogger<RunGameTool<T>> logger, T game, IProcessFactory processFactory)
+        : base(logger, game, processFactory) { }
+    
+    protected abstract GamePath ScriptLoaderPath { get; }
+
+    protected override AbsolutePath GetGamePath(Loadout loadout, ApplyPlan applyPlan)
+    {
+        return applyPlan.Flattened.ContainsKey(ScriptLoaderPath) ? 
+            ScriptLoaderPath.CombineChecked(loadout.Installation) : 
+            base.GetGamePath(loadout, applyPlan);
+    }
+}

src/Games/NexusMods.Games.BethesdaGameStudios/Services.cs

@@ -12,8 +12,8 @@ public static IServiceCollection AddBethesdaGameStudios(this IServiceCollection
     {
         services.AddAllSingleton<IGame, SkyrimSpecialEdition>();
         services.AddAllSingleton<IGame, SkyrimLegendaryEdition>();
-        services.AddSingleton<ITool, RunGameTool<SkyrimLegendaryEdition>>();
-        services.AddSingleton<ITool, RunGameTool<SkyrimSpecialEdition>>();
+        services.AddSingleton<ITool, SkyrimLegendaryEditionGameTool>();
+        services.AddSingleton<ITool, SkyrimSpecialEditionGameTool>();
         services.AddAllSingleton<IFileAnalyzer, PluginAnalyzer>();
         services.AddAllSingleton<ITypeFinder, TypeFinder>();
         return services;

src/Games/NexusMods.Games.BethesdaGameStudios/SkyrimLegendaryEdition/SkyrimLegendaryEditionGameTool.cs

@@ -0,0 +1,14 @@
+using Microsoft.Extensions.Logging;
+using NexusMods.Common;
+using NexusMods.DataModel.Games;
+using NexusMods.Paths;
+
+namespace NexusMods.Games.BethesdaGameStudios;
+
+public class SkyrimLegendaryEditionGameTool : RunGameWithScriptExtender<SkyrimLegendaryEdition>
+{
+    // ReSharper disable once ContextualLoggerProblem
+    public SkyrimLegendaryEditionGameTool(ILogger<RunGameTool<SkyrimLegendaryEdition>> logger, SkyrimLegendaryEdition game, IProcessFactory processFactory) 
+        : base(logger, game, processFactory) { }
+    protected override GamePath ScriptLoaderPath => new(GameFolderType.Game, "skse_loader.exe");
+}

src/Games/NexusMods.Games.BethesdaGameStudios/SkyrimSpecialEdition/SkyrimSpecialEditionGameTool.cs

@@ -0,0 +1,14 @@
+using Microsoft.Extensions.Logging;
+using NexusMods.Common;
+using NexusMods.DataModel.Games;
+using NexusMods.Paths;
+
+namespace NexusMods.Games.BethesdaGameStudios;
+
+public class SkyrimSpecialEditionGameTool : RunGameWithScriptExtender<SkyrimSpecialEdition>
+{
+    // ReSharper disable once ContextualLoggerProblem
+    public SkyrimSpecialEditionGameTool(ILogger<RunGameTool<SkyrimSpecialEdition>> logger, SkyrimSpecialEdition game, IProcessFactory processFactory) 
+        : base(logger, game, processFactory) { }
+    protected override GamePath ScriptLoaderPath => new(GameFolderType.Game, "skse64_loader.exe");
+}

src/Games/NexusMods.Games.RedEngine/RedModDeployTool.cs

@@ -4,6 +4,7 @@
 using NexusMods.DataModel.Extensions;
 using NexusMods.DataModel.Games;
 using NexusMods.DataModel.Loadouts;
+using NexusMods.DataModel.Loadouts.LoadoutSynchronizerDTOs;
 using NexusMods.Paths;
 
 namespace NexusMods.Games.RedEngine;
@@ -21,7 +22,7 @@ public RedModDeployTool(ILogger<RedModDeployTool> logger)
 
     public IEnumerable<GameDomain> Domains => new[] { Cyberpunk2077.StaticDomain };
 
-    public async Task Execute(Loadout loadout)
+    public async Task Execute(Loadout loadout, ApplyPlan applyPlan, CancellationToken cancellationToken)
     {
         var exe = RedModPath.CombineChecked(loadout.Installation);
 

src/NexusMods.DataModel/Games/ITool.cs

@@ -1,4 +1,5 @@
 using NexusMods.DataModel.Loadouts;
+using NexusMods.DataModel.Loadouts.LoadoutSynchronizerDTOs;
 
 namespace NexusMods.DataModel.Games;
 
@@ -22,5 +23,7 @@ public interface ITool
     /// Executes this tool.
     /// </summary>
     /// <param name="loadout">The collection of mods (loadout) to be used with this tool.</param>
-    public Task Execute(Loadout loadout);
+    /// <param name="applyPlan">The plan applied before this tool was executed</param>
+    /// <param name="cancellationToken"></param>
+    public Task Execute(Loadout loadout, ApplyPlan applyPlan, CancellationToken cancellationToken);
 }

src/NexusMods.DataModel/Games/RunGameTool.cs

@@ -3,7 +3,9 @@
 using CliWrap;
 using Microsoft.Extensions.Logging;
 using NexusMods.Common;
+using NexusMods.DataModel.Extensions;
 using NexusMods.DataModel.Loadouts;
+using NexusMods.DataModel.Loadouts.LoadoutSynchronizerDTOs;
 using NexusMods.Paths;
 
 namespace NexusMods.DataModel.Games;
@@ -14,6 +16,7 @@ namespace NexusMods.DataModel.Games;
 /// </summary>
 public interface IRunGameTool : ITool
 {
+
 }
 
 /// <summary>
@@ -47,11 +50,30 @@ public RunGameTool(ILogger<RunGameTool<T>> logger, T game, IProcessFactory proce
     public string Name => $"Run {_game.Name}";
 
     /// <inheritdoc />
-    public async Task Execute(Loadout loadout)
+    public async Task Execute(Loadout loadout, ApplyPlan applyPlan, CancellationToken cancellationToken)
     {
-        var program = _game.GetPrimaryFile(loadout.Installation.Store).Combine(loadout.Installation.Locations[GameFolderType.Game]);
+        var program = GetGamePath(loadout, applyPlan);
         _logger.LogInformation("Running {Program}", program);
 
+        var primaryFile = _game.GetPrimaryFile(loadout.Installation.Store).CombineChecked(loadout.Installation);
+        var names = new HashSet<string>()
+        {
+            program.FileName,
+            program.GetFileNameWithoutExtension(),
+            primaryFile.FileName,
+            primaryFile.GetFileNameWithoutExtension()
+        };
+
+        // In the case of a preloader, we need to wait for the actual game file to exit
+        // before we completely exit this routine. So get a list of all the processes with a give
+        // name at the start, after the preloader finishes find any other processes with the same set of 
+        // names, and then we wait for those to exit.
+        
+        // In the case of something like Skyrim this means we will start with loading skse64_loader.exe then
+        // notice that SkyrimSE.exe is running and wait for that to exit.
+        
+        var existing = FindMatchingProcesses(names).Select(p => p.Id).ToHashSet();
+
         var stdOut = new StringBuilder();
         var stdErr = new StringBuilder();
         var command = new Command(program.ToString())
@@ -60,11 +82,45 @@ public async Task Execute(Loadout loadout)
             .WithValidation(CommandResultValidation.None)
             .WithWorkingDirectory(program.Parent.ToString());
 
-
-        var result = await _processFactory.ExecuteAsync(command);
+        
+        var result = await _processFactory.ExecuteAsync(command, cancellationToken);
         if (result.ExitCode != 0)
             _logger.LogError("While Running {Filename} : {Error} {Output}", program, stdErr, stdOut);
 
+        var newProcesses = FindMatchingProcesses(names)
+            .Where(p => !existing.Contains(p.Id))
+            .ToHashSet();
+        
+        if (newProcesses.Count > 0)
+        {
+            _logger.LogInformation("Waiting for {Count} processes to exit", newProcesses.Count);
+            while (true)
+            {
+                await Task.Delay(500, cancellationToken);
+                if (newProcesses.All(p => p.HasExited))
+                    break;
+            }
+            _logger.LogInformation("All {Count} processes have exited", newProcesses.Count);
+        }
+
         _logger.LogInformation("Finished running {Program}", program);
     }
+
+    private static HashSet<Process> FindMatchingProcesses(HashSet<string> names)
+    {
+        return Process.GetProcesses()
+            .Where(p => names.Contains(p.ProcessName))
+            .ToHashSet();
+    }
+
+    /// <summary>
+    /// Returns the path to the main executable file for the game.
+    /// </summary>
+    /// <param name="loadout"></param>
+    /// <param name="applyPlan"></param>
+    /// <returns></returns>
+    protected virtual AbsolutePath GetGamePath(Loadout loadout, ApplyPlan applyPlan)
+    {
+        return _game.GetPrimaryFile(loadout.Installation.Store).Combine(loadout.Installation.Locations[GameFolderType.Game]);
+    }
 }

src/NexusMods.DataModel/ToolManager.cs

@@ -47,7 +47,7 @@ public async Task<Loadout> RunTool(ITool tool, Loadout loadout, ModId? generated
         var plan = await _loadoutSynchronizer.MakeApplySteps(loadout, token);
         await _loadoutSynchronizer.Apply(plan, token);
 
-        await tool.Execute(loadout);
+        await tool.Execute(loadout, plan, token);
         var modName = $"{tool.Name} Generated Files";
 
         if (generatedFilesMod == null)

tests/NexusMods.StandardGameLocators.TestHelpers/ListFilesTool.cs

@@ -1,5 +1,6 @@
 using NexusMods.DataModel.Games;
 using NexusMods.DataModel.Loadouts;
+using NexusMods.DataModel.Loadouts.LoadoutSynchronizerDTOs;
 using NexusMods.Paths;
 
 namespace NexusMods.StandardGameLocators.TestHelpers;
@@ -8,7 +9,7 @@ public class ListFilesTool : ITool
 {
     public IEnumerable<GameDomain> Domains => new[] { GameDomain.From("stubbed-game") };
 
-    public async Task Execute(Loadout loadout)
+    public async Task Execute(Loadout loadout, ApplyPlan applyPlan, CancellationToken cancellationToken)
     {
         var listPath = loadout.Installation.Locations[GameFolderType.Game];
         var outPath = GeneratedFilePath.Combine(listPath);