Skip to main content

protonfixes

Screenshot

A module for applying fixes at runtime to unsupported games with Steam Proton without changing game installation files. The idea is to include seperate fixes that are only loaded when a game matching that ID is run. This should keep the individual game fixes from affecting any other games. Applying the fixes at runtime should also them to persist after game updates.

Current fixes include:

  • Final Fantasy IX
  • Oddworld: Abe's Oddysee
  • Forts
  • Styx: Master of Shadows

Current utilities available:

  • util.protontricks('verb')
    • installs a winetricks verb
  • util.use_win32_prefix()
    • creates and uses a win32 (32bit) wineprefix
  • util.replace_command('original', 'replacement')
    • replaces text in the game's launch command
  • util.append_argument('argument')
    • adds an argument to the game's launch command
  • util.protonprefix()
    • returns the path of the current wineprefix used by Proton

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 load

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.

Splashscreen

For the splashscreen to work, you need to have cefpython3 installed. It can be installed with pip using sudo pip install cefpython3. The splashscreen can help let you know that protonfixes is running a long task, for example installing dotnet35.

Install from PIP

# sudo pip install protonfixes

Install using setuptools

# sudo python setup.py install

Add to user_settings.py

In the steamapps/common/Proton* directory, add the following line to 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.

Writing Game Fixes

Game fixes are written in python and are named by the Steam game ID with the extension .py. For example, the file 377840.py will be loaded when the game FINAL FANTASY IX is run. Gamefixes can be added to the ~/.config/protonfixes/localfixes/ directory. Here are some things to consider when writing fixes:

  • Only import libraries that are part of the Python standard library for portability.
  • Use docstrings and comment thoroughly. There will likely be people without python experience making game fixes and good commented examples will help
  • Do not use any hard-coded paths, Steam may not always be installed in the same location.
  • Check your gamefix with pylint. You can safely disable warning C0103, modules named by Steam ID will never conform to snake_case naming style.

Testing

When testing, local fixes can be added to ~/.config/protonfixes/localfixes/. They should be imported the same way as an included fix would be. For example, ~/.config/protonfixes/localfixes/377840.py would be loaded for FFIX. Please feel free to submit working gamefixes to improve the project.

Example game fixes

377840.py - Changing the executable launched and setting an environment variable

import os
from protonfixes import util


def main():
    """ Bypass the launcher and fix audio
    """

    print('Applying FINAL FANTASY IX Game Fixes')

    # Fix crackling audio
    os.environ['PULSE_LATENCY_MSEC'] = '60'

    # Replace launcher with game exe in proton arguments
    util.replace_command('FF9_Launcher', 'x64/FF9.exe')

410900.py - Running a winetricks verb

from protonfixes import util

def main():
    """ Uses winetricks to install the ole32 verb
    """

    print('Applying fixes for Forts')

    util.protontricks('ole32')

15700.py - Example using a win32 prefix

Oddworld doesn't actually require a win32 prefix or dotnet35, but I used it for testing since it's 32bit

import sys
from protonfixes import util

def main():
    """ Adds -interline to arguments, uses a win32 prefix, and installs dotnet35
    """

    print('Applying fixes for Oddworld: Abe\'s Oddysee')

    # Adding -interline fixes slow video but adds scanlines
    util.append_argument('-interline')

    print('Using a win32 prefix')
    util.use_win32_prefix()

    # Make sure any winetricks are run after changing to a win32 prefix
    util.protontricks('dotnet35')

Contributing

Pull requests are welcome! If you're not comfortable doing pull requests, send your fixes to me by any other means and you will be credited in the comments.

Metadata

Release files for protonfixes 1.0.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for protonfixes 1.0.6
File Size Uploaded Provenance Actions
protonfixes-1.0.6.tar.gz 10.5 kB Without provenance Details for protonfixes-1.0.6.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for protonfixes 1.0.6
File Interpreter ABI Platform Actions
protonfixes-1.0.6-py3-none-any.whl Python 3 none any Details for protonfixes-1.0.6-py3-none-any.whl

Total release size: 23.7 kB

Release files / protonfixes-1.0.6.tar.gz

Download URL protonfixes-1.0.6.tar.gz
Size 10.5 kB
Tags Source
SHA-256 checksum
How to use checksums
6922e487e655a3e0541bd52d3a2e88bc736a5cdbd0bcf7c4185d2e0aefd358a2
BLAKE2b-256 checksum
How to use checksums
e5f48eb5427f1a896071b320766fa3a72d66135f01defd86af6d4808758366d5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.2 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.7.0

Release files / protonfixes-1.0.6-py3-none-any.whl

Download URL protonfixes-1.0.6-py3-none-any.whl
Size 13.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6f4f9aec3786394812972df97ae310335b2bf6e0cb7ee7522c87a5f9e833f224
BLAKE2b-256 checksum
How to use checksums
98a9ddeaa8b64bc3f59fbf0fad8144b012fba9303d11442fd6994a9275a5cb54
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.2 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.7.0

Security for protonfixes 1.0.6

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page