Library Usage

This section documents protondl's library API interface.

protondl also provides a CLI wrapper for the library API. Please take a look at its implementation for reference usage of the library.

Install from GitHub

Run the following command to install the latest version of protondl from GitHub. This installs protondl without optional CLI dependencies (rich, typer).

pip install "protondl @ git+https://github.com/DavidoTek/protondl@main"

API sections

• Launcher API: Discover launchers, detect/delete installed tools.
• Manage Tools API: Install and update compatibility tools.
• Manage Games API: List installed games, set tool a game uses.
• External Services API: Interface AWACY and ProtonDB.