er-patcher/README.md

# Elden Ring Proton Patcher


A tool aimed at enhancing the experience when playing the game on linux through proton or natively on windows.

## Warning

**This tool is based on patching the game executable through hex-edits. However it is done in a safe and non-destructive way, that ensures the patched executable is never run with EAC enabled. Use at your own risk!** 

## Dependencies

- Python >= 3.8.xx (lowest tested)

## Usage

1. Copy the file `er-patcher` to the game directory.
2. In steam, set the game launch options to `./er-patcher ARGS -- %command%` See [Features](#features) for available options.
  - Example: `./er-patcher --all --rate 30 --fix-camera -- %command%`
  - Example using [MangoHud](https://github.com/flightlessmango/MangoHud) and wine fullscreen FSR: `./er-patcher --rate 144 -uvca -- env WINE_FULLSCREEN_FSR=1 MANGOHUD=1 MANGOHUD_CONFIG=histogram %command%`
3. Launch the game through steam. `er-patcher` automatically launches a patched version of `eldenring.exe` with EAC disabled.

## Features

| Argument                                | Description                                                                  |
| --------------------------------------- | ---------------------------------------------------------------------------- |
| `-r RATE` or `--rate RATE`              | Set a custom framerate limit (default: 60).                                  |
| `--fix-camera`                          | Disable camera auto-rotation.                                                |
| `--all`                                 | Enable all options except `--rate` and gameplay changes like `--fix-camera`. |
| `-u` or `--ultrawide`                   | Remove black bars.                                                           |
| `-v` or `--disable-vigniette`           | Remove the vigniette overlay .                                               |
| `-c` or `--disable-ca`                  | Disable chromatic abberation.                                                |
| `-a` or `--increase-animation-distance` | Fix low frame rate animations at screen edges or for distant entities.       |
| `-s` or `--skip-intro`                  | Skip intro logos at game start.                                              |
| `-f` or `--remove-60hz-fullscreen`      | Remove the 60Hz limit in fullscreen mode (not needed with proton).           |


## Windows Support

The patcher works just as well on windows. The only difference is that you need to explicitly call python to run the script `er-patcher`. The following launch option line works in case you installed Python from Microsoft Store:

> `python er-patcher --rate 165 --all -- %command%`

Note: This spawns a python console which will close by itself after the game has finished running. If you find this annoying you can try using `pythonw` instead. In any case `python` needs to be in PATH for windows to find it.

## How it works

When the game is launched through steam, the tool creates a patched version of `eldenring.exe` in a temporary subdirectory while leaving the original intact. The tool then modifies the steam launch command to launch the patched executable instead of `start_protected_game.exe`. This ensures that the patched exe is never run with EAC enabled. After the game is closed, the patched executable is removed.

## Credits

- [EldenRingFpsUnlockAndMore](https://github.com/uberhalit/EldenRingFpsUnlockAndMore)
  - frame time limit adjustment
  - black bar removal
- [Flawless Widescreen](https://www.flawlesswidescreen.org)
  - vigniette and ca removal
  - animation distance increase
- [DarkSouls3RemoveIntroScreens](https://github.com/bladecoding/DarkSouls3RemoveIntroScreens): intro logo skip
- [EldenRingMods](https://github.com/techiew/EldenRingMods) + [EldenRingFpsUnlockAndMore](https://github.com/uberhalit/EldenRingFpsUnlockAndMore): camera fix