{"id":13440940,"url":"https://github.com/Matoking/protontricks","last_synced_at":"2025-03-20T10:33:07.580Z","repository":{"id":40586345,"uuid":"146435241","full_name":"Matoking/protontricks","owner":"Matoking","description":"A wrapper that does winetricks things for Proton enabled games, requires Winetricks.","archived":false,"fork":false,"pushed_at":"2025-03-17T17:33:16.000Z","size":752,"stargazers_count":1785,"open_issues_count":72,"forks_count":37,"subscribers_count":21,"default_branch":"master","last_synced_at":"2025-03-19T10:15:15.496Z","etag":null,"topics":["hacktoberfest","proton","python3","winetricks"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Matoking.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-08-28T11:06:06.000Z","updated_at":"2025-03-19T03:28:55.000Z","dependencies_parsed_at":"2023-02-13T01:16:20.642Z","dependency_job_id":"79fc4ab2-e97d-4dce-a40b-4934d81150db","html_url":"https://github.com/Matoking/protontricks","commit_stats":{"total_commits":360,"total_committers":26,"mean_commits":"13.846153846153847","dds":0.4083333333333333,"last_synced_commit":"c62758c89531304e102e7dd04f2246392378a500"},"previous_names":[],"tags_count":38,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Matoking%2Fprotontricks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Matoking%2Fprotontricks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Matoking%2Fprotontricks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Matoking%2Fprotontricks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Matoking","download_url":"https://codeload.github.com/Matoking/protontricks/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244422590,"owners_count":20450239,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest","proton","python3","winetricks"],"created_at":"2024-07-31T03:01:28.128Z","updated_at":"2025-03-20T10:33:07.571Z","avatar_url":"https://github.com/Matoking.png","language":"Python","readme":"Protontricks\n============\n\n[![image](https://img.shields.io/pypi/v/protontricks.svg)](https://pypi.org/project/protontricks/)\n[![Coverage Status](https://coveralls.io/repos/github/Matoking/protontricks/badge.svg?branch=master)](https://coveralls.io/github/Matoking/protontricks?branch=master)\n[![Test Status](https://github.com/Matoking/protontricks/actions/workflows/tests.yml/badge.svg)](https://github.com/Matoking/protontricks/actions/workflows/tests.yml)\n\n[\u003cimg width=\"240\" src=\"https://flathub.org/assets/badges/flathub-badge-en.png\"\u003e](https://flathub.org/apps/details/com.github.Matoking.protontricks)\n\nRun Winetricks commands for Steam Play/Proton games among other common Wine features, such as launching external Windows executables.\n\nThis is a fork of the original project created by sirmentio. The original repository is available at [Sirmentio/protontricks](https://github.com/Sirmentio/protontricks).\n\n# What is it?\n\nThis is a wrapper script that allows you to easily run Winetricks commands for Steam Play/Proton games among other common Wine features, such as launching external Windows executables. This is often useful when a game requires closed-source runtime libraries or applications that are not included with Proton.\n\n# Requirements\n\n* Python 3.7 or newer\n* Winetricks\n* Steam\n* YAD (recommended) **or** Zenity. Required for GUI.\n\n# Usage\n\n**Protontricks can be launched from desktop or using the `protontricks` command.**\n\n## Command-line\n\nThe basic command-line usage is as follows:\n\n```\n# Find your game's App ID by searching for it\nprotontricks -s \u003cGAME NAME\u003e\n\n# or by listing all games\nprotontricks -l\n\n# Run winetricks for the game.\n# Any parameters in \u003cACTIONS\u003e are passed directly to Winetricks.\n# Parameters specific to Protontricks need to be placed *before* \u003cAPPID\u003e.\nprotontricks \u003cAPPID\u003e \u003cACTIONS\u003e\n\n# Run a custom command for selected game\nprotontricks -c \u003cCOMMAND\u003e \u003cAPPID\u003e\n\n# Run the Protontricks GUI\nprotontricks --gui\n\n# Launch a Windows executable using Protontricks\nprotontricks-launch \u003cEXE\u003e\n\n# Launch a Windows executable for a specific Steam app using Protontricks\nprotontricks-launch --appid \u003cAPPID\u003e \u003cEXE\u003e\n\n# Print the Protontricks help message\nprotontricks --help\n```\n\nSince this is a wrapper, all commands that work for Winetricks will likely work for Protontricks as well.\n\nIf you have a different Steam directory, you can export ``$STEAM_DIR`` to the directory where Steam is.\n\nIf you'd like to use a local version of Winetricks, you can set ``$WINETRICKS`` to the location of your local winetricks installation.\n\nYou can also set ``$PROTON_VERSION`` to a specific Proton version manually. This is usually the name of the Proton installation without the revision version number. For example, if Steam displays the name as `Proton 5.0-3`, use `Proton 5.0` as the value for `$PROTON_VERSION`.\n\n[Wanna see Protontricks in action?](https://asciinema.org/a/229323)\n\n## Desktop\n\nProtontricks comes with desktop integration, adding the Protontricks app shortcut and the ability to launch external Windows executables for Proton apps. To run an executable for a Proton app, select **Protontricks Launcher** when opening a Windows executable (eg. **EXE**) in a file manager.\n\nThe **Protontricks** app shortcut should be available automatically after installation. If not, you may need to run `protontricks-desktop-install` in a terminal to enable this functionality.\n\n# Troubleshooting\n\nFor common issues and solutions, see [TROUBLESHOOTING.md](TROUBLESHOOTING.md).\n\n# Installation\n\nYou can install Protontricks using a community package, Flatpak or **pipx**. **pip** can also be used, but it is not recommended due to possible problems.\n\n**If you're using a Steam Deck**, Flatpak is the recommended option. Open the **Discover** application store in desktop mode and search for **Protontricks**. \n\n**If you're using the Flatpak version of Steam**, follow the [Flatpak-specific installation instructions](https://github.com/flathub/com.github.Matoking.protontricks) instead.\n\n## Community packages (recommended)\n\nCommunity packages allow easier installation and updates using distro-specific package managers. They also take care of installing dependencies and desktop features out of the box, making them **the recommended option if available for your distribution**.\n\nCommunity packages are maintained by community members and might be out-of-date compared to releases on PyPI.\nNote that some distros such as **Debian** / **Ubuntu** often have outdated packages for either Protontricks **or** Winetricks.\nIf so, install the Flatpak version instead as outdated releases may fail to work properly.\n\n[![Packaging status](https://repology.org/badge/vertical-allrepos/protontricks.svg)](https://repology.org/project/protontricks/versions)\n\n## Flatpak (recommended)\n\nProtontricks is available on the Flathub app store:\n\n[\u003cimg width=\"180\" src=\"https://flathub.org/assets/badges/flathub-badge-en.png\"\u003e](https://flathub.org/apps/details/com.github.Matoking.protontricks)\n\nTo use Protontricks as a command-line application, add shell aliases by running the following commands:\n\n```\necho \"alias protontricks='flatpak run com.github.Matoking.protontricks'\" \u003e\u003e ~/.bashrc\necho \"alias protontricks-launch='flatpak run --command=protontricks-launch com.github.Matoking.protontricks'\" \u003e\u003e ~/.bashrc\n```\n\nYou will need to restart your terminal emulator for the aliases to take effect.\n\nThe Flatpak installation is sandboxed and only has access to the Steam\ninstallation directory by default. **You will need to add filesystem permissions when\nusing additional Steam library locations or running external Windows\napplications.** See\n[here](https://github.com/flathub/com.github.Matoking.protontricks#configuration)\nfor instructions on changing the Flatpak permissions.\n\n## pipx\n\nYou can use pipx to install the latest version on PyPI or the git repository for the current user. Installing Protontricks using pipx is recommended if a community package doesn't exist for your Linux distro.\n\n**pipx does not install Winetricks and other dependencies out of the box.** You can install Winetricks using the [installation instructions](https://github.com/Winetricks/winetricks#installing) provided by the Winetricks project. \n\n**pipx requires Python 3.7 or newer.**\n\n**You will need to install pip, setuptools and virtualenv first.** Install the correct packages depending on your distribution:\n\n* Arch Linux: `sudo pacman -S python-pip python-pipx python-setuptools python-virtualenv`\n* Debian-based (Ubuntu, Linux Mint): `sudo apt install python3-pip python3-setuptools python3-venv pipx`\n* Fedora: `sudo dnf install python3-pip python3-setuptools python3-libs pipx`\n* Gentoo:\n\n  ```sh\n  sudo emerge -av dev-python/pip dev-python/virtualenv dev-python/setuptools\n  python3 -m pip install --user pipx\n  ~/.local/bin/pipx ensurepath\n  ```\n\nClose and reopen your terminal. After that, you can install Protontricks.\n\n```sh\npipx install protontricks\n```\n\nTo enable desktop integration as well, run the following command *after* installing Protontricks\n\n```sh\nprotontricks-desktop-install\n```\n\nTo upgrade to the latest release:\n```sh\npipx upgrade protontricks\n```\n\nTo install the latest development version (requires `git`):\n```sh\npipx install git+https://github.com/Matoking/protontricks.git\n# '--spec' is required for older versions of pipx\npipx install --spec git+https://github.com/Matoking/protontricks.git protontricks\n```\n\n## pip (not recommended)\n\nYou can use pip to install the latest version on PyPI or the git repository. This method should work in any system where Python 3 is available.\n\n**Note that this installation method might cause conflicts with your distro's package manager. To prevent this, consider using the pipx method or a community package instead.**\n\n**You will need to install pip and setuptools first.** Install the correct packages depending on your distribution:\n\n* Arch Linux: `sudo pacman -S python-pip python-setuptools`\n* Debian-based (Ubuntu, Linux Mint): `sudo apt install python3-pip python3-setuptools`\n* Fedora: `sudo dnf install python3-pip python3-setuptools`\n* Gentoo: `sudo emerge -av dev-python/pip dev-python/setuptools`\n\nTo install the latest release using `pip`:\n```sh\nsudo python3 -m pip install protontricks\n```\n\nTo upgrade to the latest release:\n```sh\nsudo python3 -m pip install --upgrade protontricks\n```\n\nTo install Protontricks only for the current user:\n```sh\npython3 -m pip install --user protontricks\n```\n\nTo install the latest development version (requires `git`):\n```sh\nsudo python3 -m pip install git+https://github.com/Matoking/protontricks.git\n```\n","funding_links":[],"categories":["HarmonyOS","Applications","Python","WINE","Software"],"sub_categories":["Windows Manager","Games","WINE implementations"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMatoking%2Fprotontricks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FMatoking%2Fprotontricks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMatoking%2Fprotontricks/lists"}