diff --git a/README.md b/README.md index e0a80d6..cca289b 100644 --- a/README.md +++ b/README.md @@ -6,44 +6,50 @@ Use system-wide Wine, DXVK & D9VK for Steam Play/Proton (Windows) games, directl - [files_wine](files_wine) = Necessary source code patches for Wine to make it Steam-compatible -- [files_archlinux](files_archlinux) = Necessary packages & installation scripts for system-wide, Steam-compatible Wine + DXVK + D9VK installation. NOTE: Wine files are provided in [files_wine](files_wine). +- [files_archlinux](files_archlinux) = Necessary packages & installation scripts for system-wide, Steam-compatible Wine + DXVK + D9VK. **NOTE:** Wine files are provided in [files_wine](files_wine). - [files_proton](files_proton) = Modified Python 3 launch script for Steam Play. The script is modified to use system-wide Wine + DXVK + D9VK + OpenVR libraries & executables instead of Steam-provided, bundled ones. ## Usage -**1)** Install Steam Client unless you haven't done so yet. +----- -**2)** On Steam Client, install `Proton 4.2` (or any version above): `Steam Client -> LIBRARY -> Tools -> Proton 4.2 -> Install Game...` (skip this step if done already) +**1)** Install Steam Client. + +**2)** On Steam Client, install `Proton 4.2`: `Steam Client -> LIBRARY -> Tools -> Proton 4.2 -> Install Game...` + +----- **3)** Compile & install Wine using patch files in [files_wine](files_wine). See [files_wine/README](files_wine/README.md) for additional information. **4)** Compile & install all packages in [files_archlinux](files_archlinux). If provided, see `README.md` file of each package for additional information. +----- + **5.A)** Apply modified [files_proton](files_proton/proton) Steam Play launch script. Put this file into `$HOME/.local/share/Steam/steamapps/common/Proton /` where `` is `4.2` or higher (depending on your configuration). **5.B)** Select this specific Proton version in Steam client configuration menu (`Steam Client -> Settings -> Steam Play`). _This means system-wide Wine, DXVK & D9VK are used for your Steam Play games._ **Only selected version works** -Wine using patch files in [files_wine](files_wine). See [files_wine/README](files_wine/README.md) for additional information. - ## Recommendations & Notes -- **Backup _proton_ script**. It is known that Steam client likes to apply automatic patches. Have a backup of your _proton_ script file in case the client decides to overwrite it. +- **Backup your _proton_ script**. It is known that Steam client likes to apply automatic patches. Have a backup of your _proton_ script file in case the client decides to overwrite it. + +- **Games may not work**. Games which work on Steam-bundled Proton may not work on this modified Wine/DXVK/D9VK configuration. In this case, either **A)** choose different Proton version for non-working game titles or **B)** revert _proton_ script changes. -- **Games may not work**. Games which work on Steam-bundled Proton may not work on this modified Wine/DXVK/D9VK configuration. In this case, either A) choose different Proton version for non-working game titles or B) revert _proton_ script changes. Original _proton_ script version `4.2` can be downloaded from [ValveSoftware/Proton - proton](https://github.com/ValveSoftware/Proton/blob/proton_4.2/proton). This script file restores original Steam Proton original functionality for the selected Proton version. +Original _proton_ script version `4.2` can be downloaded from [ValveSoftware/Proton - proton](https://github.com/ValveSoftware/Proton/blob/proton_4.2/proton). This script file restores original Steam Proton original functionality for the selected Proton version. ## LICENSE -This repository uses various licenses. +Parts of this repository use various licenses: - [License (files_wine): ValveSoftware/Wine](https://github.com/ValveSoftware/wine/blob/proton_4.2/LICENSE) -- License (files_proton): +- License ([files_proton](files_proton)): - [ValveSoftware/Proton/LICENSE](https://github.com/ValveSoftware/Proton/blob/proton_4.2/LICENSE) - [ValveSoftware/Proton/LICENSE.proton](https://github.com/ValveSoftware/Proton/blob/proton_4.2/LICENSE.proton) -- License (files_archlinux): +- License ([files_archlinux](files_archlinux)): - Subdirectories here provide only `PKGBUILD` compilation scripts for various packages. Licenses for these packages are listed in their respective `PKGBUILD` files. diff --git a/files_archlinux/README.md b/files_archlinux/README.md new file mode 100644 index 0000000..2980180 --- /dev/null +++ b/files_archlinux/README.md @@ -0,0 +1,21 @@ +# Arch Linux packages for system-wide Steam-compatible Wine/DXVK/D9VK + +This folder contains necessary packages for Steam-compatible Wine/DXVK/D9VK. **NOTE:** Required Wine files are located at [files_wine](../files_wine). + +## Contents + +- **[d9vk-git](d9vk-git):** D9VK build files + +- **[dxvk-git](dxvk-git):** DXVK build files + +- **[lib32-steamlibs](lib32-steamlibs):** Build files of proprietary Steam libraries for Wine (library files are not provided due to legal reasons) + +- **[openvr-git](openvr-git):** OpenVR build files. See updated version [here](https://aur.archlinux.org/packages/openvr-git/) + +- **[openvr-proton](openvr-proton):** Build files of OpenVR dll libraries (library files are not provided) + +- **[proton-git](proton-git):** Proton build files. See updated version [here](https://aur.archlinux.org/packages/proton-git/) + +- **[steam](steam):** Steam client build files. See updated version [here](https://www.archlinux.org/packages/multilib/x86_64/steam/) + +Some subdirectories include `README.md` file for additional instructions/information. diff --git a/files_proton/README.md b/files_proton/README.md new file mode 100644 index 0000000..b745f74 --- /dev/null +++ b/files_proton/README.md @@ -0,0 +1,15 @@ +# Steam Proton script (modified) + +This folder contains modified Python 3 _[proton](proton)_ script for Linux Steam client. It is mandatory for system-wide Wine/DXVK/D9VK to work on Steam client. + +Steam client executes this script when a Steam Play compatible Windows game is launched. It hooks necessary Wine, OpenVR, DXVK (& D9VK) files for the selected game to use. + +Feel free to customize the script in the limits of [LICENSE](https://github.com/ValveSoftware/Proton/blob/proton_4.2/LICENSE) + +## How to install? + +See [instructions](../README.md#usage) + +## LICENSE + +Please see license information of [ValveSoftware/Proton/LICENSE](https://github.com/ValveSoftware/Proton/blob/proton_4.2/LICENSE) & [ValveSoftware/Proton/LICENSE.proton](https://github.com/ValveSoftware/Proton/blob/proton_4.2/LICENSE.proton) diff --git a/files_wine/README.md b/files_wine/README.md index 674d412..e168a89 100644 --- a/files_wine/README.md +++ b/files_wine/README.md @@ -25,4 +25,4 @@ On Arch Linux, you can use helper scripts such as [Fincer/dxvk-wine-autobuilder] ## LICENSE -Please see license [here (ValveSoftware/Wine - Proton 4.2)](https://github.com/ValveSoftware/wine/blob/proton_4.2/LICENSE) +Please see license information of [ValveSoftware/Wine/LICENSE](https://github.com/ValveSoftware/wine/blob/proton_4.2/LICENSE)