From 7acfbdb52fe392f472c9297e0d62458b8e6ec331 Mon Sep 17 00:00:00 2001 From: Janne Pulkkinen Date: Fri, 1 Jan 2021 17:33:14 +0200 Subject: [PATCH] Add TROUBLESHOOTING.md --- README.md | 6 ++++++ TROUBLESHOOTING.md | 19 +++++++++++++++++++ 2 files changed, 25 insertions(+) create mode 100644 TROUBLESHOOTING.md diff --git a/README.md b/README.md index f86d581..f6aecbd 100644 --- a/README.md +++ b/README.md @@ -50,12 +50,18 @@ You can also set ``$PROTON_VERSION`` to a specific Proton version manually. This [Wanna see Protontricks in action?](https://asciinema.org/a/229323) +# Troubleshooting + +For common issues and solutions, see [TROUBLESHOOTING.md](TROUBLESHOOTING.md). + # Installation You can install Protontricks using an unofficial package or **pipx**. **pip** can also be used, but it is not recommended due to possible problems. **If you're using the Flatpak version of Steam**, follow the [Flatpak-specific installation instructions](https://github.com/flathub/com.valvesoftware.Steam.Utility.protontricks) instead. +Unless you're using unofficial packages, you may need to install Winetricks separately. See the [installation instructions](https://github.com/Winetricks/winetricks) for further details. + ## Unofficial packages (recommended) Unofficial packages allow easier installation and updates using distro-specific package managers. Unofficial packages are maintained by community members and might be out-of-date compared to releases on PyPI. diff --git a/TROUBLESHOOTING.md b/TROUBLESHOOTING.md new file mode 100644 index 0000000..cd6b828 --- /dev/null +++ b/TROUBLESHOOTING.md @@ -0,0 +1,19 @@ +Troubleshooting +=============== + +You can [create an issue](https://github.com/Matoking/protontricks/issues/new/choose) on GitHub. Before doing so, please check if your issue is related to any of the following known issues. + +# Common issues and solutions + +## "warning: You are using a 64-bit WINEPREFIX" + +> Whenever I run a Winetricks command, I see the warning `warning: You are using a 64-bit WINEPREFIX. Note that many verbs only install 32-bit versions of packages. If you encounter problems, please retest in a clean 32-bit WINEPREFIX before reporting a bug.`. +> Is this a problem? + +Proton uses 64-bit Wine prefixes, which means you will see this warning with every game. You can safely ignore the message if the command otherwise works. + +## "Unknown arg foobar" + +> When I'm trying to run a Protontricks command such as `protontricks foobar`, I get the error `Unknown arg foobar`. + +Your Winetricks installation might be outdated, which means your Winetricks installation doesn't support the verb you are trying to use (`foobar` in this example). Some distros such as Debian might ship very outdated versions of Winetricks. To ensure you have the latest version of Winetricks, (see the installation instructions)[https://github.com/Winetricks/winetricks#installing] on the Winetricks repository.