diff --git a/docs/Installation.md b/docs/Installation.md new file mode 100644 index 00000000..b47f8edf --- /dev/null +++ b/docs/Installation.md @@ -0,0 +1,43 @@ +## Installation + +### Optional Requirements +**Winetricks** + +If you want to be able to use fixes with winetricks it must be installed and be in your $PATH. Fixes that do not use winetricks will still work without winetricks being installed. + +*Winetricks can take a long time to run* + +**Wine** + +If you want to use a win32 (32bit) prefix, you need to have wine installed and be in your $PATH. Currently creating a 32bit prefix with Proton wine doesn't work because the wineserver is already running by the time `user_settings.py` is loaded. + +**Progress Dialog / Splashscreen** + +If Steam is in big picture mode, protontricks will try to launch a similarly themed splash dialog using `cefpython` (pictured above). Otherwise it will try to use `zenity` to display a progress bar. If Steam is not in big picture mode, it will default to `zenity`. The progress bar or splashscreen can help let you know that protonfixes is running a long task, for example installing `dotnet35`. + +For the progress dialog to work, you need to have `zenity` installed on your system, the steam-runtime version is broken. It can probably be installed using your distro's package manager. + +For the big screen splashscreen to work, you need to have `cefpython3` installed. It can be installed with pip using `sudo pip install cefpython3`. + +### Install from PIP +Make sure to use the version of pip that matches the version of Python that Proton is running. Proton should be running on [python3](https://github.com/ValveSoftware/Proton/blob/8a5b8ece45fa7baa01ce2e4555f6496ea409adcf/build_proton.sh#L682). If you are unsure, try installing with both pip3 and pip2 in the below commands. +``` +# sudo pip3 install protonfixes +``` + +### Upgrade from PIP +``` +# sudo pip3 install protonfixes --upgrade +``` + +### Install using setuptools +``` +# sudo python3 setup.py install +``` + +### Add to user_settings.py +In the steamapps/common/Proton* directory, add the following line to the bottom of the `user_settings.py` file: +``` +import protonfixes +``` +If there is no `user_settings.py` file, make a copy of the `user_settings.sample.py` file included with Proton. \ No newline at end of file