Signed-off-by: Boris Yumankulov <boria138@altlinux.org>
📘 Эта документация также доступна на русском
An application for managing a game library and launching games on Linux. It brings games from different sources together in one place.
Installation (devel)
uv python install 3.11
uv sync
source .venv/bin/activate # For bash/zsh
# or
source .venv/bin/activate.fish # For fish
Launch the application using the portprotonqt command.
Installation (release)
Choose the appropriate package for your system or the AppImage.
Launch using the portprotonqt command or via the shortcut in your application menu.
Development
To automatically prepare the environment (install Python 3.11, dependencies, pre-commit hooks, and generate translations), run the following script:
./dev-scripts/prepare_env.sh
Then activate the virtual environment. The activation command for your shell will be displayed at the end of the script execution. Usually, it is:
source .venv/bin/activate # For bash/zsh
# or
source .venv/bin/activate.fish # For fish
pre-commit will automatically run on every commit. If you want to run it manually, use:
pre-commit run --all-files
Authors
- Boria138 - Lead Developer
- BlackSnaker - Author of the idea and initial implementation
- Mikhail Tergoev (Castro-Fidel) - Author of the original PortProton project
Contributors
We thank everyone who has contributed to the development of PortProtonQt, including those who participate through commits as well as those who help in other ways (testing, ideas, translations, documentation, etc.). A full list of participants can be found in the repository activity list. Additional participants are also listed in the CHANGELOG.md file. If you have contributed but are not listed, please contact the lead developers so we can acknowledge you!
Dependencies and Licenses
PortProtonQt uses code and dependencies from the following projects:
- Icoextract — icon extraction library, MIT license.
- HowLongToBeat Python API — library for interacting with HowLongToBeat, MIT license.
- Iso9660 Analyzer Tool (IAT) — library for converting mdf and nrg to iso, GPLv2 license.
- heroic-gogdl — GOG downloading module, GPLv3 license.
- Legendary — Epic Games launcher alternative, GPLv3 license.
- pyte — ANSI escape code parser, LGPLv3 license.
- gjs-osk — base for virtual keyboard layout data, GPLv3 license.
- omikuji — inspiration and source material for the procedural detail page backgrounds, GPLv3 license.
- Bottles — source of the compatibility analysis rules, GPL-3.0-only license.
PortProtonQt is licensed under the terms in LICENSE. See THIRD_PARTY_NOTICES for third-party licenses.
Warning
Be careful! If you are using a theme not from the official repository or a trusted source, make sure its
styles.pyfile does not contain malicious or unwanted code. Sincestyles.pyis a regular Python file, it can contain any instructions. Always check the contents of third-party themes before use.