GameFinder.RegistryUtils 2.6.0

GameFinder

.NET library for finding games. The following launchers are supported:

• Steam
• GOG Galaxy
• Epic Games Store
• Origin
• EA Desktop

The following launchers are not yet supported or support has been dropped:

• Bethesda.net
• Xbox Game Pass

If you are interested in understanding how GameFinder finds these games, check the wiki for more information.

Additionally, the following Linux tools are supported:

• Wine

Supported Launchers

Steam

Steam is supported on Windows and Linux. Use SteamDB to find the ID of a game.

Usage:

// use the Windows registry on Windows
// Linux doesn't have a registry
var handler = RuntimeInformation.IsOSPlatform(OSPlatform.Windows)
    ? new SteamHandler(new WindowsRegistry())
    : new SteamHandler(registry: null);

// method 1: iterate over the game-error result
foreach (var (game, error) in handler.FindAllGames())
{
    if (game is not null)
    {
        Console.WriteLine($"Found {game}");
    }
    else
    {
        Console.WriteLine($"Error: {error}");
    }
}

// method 2: use the dictionary if you need to find games by id
Dictionary<SteamGame, int> games = handler.FindAllGamesById(out string[] errors);

// method 3: find a single game by id
SteamGame? game = handler.FindOneGameById(570940, out string[] errors);

GOG Galaxy

GOG Galaxy is only supported on Windows. Use the GOG Database to find the ID of a game.

Usage:

var handler = new GOGHandler();

// method 1: iterate over the game-error result
foreach (var (game, error) in handler.FindAllGames())
{
    if (game is not null)
    {
        Console.WriteLine($"Found {game}");
    }
    else
    {
        Console.WriteLine($"Error: {error}");
    }
}

// method 2: use the dictionary if you need to find games by id
Dictionary<GOGGame, long> games = handler.FindAllGamesById(out string[] errors);

// method 3: find a single game by id
GOGGame? game = handler.FindOneGameById(1971477531, out string[] errors);

Epic Games Store

Epic Games Store is only supported on Windows.

Usage:

var handler = new EGSHandler();

// method 1: iterate over the game-error result
foreach (var (game, error) in handler.FindAllGames())
{
    if (game is not null)
    {
        Console.WriteLine($"Found {game}");
    }
    else
    {
        Console.WriteLine($"Error: {error}");
    }
}

// method 2: use the dictionary if you need to find games by id
Dictionary<EGSGame, string> games = handler.FindAllGamesById(out string[] errors);

// method 3: find a single game by id
EGSGame? game = handler.FindOneGameById("3257e06c28764231acd93049f3774ed6", out string[] errors);

Origin

Origin is only supported on Windows. Note: EA is deprecating Origin and will replace it with EA Desktop.

Usage:

var handler = new OriginHandler();

// method 1: iterate over the game-error result
foreach (var (game, error) in handler.FindAllGames())
{
    if (game is not null)
    {
        Console.WriteLine($"Found {game}");
    }
    else
    {
        Console.WriteLine($"Error: {error}");
    }
}

// method 2: use the dictionary if you need to find games by id
Dictionary<OriginGame, string> games = handler.FindAllGamesById(out string[] errors);

// method 3: find a single game by id
OriginGame? game = handler.FindOneGameById("Origin.OFR.50.0001456", out string[] errors);

EA Desktop

EA Desktop is the replacement for Origin: See EA is deprecating Origin. This is by far, the most complicated Store Handler. You should read the wiki entry. My implementation decrypts the encrypted file, created by EA Desktop. You should be aware that the key used to encrypt the file is derived from hardware information. If the user changes their hardware, the decryption process might fail because they key has changed.

Usage:

var handler = new EADesktopHandler();

// method 1: iterate over the game-error result
foreach (var (game, error) in handler.FindAllGames())
{
    if (game is not null)
    {
        Console.WriteLine($"Found {game}");
    }
    else
    {
        Console.WriteLine($"Error: {error}");
    }
}

// method 2: use the dictionary if you need to find games by id
Dictionary<EADesktopGame, string> games = handler.FindAllGamesById(out string[] errors);

// method 3: find a single game by id
EADesktopGame? game = handler.FindOneGameById("Origin.SFT.50.0000532", out string[] errors);

Bethesda.net

As of May 11, 2022, the Bethesda.net launcher is no longer in use. The package GameFinder.StoreHandlers.BethNet has been deprecated and marked as legacy.

Xbox Game Pass

The package GameFinder.StoreHandlers.Xbox has been deprecated and marked as legacy. I no longer maintain this package because it never got used. I initially made GameFinder for Wabbajack and other modding tools however, you can't mod games installed with the Xbox App on Windows. These games are installed as UWP apps, which makes them protected and hard to modify. Another issue is the fact that you can't distinguish between normal UWP apps and Xbox games, meaning your calculator will show up as an Xbox game.

The final issue is related to actual code: in order to find all UWP apps I used the Windows SDK, which was a pain to integrate. The CI had to be on Windows, the .NET target framework had to be a Windows specific version (net6.0-windows-XXXXXXXXXX), and it was overall not nice to use.

The package is still available on NuGet and should still work, but it's marked as deprecated and won't receive any updates.

Linux tools

Wine

GameFinder.Wine implements a IWinePrefixManager for finding Wineprefixes.

Usage:

var prefixManager = new DefaultWinePrefixManager(new FileSystem());

foreach (var result in prefixManager.FindPrefixes())
{
    result.Switch(prefix =>
    {
        Console.WriteLine($"Found wine prefix at {prefix.ConfigurationDirectory}");
    }, error =>
    {
        Console.WriteLine(error.Value);
    });
}

Bottles

GameFinder.Wine implements a IWinePrefixManager for finding Wine prefixes managed by Bottles.

Usage:

var prefixManager = new BottlesWinePrefixManager(new FileSystem());

foreach (var result in prefixManager.FindPrefixes())
{
    result.Switch(prefix =>
    {
        Console.WriteLine($"Found wine prefix at {prefix.ConfigurationDirectory}");
    }, error =>
    {
        Console.WriteLine(error.Value);
    });
}

Proton

Valve's Proton is a compatibility tool for Steam and is mostly based on Wine. The Wine prefixes managed by Proton are in the compatdata directory of the steam library where the game itself is installed. Since the path is relative to the game itself and requires the app id, I've decided to put this functionality in GameFinder.StoreHandlers.Steam:

SteamGame? steamGame = steamHandler.FindOneGameById(1237970, out var errors);
ProtonWinePrefix? protonPrefix = steamGame?.GetProtonPrefix();
var protonPrefixDirectory = protonPrefix?.ProtonDirectory;

if (protonDirectory is not null && Directory.Exists(protonDirectory))
{
    Console.WriteLine($"Proton prefix is at {protonDirectory}");
}

Contributing

See CONTRIBUTING for more information.

License

See LICENSE for more information.