GloriousEggroll/proton-ge-custom

[!Caution] Myself (GloriousEggroll) and this project (GE-Proton) are not affiliated with any other websites related to GE-Proton. There is no existing website for GE-Proton other than this GitHub repository.

[!Important] If you have an issue that happens with my GE-Proton build, provided from this repository, that does not happen on Valve's Proton, please do not open a bug report on Valve's bug tracker.

Instead, open an issue on this repository's issue tracker: https://github.com/GloriousEggroll/proton-ge-custom/issues

or contact me on Discord about the issue: https://discord.gg/6y3BdzC

GE-Proton

[!Warning] Running non-Steam games with GE-Proton outside of Steam is only supported using umu:

Proton runs in a container, which uses a runtime environment and libraries specifically built for use within that container. Not running it as intended results in the container and therefore its runtime not being used, which severely breaks library compatibility. It causes Wine to attempt to search for libraries on your system instead of those it was built with or intended for use with Proton. It may work if enough libraries match, but it is not the expected environment and not supported due to library differences across Linux distributions.

If you want Proton functionality outside of Steam, umu-launcher is a command-line tool that was designed to be able to mimic Steam in running the entire containerized runtime environment it needs in order to run Proton exactly as Steam does without needing Steam. Any other method is not supported.

Heroic has also enabled umu by default when using GE-Proton.

Lutris has integrated umu as the default backend used when GE-Proton (Latest) is selected as a Wine runner either globally or for any specific game.

[!Note] (1) Please note, this is a custom build of Proton, and is not affiliated with Valve's Proton.

(2) Please also note I will not assist with unofficial builds of GE-Proton. The only version of GE-Proton that I provide and will assist with builds of is the one provided within this repository, using the build system documented here.

(3) I cannot validate the accuracy or functionality of other builds that have not been built using the build system included here.

Table of contents

• Overview
  • Notes
• Installation
  • Native
  • Flatpak
    • Flathub
    • Manual
• Building
• Enabling
• Options
• Credits
  • TKG (Etienne Juvigny)
  • Guy1524 (Derek Lesho)
  • Joshie (Joshua Ashton)
  • doitsujin/ドイツ人 (Philip Rebohle)
  • HansKristian/themaister (Hans-Kristian Arntzen)
  • flibitijibibo (Ethan Lee)
  • simmons-public (Chris Simmons)
  • wine-staging maintainers
  • Reporters
  • Patrons
• Donations
• Tested Games

Overview

This is my build of Proton with the most recent bleeding-edge Proton Experimental Wine.

Things it contains that Valve's Proton currently does not:

• Additional media foundation patches for better video playback support
• AMD FSR patches added directly to fullscreen hack that can be toggled with WINE_FULLSCREEN_FSR=1
• FSR fake resolution patch details here
• NVIDIA CUDA support for PhysX and NVAPI
• Raw input mouse support
• 'protonfixes' system -- this is an automated system that applies per-game fixes (such as winetricks changes, environment variables, Easy Anti-Cheat workarounds, overrides, etc)
• Various upstream Wine patches backported
• Various wine-staging patches applied as they become needed
• NTSync enablement if the kernel supports it.

Notes

• Warframe is problematic with VSync. Turn it off or on in game, do not set to Auto
• Warframe should have a frame limit set in the game. An unlimited framerate may cause slowdowns
• Warframe on NVIDIA: you may need to disable GPU particles in game otherwise the game can freeze randomly. On AMD they should work fine.

Full patches can be viewed in protonprep-valve-staging.sh.

Installation

You must have the proper Vulkan drivers and packages installed on your system. VKD3D on AMD requires Mesa 22.0.0 or higher for the VK_KHR_dynamic_rendering extension. Check here for general driver installation guidance.

Manual

Via asdf, the version manager

There is an unofficial plugin for installing and managing GE-Proton versions with asdf (the universal version manager), it follows the same process as the manual installation but makes it a lot easier. Managing versions by removing and updating to newer versions also becomes easier.

To install by it first install asdf, and then proceed to add the 'asdf-protonge' plugin and install the version you want.

asdf plugin add protonge

# Or install a version from a tag
asdf install protonge latest

It's also possible to use the asdf plugin in Flatpak installations, by customizing the target compatibilitytools.d path. For more settings check the plugin's official documentation.

Via ProtonPlus, a proton version manager

ProtonPlus is a GUI Frontend for managing proton versions, including GE-Proton. It is a great tool for those who want a more user-friendly way to manage their proton versions.

To install Proton-GE, Select the Proton-GE dropdown, and select the version you want to install, or Proton-GE Latest to install the latest version and automatically update it when new versions are released.

After every install you need to restart Steam, and enable proton-ge-custom.

Native

This section is for those that use the native version of Steam.

1. Download a release from the Releases page.
2. Create a ~/.steam/steam/compatibilitytools.d directory if it does not exist.
3. Extract the release tarball into ~/.steam/steam/compatibilitytools.d/.
   • tar -xf GE-Proton*.tar.gz -C ~/.steam/steam/compatibilitytools.d/.
4. Restart Steam.
5. Enable proton-ge-custom in Steam.

Get the latest GE-Proton release through your terminal. It is assumed that you have coreutils and curl installed:

# Make a temporary working directory
echo "Making sure temporary directory exists..."
mkdir -p /tmp/proton-ge-custom
cd /tmp/proton-ge-custom

steam_dir=~/.steam/steam

# Verify Steam data directory exists
if [[ ! -d "$steam_dir" ]]; then
    echo "Error: Steam (native) data directory not found." >&2
    echo "Please launch Steam at least once to populate it." >&2
    exit 1
fi

# Make a Steam compatibility tools folder if it does not exist
mkdir -p "$steam_dir/compatibilitytools.d"

# Fetch release info
echo "Fetching release info..."
release_json=$(curl -s --max-time 10 \
    https://api.github.com/repos/GloriousEggroll/proton-ge-custom/releases/latest)

if [[ -z "$release_json" || "$release_json" != *'"tag_name"'* ]]; then
    echo "Error: Failed to fetch release info from GitHub." >&2
    exit 1
fi

# Resolve release URL for current architecture
echo "Fetching release for your arch..."

case "$(uname -m)" in
    aarch64|arm64) tarball_pattern='\-aarch64\.tar\.gz$' ;;
    x86_64)        tarball_pattern='GE-Proton[0-9]+-[0-9]+\.tar\.gz$' ;;
    *)
        echo "Error: Unsupported architecture: $(uname -m)." >&2
        echo "GE-Proton is only available for x86_64 and aarch64." >&2
        exit 1
        ;;
esac

tarball_url=$(echo "$release_json" |
    grep browser_download_url |
    cut -d\" -f4 |
    grep -E "$tarball_pattern" |
    head -n1 || true)

tarball_name=$(basename "$tarball_url")
release_name=${tarball_name%.tar.gz}

if [[ -z "$tarball_url" ]]; then
    echo "Error: Could not find a matching release for your arch ($(uname -m))." >&2
    exit 1
fi

# Skip if already installed
if [[ -d "$steam_dir/compatibilitytools.d/$release_name" ]]; then
    echo "Latest release $release_name is already installed."
    exit 0
fi

# Resolve checksum URL
checksum_url=$(echo "$release_json" |
    grep browser_download_url |
    cut -d\" -f4 |
    grep "$release_name.sha512sum$" || true)

if [[ -z "$checksum_url" ]]; then
    echo "Error: Could not find a checksum for $tarball_name in the release." >&2
    exit 1
fi

# Use cached tarball from tmp if valid, resume if incomplete
if [[ -f "$tarball_name" ]]; then
    echo "Found cached release: $release_name"
    echo "Verifying download..."

    if curl -sL "$checksum_url" | sha512sum -c - &>/dev/null; then
        echo "Cached release OK, skipping download."
    else
        echo "Cached release is incomplete, resuming download..."
        curl -C - -L "$tarball_url" -o "$tarball_name" --progress-bar
        echo "Verifying download..."

        if ! curl -sL "$checksum_url" | sha512sum -c - &>/dev/null; then
            echo "Resumed download corrupt, falling back to fresh download..."
            rm -f "$tarball_name"
            curl -L "$tarball_url" -o "$tarball_name" --progress-bar
            echo "Verifying download..."

            if ! curl -sL "$checksum_url" | sha512sum -c -; then
                echo "Error: Verification failed! The downloaded release may be corrupt." >&2
                exit 1
            fi
        fi
    fi

# Nuke the temporary working directory and download the tarball
else
    echo "Cleaning temporary directory..."
    rm -rf /tmp/proton-ge-custom
    mkdir /tmp/proton-ge-custom
    cd /tmp/proton-ge-custom
    echo "Downloading release: $release_name..."
    curl -L "$tarball_url" -o "$tarball_name" --progress-bar
    echo "Verifying download..."

    if ! curl -sL "$checksum_url" | sha512sum -c -; then
        echo "Error: Verification failed! The downloaded release may be corrupt." >&2
        exit 1
    fi
fi

# Extract the GE-Proton tarball to the Steam compatibility tools folder
echo "Extracting $tarball_name to the Steam compatibility tools folder..."
tar -xf "$tarball_name" -C "$steam_dir/compatibilitytools.d/" \
    || { echo "Error: Extraction failed!" >&2; exit 1; }

echo "Done :)"

The shell commands above can be run as a script by pasting the commands in a file and adding the following to the top of the file assuming you have 'bash' installed:

#!/bin/bash
set -euo pipefail
trap 'echo "Error" >&2' ERR

Save the file and make the script executable by adding the executable bit:

chmod +x file.sh

Flatpak

This section is for those that use the Steam Flatpak.

Flathub

The Steam Flatpak and the unofficial build of GE-Proton provided by Flathub are not supported by GloriousEggroll nor Valve and were not tested with all possible games and cases. They can behave differently from the upstream builds. Use at your own risk.

1. Add the Flathub repository.
2. Run:

   flatpak install com.valvesoftware.Steam.CompatibilityTool.Proton-GE
   

3. Enable proton-ge-custom in Steam.

Manual

1. Download a release from the Releases page.
2. Create a Steam compatibility tools directory at ~/.var/app/com.valvesoftware.Steam/data/Steam/compatibilitytools.d/ if it does not exist.
3. Extract the release tarball into ~/.var/app/com.valvesoftware.Steam/data/Steam/compatibilitytools.d/.
   • tar -xf GE-ProtonVERSION.tar.gz -C ~/.var/app/com.valvesoftware.Steam/data/Steam/compatibilitytools.d/
4. Restart Steam.
5. Enable proton-ge-custom in Steam.

Get the latest GE-Proton release through your terminal. It is assumed that you have coreutils and curl installed:

# Make a temporary working directory
echo "Making sure temporary directory exists..."
mkdir -p /tmp/proton-ge-custom
cd /tmp/proton-ge-custom

steam_dir=~/.var/app/com.valvesoftware.Steam/data/Steam

# Verify Steam data directory exists
if [[ ! -d "$steam_dir" ]]; then
    echo "Error: Steam (flatpak) data directory not found." >&2
    echo "Please launch Steam at least once to populate it." >&2
    exit 1
fi

# Make a Steam compatibility tools folder if it does not exist
mkdir -p "$steam_dir/compatibilitytools.d"

# Fetch release info
echo "Fetching release info..."
release_json=$(curl -s --max-time 10 \
    https://api.github.com/repos/GloriousEggroll/proton-ge-custom/releases/latest)

if [[ -z "$release_json" || "$release_json" != *'"tag_name"'* ]]; then
    echo "Error: Failed to fetch release info from GitHub." >&2
    exit 1
fi

# Resolve release URL for current architecture
echo "Fetching release for your arch..."

case "$(uname -m)" in
    aarch64|arm64) tarball_pattern='-aarch64\.tar\.gz$' ;;
    x86_64)        tarball_pattern='GE-Proton[0-9]+-[0-9]+\.tar\.gz$' ;;
    *)
        echo "Error: Unsupported architecture: $(uname -m)." >&2
        echo "GE-Proton is only available for x86_64 and aarch64." >&2
        exit 1
        ;;
esac

tarball_url=$(echo "$release_json" |
    grep browser_download_url |
    cut -d\" -f4 |
    grep -E "$tarball_pattern" |
    head -n1 || true)

tarball_name=$(basename "$tarball_url")
release_name=${tarball_name%.tar.gz}

if [[ -z "$tarball_url" ]]; then
    echo "Error: Could not find a matching release for your arch ($(uname -m))." >&2
    exit 1
fi

# Skip if already installed
if [[ -d "$steam_dir/compatibilitytools.d/$release_name" ]]; then
    echo "Latest release $release_name is already installed."
    exit 0
fi

# Resolve checksum URL
checksum_url=$(echo "$release_json" |
    grep browser_download_url |
    cut -d\" -f4 |
    grep "$release_name.sha512sum$" || true)

if [[ -z "$checksum_url" ]]; then
    echo "Error: Could not find a checksum for $tarball_name in the release." >&2
    exit 1
fi

# Use cached tarball from tmp if valid, resume if incomplete
if [[ -f "$tarball_name" ]]; then
    echo "Found cached release: $release_name"
    echo "Verifying download..."

    if curl -sL "$checksum_url" | sha512sum -c - &>/dev/null; then
        echo "Cached release OK, skipping download."
    else
        echo "Cached release is incomplete, resuming download..."
        curl -C - -L "$tarball_url" -o "$tarball_name" --progress-bar
        echo "Verifying download..."

        if ! curl -sL "$checksum_url" | sha512sum -c - &>/dev/null; then
            echo "Resumed download corrupt, falling back to fresh download..."
            rm -f "$tarball_name"
            curl -L "$tarball_url" -o "$tarball_name" --progress-bar
            echo "Verifying download..."

            if ! curl -sL "$checksum_url" | sha512sum -c -; then
                echo "Error: Verification failed! The downloaded release may be corrupt." >&2
                exit 1
            fi
        fi
    fi

# Nuke the temporary working directory and download the tarball
else
    echo "Cleaning temporary directory..."
    rm -rf /tmp/proton-ge-custom
    mkdir /tmp/proton-ge-custom
    cd /tmp/proton-ge-custom
    echo "Downloading release: $release_name..."
    curl -L "$tarball_url" -o "$tarball_name" --progress-bar
    echo "Verifying download..."

    if ! curl -sL "$checksum_url" | sha512sum -c -; then
        echo "Error: Verification failed! The downloaded release may be corrupt." >&2
        exit 1
    fi
fi

# Extract the GE-Proton tarball to the Steam compatibility tools folder
echo "Extracting $tarball_name to the Steam compatibility tools folder..."
tar -xf "$tarball_name" -C "$steam_dir/compatibilitytools.d/" \
    || { echo "Error: Extraction failed!" >&2; exit 1; }

echo "Done :)"

The shell commands above can be run as a script by pasting the commands in a file and adding the following to the top of the file assuming you have 'bash' installed:

#!/bin/bash
set -euo pipefail
trap 'echo "Error" >&2' ERR

Save the file and make the script executable by adding the executable bit:

chmod +x file.sh

Snap

This section is for those that use the Steam Snap.

This unofficial build isn't supported by GloriousEggroll nor Valve and wasn't tested with all possible games and cases. It can behave differently from the upstream builds. Use at your own risk.

Manual

1. Download a release from the Releases page.
2. Create a ~/snap/steam/common/.steam/steam/compatibilitytools.d/ directory if it does not exist.
3. Extract the release tarball into ~/snap/steam/common/.steam/steam/compatibilitytools.d/.
   • tar -xf GE-ProtonVERSION.tar.gz -C ~/snap/steam/common/.steam/steam/compatibilitytools.d/
4. Restart Steam.
5. Enable proton-ge-custom in Steam.

Building

1. Clone this repository by executing:

git clone --recurse-submodules https://github.com/gloriouseggroll/proton-ge-custom

2. Drop any custom patches into patches/, then open patches/protonprep-valve-staging.sh and add a patch line for them under #WINE CUSTOM PATCHES in the same way the others are done.

3. Apply all of the patches in patches/ by running:

./patches/protonprep-valve-staging.sh &> patchlog.txt

in the main proton-ge-custom directory. Open patchlog.txt and search for "fail" to make sure no patch failures occured. An easy way to do this is like so:

grep -i fail patchlog.txt
grep -i error patchlog.txt 

4. Navigate to the parent directory containing the proton-ge-custom folder.

5. Type the following:

mkdir build && cd build
../configure.sh --build-name=SOME-BUILD-NAME-HERE
make redist &> log

The build will be placed within the build directory as SOME-BUILD-NAME-HERE.tar.gz.

Enabling

1. Right click any game in Steam and click Properties.
2. At the bottom of the Compatibility tab, Check Force the use of a specific Steam Play compatibility tool, then select the desired Proton version.
3. Launch the game.

Options

Enable HDR

It should work if you have:

• A compositor with HDR support
• A game with HDR support.
• A monitor with HDR support.

PROTON_ENABLE_HDR=1 %command%

[!NOTE] Enabling HDR auto-enables the wine-wayland driver as it is a requirement. As of right now, in-game Steam overlay WILL NOT work with Wayland enabled. Please also note that Steam Input also does not work properly with the wine-wayland driver due to the overlay being broken.

Enabling NTSync

For NTSync to work, your kernel must be version 6.14 or newer and built with CONFIG_NTSYNC=y or CONFIG_NTSYNC=m. On non-systemd systems, you must also have a ulimit -Hn of 524288 or higher. If using CONFIG_NTSYNC=m, a module loading configuration is required followed by a reboot:

/etc/modules-load.d/ntsync.conf

ntsync

You can also manually enable the module without reboot, just keep in mind the above configuration is needed for it to persist after reboots:

sudo modprobe ntsync

If on a non-systemd system with an inadequate ulimit -Hn, adjusting limits is required followed by a reboot:

/etc/security/limits.d/26-steam-nofile.conf

*               hard    nofile             524288

Environment variable options:

Credits

The GE-Proton project contains some of my personal tweaks to Proton, but a large amount of the patches, rebases and fixes come from numerous people's projects.

While I tend to get credited for my builds, a lot of the work that goes into it are from other people as well. I'd like to take some time to point a few of these people out of recognition.

In future builds, I plan to make clearer and more informative Git commits, as well as attempt to give these people further crediting, as my README may not be sufficient in doing so.

TKG (Etienne Juvigny)

• https://www.patreon.com/tkglitch
• https://github.com/Frogging-Family/wine-tkg-git

I and many others owe TKG. In regards to both Wind and Proton. He has dedicated a lot of time (2+ years at least) to rebasing Wine and Proton patches, as well as making his own contributions. Before he came along, I did some rebasing work, and mainly only released things for Arch. These days he almost always beats me to rebasing, and it saves myself and others a lot of work.

Guy1524 (Derek Lesho)

• https://github.com/Guy1524

Derek was responsible for the original raw input patches, as well as several various game fixes in the past, just to name a few: MK11, FFXV, MHW, Steep, AC Odyssey FS fix. He has also done a massive amount of work on Media Foundation/MFPlat, which should be hopefully working very soon.

Joshie (Joshua Ashton)

• https://github.com/Joshua-Ashton/d9vk

Joshua is the creator of D9VK and also a huge contributor of DXVK. He is also known for his recent DOOM Eternal WINE fixes and also many of the Vulkan tweaks and fixes used, such as FS hack interger scaling.

doitsujin/ドイツ人 (Philip Rebohle)

• https://github.com/doitsujin/dxvk

Philip is the creator of DXVK and a heavy contributor of VKD3D. He also put up a lot of my bug reporting for Warframe years ago when DXVK started.

HansKristian/themaister (Hans-Kristian Arntzen)

• https://github.com/HansKristian-Work

Hans-Kristian is a heavy contributor of VKD3D and he also created a lot of WINE patches that allowed WoW to work.

flibitijibibo (Ethan Lee)

• https://github.com/sponsors/flibitijibibo
• https://fna-xna.github.io/

Ethan is the creator of FAudio, and he also listened to my Warframe bug reports years ago.

simmons-public (Chris Simmons)

• https://github.com/simons-public

Chris is the creator of the original 'protonfixes' project. The portions of 'protonfixes' I've imported are what allow customizations to be made to prefixes for various Proton games. Without 'protonfixes' many games would still be broken and/or require manual prefix modification.

wine-staging maintainers

I also of course need to thank the wine-staging maintainers: Alistair Leslie-Hughes, Zebediah Figura and Paul Gofman

They have contributed many patches to staging, far beyond what I have done, as well as kept up with regular rebasing. A lot of times when bug reports come to me, if it has to do with staging I end up testing and relaying information to these guys in order to get issues resolved.

Reporters

Additionally, a thank you is owed to Andrew Aeikum (aeikum), and kisak (kisak-valve) for regularly keeping me in the loop with Proton and fsync patches, as well as accepting pull requests I've made to fix Proton build system issues, or listening to bug reports on early Proton patches before they reach a Proton release.

Patrons

And finally - to all of my patrons that have supported me, thank you so much. It's because of you that I've been able to keep this project going, getting bug fixes reported, getting Proton/Wine issues fixed, getting various hardware and/or game fixes handled, and so on. Thanks to you, I have been able to use the spare budget in order to both help support the other people that make my project possible, as well as get things necessary for testing such as new game releases or specific hardware that hits odd issues. It's had a huge effect not just for this project, but a large trickle down effect.

My wine-staging co-maintainers are often able to ask me for testing games, or testing on different hardware if they don't have access to it. This also trickles into both Proton bug reporting and Lutris bug reporting, as I'm able to provide bug testing and feedback and custom builds and upgrades to them as well. I'm also able to test driver related issues for things such as mesa and getting things reported + patched. This in turn leads to early patches for Mesa, the kernel, VKD3D, and other packages on my copr repositories as well. The trickle down effect is just one gigantic awesome rabbit hole for getting things fixed. Thank you once again.

Donations

For anyone else interested, my Patreon can be found here:

https://www.patreon.com/gloriouseggroll

Tested games