-
-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: improve info about linux native build of the sdk (#51)
* docs: improve info about linux native build of the sdk * docs: avoid language-specific gog.com links * docs: remove inaccurate information
- Loading branch information
Showing
4 changed files
with
33 additions
and
36 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,63 +1,60 @@ | ||
| > [!IMPORTANT] | ||
| > This is **not** an official page affiliated with GOG. These are my findings while I was looking into SDK client libraries that GOG provides. | ||
| > While the libraries disclosed below have proven to work in production there **no one guarantees** that. | ||
| > Nevertheless I encourage you to at least try linking your game against and see the results | ||
| > This is **not** an official page affiliated with GOG. These are my findings while I was looking into the SDK client libraries that GOG provides. | ||
| > While the libraries disclosed below have been proven to work in production, **there is no guarantee.** | ||
| > Nevertheless I encourage you to at least try linking your game against them and see the results. | ||
| ## You made it here! | ||
|
|
||
| If you are seeing this page then you are probably considering shipping a Linux native build of your game on GOG. | ||
| Excelent choice! If you've researched the topic of GOG Galaxy SDK then you probably know that GOG claims such thing is not supported on Linux. | ||
| If you're seeing this page, then you're probably considering shipping a native Linux build of your game on GOG. | ||
| Excellent choice! If you've researched the GOG GALAXY SDK then you've probably discovered that it appears to not be available for Linux. | ||
|
|
||
| **But, don't leave yet** while this is what GOG claims, it's not necessairly true (I guess they don't want to commit to supporting Linux fully). | ||
| It was proven to work by games like | ||
| **But don't leave yet!** It is still possible to use the GOG GALAXY SDK on your Linux build to enable achievements and other online features, and it may even save you some general effort in the process. | ||
| This has already been proven to work by several games, including: | ||
|
|
||
| - Stardew Valley | ||
| - Indivisible | ||
| - Streets of Rage 4 | ||
| - Crypt of the NecroDancer | ||
| - [Crypt of the NecroDancer](https://www.gog.com/game/crypt_of_the_necrodancer) | ||
| - [Indivisible](https://www.gog.com/game/indivisible) | ||
| - [Stardew Valley](https://www.gog.com/game/stardew_valley) | ||
| - [Streets of Rage 4](https://www.gog.com/game/streets_of_rage_4) | ||
|
|
||
| ## How to get native library | ||
| ## How to get the native Linux library | ||
|
|
||
| In the developer portal in `Galaxy Components` > `SDK` you'll see the section with downloads | ||
| In the Developer Portal in `Galaxy Components` > `SDK`, you'll see the following download section: | ||
|
|
||
|  | ||
|
|
||
| The `Steam-runtime` is what you are looking for. Pick an appropriate bitness and link your app against that. | ||
| This build is up-to date like the rest of SDK packages. | ||
| This build is up-to date like the rest of the SDK packages. | ||
|
|
||
| > [!NOTE] | ||
| > There is no GalaxyPeer library for Linux, it seems to be statically linked within the provided libGalaxy.so library. | ||
| > There is no GalaxyPeer library for Linux. Instead, it seems to be statically linked within the provided libGalaxy.so library. | ||
| ## Why bother? | ||
|
|
||
| Going out of your way to use the library that GOG is too shy (⁄ ⁄>⁄ ▽ ⁄<⁄ ⁄) to talk about may feel weird but there are advantages. | ||
|
|
||
| 1. DLC Discovery https://docs.gog.com/sdk-dlc-discovery | ||
| - GOG encourages you to build your own solution for DLC Discovery on Linux, because normally this is something that SDK client handles | ||
| Going out of your way to use the library that GOG is curiously neglecting to mention may feel weird, but there are significant advantages. | ||
|
|
||
| 2. Multiplayer | ||
| - Having SDK client library is required to be able to provide multiplayer functionality and user identity features. (this still has to be optional - remember about the [DRM free nature](https://docs.gog.com/sdk/#drm-and-sdk) of GOG) | ||
| 1. DLC Discovery via GOG GALAXY SDK: https://docs.gog.com/sdk-dlc-discovery | ||
| - GOG normally encourages you to build your own solution for DLC Discovery on your Linux build, but now you can continue using the dedicated GOG GALAXY SDK method, just as you would on your Windows build. | ||
|
|
||
| 3. Less work (potentially) | ||
| - It can be tedious to support multiple store fronts especially when one of them requires you to do platform specific workarounds because they fail to stay consitent with provided feature set. | ||
| 2. Potentially less work in general | ||
| - To ease the burden in supporting multiple storefronts, this library may generally reduce the amount of platform-specific workarounds needed to offset the inconsistent feature sets between platforms on GOG. | ||
|
|
||
| 3. Multiplayer, Leaderboards & more on Linux | ||
| - Just like your other builds, your Linux build can now provide multiplayer functionality and player authentication features. While the GOG GALAXY client is not available for Linux, players can use an equivalent client such as `comet` to pick up your game's API calls.\ | ||
| *(Remember to keep these online features optional in order for your game to remain DRM-free - see the [DRM and SDK](https://docs.gog.com/sdk/#drm-and-sdk) section of the GOG Dev Docs for more information.)* | ||
|
|
||
| ## What this comet repo has to do with all this? | ||
| ## So what is `comet`? | ||
|
|
||
| Comet is a drop-in replacement that allows players to leverage "GOG Galaxy-only" functionality (multiplayer, achievements, stats and leaderboards) on every platform. | ||
| Comet is a drop-in replacement for the GOG GALAXY client that allows players to leverage "GOG GALAXY-only" functionality (multiplayer, achievements, stats and leaderboards) on every platform that GOG games are available for. | ||
|
|
||
| The main goal is to bring this feature set to Linux users and let them use the platform to the fullest. | ||
|
|
||
| The project already ships to thousands of users through [Heroic Games Launcher](https://heroicgameslauncher.com/) and soon more Linux clients will follow. | ||
| The main goal of this project is to bring the GOG GALAXY feature set to Linux users and let them use the platform to the fullest. | ||
|
|
||
| Comet has already shipped to thousands of users through the [Heroic Games Launcher](https://heroicgameslauncher.com/), with more Linux clients soon to follow. | ||
|
|
||
| ## Not convinced? | ||
|
|
||
| Depending on features your game provides not using this lib may be more troublesome than expected, you should evaluate this per your project scope. | ||
|
|
||
| However, even if you still don't want to do it, your decision is respected. After all Linux users who will want to access those online features can still use Proton to run Windows build of your game, so not everything is lost. | ||
| Depending on the features that your game provides, not using this library may be more troublesome than expected; you should evaluate this per your project scope. | ||
|
|
||
| Should you ultimately decide against including the `Steam-runtime` library, your choice will be respected. Linux users who wish to access your game's online features can still use Proton to run the Windows build of your game, so not everything is lost. | ||
|
|
||
| *Have a nice day!* | ||
| *from Comet developers* | ||
| *from the Comet developers* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters