theo/er-patcher
1
0
Fork 0
mirror of https://github.com/gurrgur/er-patcher.git synced 2026-06-13 09:47:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix formatting and typos and get readme up-to-date

Browse source
This commit is contained in:
Kauã Azevedo 2022-09-15 23:52:10 +00:00 • committed by GitHub
parent 55321028d5
commit 2a237ac199
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 32 additions and 51 deletions
Download patch file Download diff file Expand all files Collapse all files

81
README.md
View file

@ -1,62 +1,43 @@
# Elden Ring Proton Patcher
Elden Ring enhancement patches (custom frame rate limits, ultrawide support etc.) seamlessly integrated with Steam.
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 (unless explicity told to do so). Use at your own risk!**
Elden Ring Proton Patcher aims to enhance the experience when playing the game on Linux via Proton and Windows. It safely patches `eldenring.exe`, which is created in a temporary subdirectory and deleted on shutdown, via hex-edits, ensuring the patched executable is not run with EAC if no `--with-eac` flag is set. Use at your own risk.
## Dependencies
- Python >= 3.8
- Python ≥ 3.8
## Usage
1. Copy the file `er-patcher` to the game directory.
2. In steam, set the game launch options to `python er-patcher ARGS -- %command%` See [Features](#features) for available options.
- Example: `python er-patcher --all --rate 30 --disable-rune-loss -- %command%`
- Example using [MangoHud](https://github.com/flightlessmango/MangoHud) and wine fullscreen FSR: `python 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.
2. Set the game launch options to `python er-patcher ARGS -- %command%` in Steam. See [Features](#features) for available options.
- Example: `python er-patcher --all -r 90 -l -- %command%`
- Example with [MangoHud](https://github.com/flightlessmango/MangoHud) and Wine fullscreen FSR: `python er-patcher -acvu -r 144 -- env WINE_FULLSCREEN_FSR=1 MANGOHUD=1 MANGOHUD_CONFIG=histogram %command%`
3. Launch the game in Steam. `er-patcher` automatically launches a patched `eldenring.exe` without EAC.
Note: There might be some distros (e.g. older Ubuntu releases) that launch python 2 instead of 3 when running `python`. In that case you'll need to replace `python` with `python3` in the launch option line.
Note: Some distros (e.g., older Ubuntu versions) launch Python 2 instead of 3 when running `python`. You will need to use `python3` in that case.
## Features
| Argument | Description |
| --- | --- |
| `--all` | Enable all options but `--rate` and gameplay changes like `--disable-rune-loss`. |
| `-l` or `--disable-rune-loss` | Disable rune loss on death. |
| `-a` or `--increase-animation-distance` | Fix low frame rate animations for distant entities or at screen edges. |
| `-r RATE` or `--rate RATE` | Set a custom frame rate limit (default: 60). |
| `-f` or `--remove-60-hz-fullscreen` | Remove 60 Hz lock in fullscreen (unneeded in Proton). |
| `-c` or `--remove-ca` | Remove chromatic aberration. |
| `-v` or `--remove-vignette` | Remove the vignette. |
| `-s` or `--skip-intro` | Skip intro logos on startup. |
| `-u` or `--ultrawide` | Remove black bars in non 16:9 screens. |
| `--with-eac` | Run the game with EAC (use at your own risk). |
| Argument | Description |
| --------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| `-r RATE` or `--rate RATE` | Set a custom framerate limit (default: 60). |
| `--with-eac` | Run game with EAC (Use it at your own risk) |
| `--disable-rune-loss` | Disable losing runes upon death. |
| `--all` | Enable all options except `--rate` and<br>gameplay changes like `--disable-rune-loss`. |
| `-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<br>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<br>mode (not needed with proton). |
## Windows support
The tool works just as well on Windows. This launch option line works if you installed Python from Microsoft Store:
```
python er-patcher --all -r 75 -- %command%
```
Note: It opens a Python console which closes by itself on shutdown. Use `pythonw` if you find it annoying. `python` needs to be in PATH for Windows to find it.
## Windows Support
The patcher works just as well on windows. The following launch option line works in case you e.g. 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. As long the flag `--with-eac` is not set, the tool modifies the steam launch command to launch the patched executable instead of `start_protected_game.exe`, thefore ensuring 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)
- disable rune loss
## References
- [DarkSouls3RemoveIntroScreens](https://github.com/bladecoding/DarkSouls3RemoveIntroScreens) - Intro logo skip
- [EldenRingFpsUnlockAndMore](https://github.com/uberhalit/EldenRingFpsUnlockAndMore) - Black bars removal and custom frame rate limit
- [EldenRingMods](https://github.com/techiew/EldenRingMods) and [EldenRingFpsUnlockAndMore](https://github.com/uberhalit/EldenRingFpsUnlockAndMore) - Disable rune loss
- [Flawless Widescreen](https://www.flawlesswidescreen.org) - Animation distance increase and chromatic aberration and vignette removal