Skip to content

Commit 6e483ed

Browse files
committed
Update README: GOG GALAXY 2.1, Python 3.13
1 parent 8a39496 commit 6e483ed

File tree

3 files changed

+17
-13
lines changed

3 files changed

+17
-13
lines changed

README.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
1-
# GOG Galaxy Integrations Python API
1+
# GOG GALAXY Integrations Python API
22

3-
This Python library allows developers to easily build community integrations for various gaming platforms with GOG Galaxy 2.0.
3+
This Python library allows developers to easily build community integrations for various gaming platforms with GOG GALAXY **2.1**.
44

55
- refer to our <a href='https://galaxy-integrations-python-api.readthedocs.io'>documentation</a>
66

7+
Note: For integrations targeting GOG GALAXY the **below 2.1.0 version**, please refer to [this version](https://github.com/gogcom/galaxy-integrations-python-api/tree/0.69).
8+
79
## Features
810

9-
Each integration in GOG Galaxy 2.0 comes as a separate Python script and is launched as a separate process that needs to communicate with the main instance of GOG Galaxy 2.0.
11+
Each integration in GOG GALAXY 2.1 comes as a separate Python script and is launched as a separate process that needs to communicate with the main instance of GOG GALAXY 2.1.
1012

1113
The provided features are:
1214

13-
- multistep authorization using a browser built into GOG Galaxy 2.0
14-
- support for GOG Galaxy 2.0 features:
15+
- multistep authorization using a browser built into GOG GALAXY 2.1
16+
- support for GOG GALAXY 2.1 features:
1517
- importing owned and detecting installed games
1618
- installing and launching games
1719
- importing achievements and game time
@@ -28,9 +30,11 @@ Each integration can implement only one platform. Each integration must declare
2830

2931
## Basic usage
3032

31-
Each integration should inherit from the :class:`~galaxy.api.plugin.Plugin` class. Supported methods like :meth:`~galaxy.api.plugin.Plugin.get_owned_games` should be overwritten - they are called from the GOG Galaxy client at the appropriate times.
32-
Each of those methods can raise exceptions inherited from the :exc:`~galaxy.api.jsonrpc.ApplicationError`.
33-
Communication between an integration and the client is also possible with the use of notifications, for example: :meth:`~galaxy.api.plugin.Plugin.update_local_game_status`.
33+
Each integration should inherit from the `galaxy.api.plugin.Plugin` class. Supported methods like `galaxy.api.plugin.Plugin.get_owned_games` should be overwritten - they are called from the GOG GALAXY client at the appropriate times.
34+
Each of those methods can raise exceptions inherited from the `galaxy.api.jsonrpc.ApplicationError`.
35+
Communication between an integration and the client is also possible with the use of notifications, for example: `galaxy.api.plugin.Plugin.update_local_game_status`.
36+
37+
The minimum implementation requires to override `galaxy.api.plugin.Plugin.authenticate` and `galaxy.api.plugin.Plugin.get_owned_games` methods.
3438

3539
```python
3640
import sys
@@ -73,7 +77,7 @@ if __name__ == "__main__":
7377
## Deployment
7478

7579
The client has a built-in Python 3.13 interpreter, so integrations are delivered as Python modules.
76-
In order to be found by GOG Galaxy 2.0 an integration folder should be placed in [lookup directory](#deploy-location). Beside all the Python files, the integration folder must contain [manifest.json](#deploy-manifest) and all third-party dependencies. See an [exemplary structure](#deploy-structure-example).
80+
In order to be found by GOG GALAXY 2.1 an integration folder should be placed in [lookup directory](#deploy-location). Beside all the Python files, the integration folder must contain [manifest.json](#deploy-manifest) and all third-party dependencies. See an [exemplary structure](#deploy-structure-example).
7781

7882
### Lookup directory
7983

@@ -88,7 +92,7 @@ In order to be found by GOG Galaxy 2.0 an integration folder should be placed in
8892
`~/Library/Application Support/GOG.com/Galaxy/plugins/installed`
8993

9094
### Logging
91-
<a href='https://docs.python.org/3.13/howto/logging.html'>Root logger</a> is already setup by GOG Galaxy to store rotated log files in:
95+
<a href='https://docs.python.org/3.13/howto/logging.html'>Root logger</a> is already setup by GOG GALAXY to store rotated log files in:
9296

9397
- Windows:
9498

@@ -149,4 +153,4 @@ installed
149153

150154
## Legal Notice
151155

152-
By integrating or attempting to integrate any applications or content with or into GOG Galaxy 2.0 you represent that such application or content is your original creation (other than any software made available by GOG) and/or that you have all necessary rights to grant such applicable rights to the relevant community integration to GOG and to GOG Galaxy 2.0 end users for the purpose of use of such community integration and that such community integration comply with any third party license and other requirements including compliance with applicable laws.
156+
By integrating or attempting to integrate any applications or content with or into GOG GALAXY 2.1 you represent that such application or content is your original creation (other than any software made available by GOG) and/or that you have all necessary rights to grant such applicable rights to the relevant community integration to GOG and to GOG GALAXY 2.1 end users for the purpose of use of such community integration and that such community integration comply with any third party license and other requirements including compliance with applicable laws.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ classifiers = [
2121
]
2222
dependencies = [
2323
"aiohttp>=3.12.15",
24-
"certifi>=2025.8.3",
24+
"certifi>=2026.1.4",
2525
"psutil>=5.6.6; sys_platform == 'darwin'"
2626
]
2727

requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22
# Copied from setup.py because of a pip bug
33
# see https://github.com/pypa/pip/issues/4780
44
aiohttp==3.12.15
5-
certifi==2025.8.3
5+
certifi==2026.1.4
66
psutil==5.6.6; sys_platform == 'darwin'
77
# End of copy from setup.py

0 commit comments

Comments
 (0)