Skip to content

Commit

Permalink
Add Flatpak as official installation method
Browse files Browse the repository at this point in the history
The Flatpak version is now compatible with non-Flatpak Steam
installations as well, so feature it more prominently in the README.
  • Loading branch information
Matoking committed Jan 9, 2022
1 parent 12df681 commit 7101c06
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ A clear and concise description of what you expected to happen.

**System (please complete the following information):**
- Distro: [e.g. Ubuntu 20.04, Arch Linux, ...]
- Protontricks installation method: [e.g. community package, Flatpak, pipx or pip]
- Protontricks version: run `protontricks --version` to print the version
- Steam version: check if you're running Steam beta; this can be checked in _Steam_ -> _Settings_ -> _Account_ -> _Beta participation_

Expand Down
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ Protontricks
[![Coverage Status](https://coveralls.io/repos/github/Matoking/protontricks/badge.svg?branch=master)](https://coveralls.io/github/Matoking/protontricks?branch=master)
[![Test Status](https://github.com/Matoking/protontricks/actions/workflows/tests.yml/badge.svg)](https://github.com/Matoking/protontricks/actions/workflows/tests.yml)

[<img width="240" src="https://flathub.org/assets/badges/flathub-badge-en.png">](https://flathub.org/apps/details/com.github.Matoking.protontricks)

A wrapper that runs Winetricks commands for Proton enabled games among other useful features, requires Winetricks.

This is a fork of the original project created by sirmentio. The original repository is available at [Sirmentio/protontricks](https://github.com/Sirmentio/protontricks).
Expand Down Expand Up @@ -90,7 +92,20 @@ Community packages are maintained by community members and might be out-of-date

If you maintain a community package for Protontricks, feel free to create a pull request adding an entry to this section!

## pipx (recommended)
## Flatpak (recommended)

Protontricks is available as a Flatpak on the Flathub app store:

[<img width="180" src="https://flathub.org/assets/badges/flathub-badge-en.png">](https://flathub.org/apps/details/com.github.Matoking.protontricks)

The Flatpak installation is sandboxed and only has access to the Steam
installation directory by default. **You will need to add filesystem permissions when
using additional Steam library locations or running external Windows
applications.** See
[here](https://github.com/flathub/com.github.Matoking.protontricks#configuration)
for instructions on changing the Flatpak permissions.

## pipx

You 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.

Expand Down

0 comments on commit 7101c06

Please sign in to comment.