Merge pull request #2103 from erri120/heroic

Find GOG games installed with the Heroic launcher
Nexus-Mods · Sep 30, 2024 · 7e795ca · 7e795ca
2 parents 3f23812 + 0b12554
commit 7e795ca
Show file tree

Hide file tree

Showing 7 changed files with 85 additions and 4 deletions.
diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -6,6 +6,7 @@
     <PackageVersion Include="AvaloniaEdit.TextMate" Version="11.1.0" />
     <PackageVersion Include="FlatSharp.Compiler" Version="7.6.0" />
     <PackageVersion Include="FlatSharp.Runtime" Version="7.6.0" />
+    <PackageVersion Include="GameFinder.Launcher.Heroic" Version="4.3.0" />
     <PackageVersion Include="LinqGen" Version="0.3.1" />
     <PackageVersion Include="Microsoft.Extensions.Http.Resilience" Version="8.8.0" />
     <PackageVersion Include="Microsoft.Extensions.Options" Version="8.0.0" />
@@ -120,7 +121,7 @@
     <PackageVersion Include="BitFaster.Caching" Version="2.5.0" />
     <PackageVersion Include="CliWrap" Version="3.6.6" />
     <PackageVersion Include="DynamicData" Version="9.0.4" />
-    <PackageVersion Include="GameFinder" Version="4.2.4" />
+    <PackageVersion Include="GameFinder" Version="4.3.0" />
     <PackageVersion Include="Humanizer" Version="2.14.1" />
     <PackageVersion Include="ini-parser-netstandard" Version="2.5.2" />
     <PackageVersion Include="Mutagen.Bethesda.Skyrim" Version="0.44.0" />

diff --git a/src/Abstractions/NexusMods.Abstractions.GameLocators/Stores/GOG/GOGLocatorResultMetadata.cs b/src/Abstractions/NexusMods.Abstractions.GameLocators/Stores/GOG/GOGLocatorResultMetadata.cs
@@ -14,3 +14,6 @@ public record GOGLocatorResultMetadata : IGameLocatorResultMetadata
     /// </summary>
     public required long Id { get; init; }
 }
+
+[PublicAPI]
+public record HeroicGOGLocatorResultMetadata : GOGLocatorResultMetadata;
diff --git a/src/Abstractions/NexusMods.Abstractions.Games/RunGameTool.cs b/src/Abstractions/NexusMods.Abstractions.Games/RunGameTool.cs
@@ -5,6 +5,7 @@
 using Microsoft.Extensions.Logging;
 using NexusMods.Abstractions.GameLocators;
 using NexusMods.Abstractions.Games.DTO;
+using NexusMods.Abstractions.Games.Stores.GOG;
 using NexusMods.Abstractions.Games.Stores.Steam;
 using NexusMods.Abstractions.Loadouts;
 using NexusMods.CrossPlatform.Process;
@@ -60,10 +61,18 @@ public async Task Execute(Loadout.ReadOnly loadout, CancellationToken cancellati
         var program = await GetGamePath(loadout);
         var primaryFile = _game.GetPrimaryFile(loadout.InstallationInstance.Store).CombineChecked(loadout.InstallationInstance);
 
-        if (OSInformation.Shared.IsLinux && program.Equals(primaryFile) && loadout.InstallationInstance.LocatorResultMetadata is SteamLocatorResultMetadata steamLocatorResultMetadata)
+        if (OSInformation.Shared.IsLinux && program.Equals(primaryFile))
         {
-            await RunThroughSteam(steamLocatorResultMetadata.AppId, cancellationToken);
-            return;
+            var locator = loadout.InstallationInstance.LocatorResultMetadata;
+            switch (locator)
+            {
+                case SteamLocatorResultMetadata steamLocatorResultMetadata:
+                    await RunThroughSteam(steamLocatorResultMetadata.AppId, cancellationToken);
+                    return;
+                case HeroicGOGLocatorResultMetadata heroicGOGLocatorResultMetadata:
+                    await RunThroughHeroic("gog", heroicGOGLocatorResultMetadata.Id, cancellationToken);
+                    return;
+            }
         }
 
         var names = new HashSet<string>
@@ -177,6 +186,14 @@ private async Task RunThroughSteam(uint appId, CancellationToken cancellationTok
         await reaper.WaitForExitAsync(cancellationToken);
     }
 
+    private async Task RunThroughHeroic(string type, long appId, CancellationToken cancellationToken)
+    {
+        Debug.Assert(OSInformation.Shared.IsLinux);
+
+        // TODO: track process
+        await _osInterop.OpenUrl(new Uri($"heroic://launch/{type}/{appId.ToString(CultureInfo.InvariantCulture)}"), fireAndForget: true, cancellationToken: cancellationToken);
+    }
+
     private async ValueTask<Process?> WaitForProcessToStart(
         string processName,
         TimeSpan timeout,

diff --git a/src/NexusMods.StandardGameLocators/HeroicGogLocator.cs b/src/NexusMods.StandardGameLocators/HeroicGogLocator.cs
@@ -0,0 +1,53 @@
+using GameFinder.Launcher.Heroic;
+using GameFinder.StoreHandlers.GOG;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
+using NexusMods.Abstractions.GameLocators;
+using NexusMods.Abstractions.GameLocators.Stores.GOG;
+using NexusMods.Abstractions.Games.Stores.GOG;
+
+namespace NexusMods.StandardGameLocators;
+
+/// <summary>
+/// Find GOG games installed with the Heroic launcher.
+/// </summary>
+public class HeroicGogLocator : IGameLocator
+{
+    private readonly ILogger _logger;
+
+    private readonly HeroicGOGHandler _handler;
+    private IReadOnlyDictionary<GOGGameId, GOGGame>? _cachedGames;
+
+    /// <summary>
+    /// Constructor.
+    /// </summary>
+    public HeroicGogLocator(IServiceProvider provider)
+    {
+        _logger = provider.GetRequiredService<ILogger<HeroicGogLocator>>();
+        _handler = provider.GetRequiredService<HeroicGOGHandler>();
+    }
+
+    public IEnumerable<GameLocatorResult> Find(ILocatableGame game)
+    {
+        if (game is not IGogGame tg) yield break;
+
+        if (_cachedGames is null)
+        {
+            _cachedGames = _handler.FindAllGamesById(out var errors);
+            if (errors.Any())
+            {
+                foreach (var error in errors)
+                    _logger.LogError("While looking for games: {Error}", error);
+            }
+        }
+
+        foreach (var id in tg.GogIds)
+        {
+            if (!_cachedGames.TryGetValue(GOGGameId.From(id), out var found)) continue;
+            yield return new GameLocatorResult(found.Path, GameStore.GOG, new HeroicGOGLocatorResultMetadata
+            {
+                Id = id,
+            });
+        }
+    }
+}
diff --git a/src/NexusMods.StandardGameLocators/NexusMods.StandardGameLocators.csproj b/src/NexusMods.StandardGameLocators/NexusMods.StandardGameLocators.csproj
@@ -4,6 +4,7 @@
 
     <ItemGroup>
         <PackageReference Include="GameFinder" />
+        <PackageReference Include="GameFinder.Launcher.Heroic" />
         <PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" />
         <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" />
     </ItemGroup>

diff --git a/src/NexusMods.StandardGameLocators/Services.cs b/src/NexusMods.StandardGameLocators/Services.cs
@@ -1,5 +1,6 @@
 using System.Text.Json.Serialization;
 using GameFinder.Common;
+using GameFinder.Launcher.Heroic;
 using GameFinder.RegistryUtils;
 using GameFinder.StoreHandlers.EADesktop;
 using GameFinder.StoreHandlers.EADesktop.Crypto;
@@ -61,6 +62,7 @@ public static IServiceCollection AddStandardGameLocators(
             onLinux: () =>
             {
                 services.AddSingleton<IGameLocator, SteamLocator>();
+                services.AddSingleton<IGameLocator, HeroicGogLocator>();
 
                 services.AddSingleton<IGameLocator, DefaultWineGameLocator>();
                 services.AddSingleton<IGameLocator, BottlesWineGameLocator>();
@@ -92,6 +94,7 @@ public static IServiceCollection AddStandardGameLocators(
             onLinux: () =>
             {
                 services.AddSingleton<AHandler<SteamGame, AppId>>(provider => new SteamHandler(provider.GetRequiredService<IFileSystem>(), registry: null));
+                services.AddSingleton<HeroicGOGHandler>(provider => new HeroicGOGHandler(provider.GetRequiredService<IFileSystem>()));
 
                 services.AddSingleton<IWinePrefixManager<WinePrefix>>(provider => new DefaultWinePrefixManager(provider.GetRequiredService<IFileSystem>()));
                 services.AddSingleton<IWinePrefixManager<BottlesWinePrefix>>(provider => new BottlesWinePrefixManager(provider.GetRequiredService<IFileSystem>()));

diff --git a/tests/NexusMods.StandardGameLocators.TestHelpers/Services.cs b/tests/NexusMods.StandardGameLocators.TestHelpers/Services.cs
@@ -1,4 +1,5 @@
 using GameFinder.Common;
+using GameFinder.Launcher.Heroic;
 using GameFinder.StoreHandlers.EADesktop;
 using GameFinder.StoreHandlers.EGS;
 using GameFinder.StoreHandlers.GOG;
@@ -75,6 +76,8 @@ public static IServiceCollection AddStubbedGameLocators(this IServiceCollection
 
         if (OSInformation.Shared.IsLinux)
         {
+            coll.AddSingleton<HeroicGOGHandler>(s => new HeroicGOGHandler(s.GetRequiredService<IFileSystem>()));
+
             coll.AddSingleton<IWinePrefixManager<WinePrefix>>(s =>
                 new StubbedWinePrefixManager<WinePrefix>(s.GetRequiredService<TemporaryFileManager>(),
                     tfm => new WinePrefix