diff --git a/README.md b/README.md index d10bd91..4597d01 100644 --- a/README.md +++ b/README.md @@ -7,15 +7,6 @@ A tool aimed at enhancing the experience when playing the game on linux through **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!** -## Features - -- set custom frame rate limits (e.g. 30, 90, 165, ...) -- remove black borders when using resolutions with an aspect ratio other than 16:9 (e.g. ultrawide). -- remove vigniette overlay -- remove chromatic abberation filter -- increase animation distance / fix choppy animations at screen edges -- remove 60hz limit when using fullscreen mode - ## Dependencies - Python >= 3.8.xx (lowest tested) @@ -23,22 +14,29 @@ A tool aimed at enhancing the experience when playing the game on linux through ## Usage 1. Copy the file `er-patcher` to the game directory. -2. In steam, set the game launch options to `./er-patcher ARGS -- %command%` where ARGS is replaced with a combination of - - `-r RATE` or `--rate RATE` for setting a custom framerate cap (default: 60) - - `--all` for enabling all options except `--rate` - - `-u` or `--ultrawide` for removing black bars - - `-v` or `--disable-vigniette` for removing the vigniette overlay - - `-c` or `--disable-ca` for disabling chromatic abberation - - `-a` or `--increase-animation-distance` for fixing low frame rate animations at screen edges or for distant entities. - - `-s` or `--skip-intro` for skipping intro logos when the game starts - - `-f` or `--remove-60hz-fullscreen` for removing the 60Hz limit in fullscreen mode (only applies to windows and has no effect when running the game through proton due to fshack) - - Example: `./er-patcher --all --rate 30 -- %command%` - - Example with mangohud and wine fullscreen fsr: `./er-patcher --rate 144 -uvca -- env WINE_FULLSCREEN_FSR=1 MANGOHUD=1 MANGOHUD_CONFIG=histogram %command%` +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. -### Windows +## 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 -It also work just as well on windows. The only difference is, that you need to run the script via your Python 3 installation. The following launch option line works in case you installed Python from Microsoft Store: +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%` @@ -56,3 +54,5 @@ When the game is launched through steam, the tool creates a patched version of ` - [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 \ No newline at end of file