KingKrouch / Cheat-Engine-Proton-Helper

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Cheat-Engine-Proton-Helper

This Bash Script allows running Cheat Engine with Steam games running in Proton.

Based on a script from Luetti from the Cheat Engine forums, modified for Steam Proton games.

I put this together after some looking around for some insights on how such a thing could be done, since switching from Windows, I needed to continue work in a way that would give me consistently correct memory offsets for both running natively in Windows and Proton. The problem is that all of the Linux alternatives to Cheat Engine are barebones (and lack the features that I needed), and because both those and the CEServer method have completely different memory offsets that would make mod development in a platform agnostic standard difficult.

Prerequisites

  • 64-Bit Wine (Instructions for Arch Linux, Fedora and Ubuntu here.)

  • Steam with Proton installed

  • X11 (X Window System) (This is enabled for NVIDIA GPUs with propreitary drivers by default)

  • xdotool installed (See here for more information.)

Note: While NVIDIA GPUs with propreitary drivers through X11 have been tested with this script, compatibility with AMD/Intel GPUs through Wayland can't be guaranteed.

Setup

To download the script, and set up everything you need to:

  1. git clone https://gitlab.com/KingKrouch/cheat-engine-proton-helper.git in the terminal.
  2. Use cd Cheat-Engine-Proton-Helper to enter the cloned directory
  3. Use chmod +x ./setup.sh to mark the setup script as executable.
  4. Run ./setup.sh to automatically download and install Cheat Engine to your current Wine prefix.

Note: If the setup script doesn't already chmod CE.sh, then you can just run Step 3 of the setup process but with that file instead.

Configuration

  1. Edit CE.sh with a text editor such as Nano, Vim, Kate, or anything else.
  2. Change the prefixInstall parameter to the Steam library folder where the game is installed (By default, this is "/home/$USER/.steam/Steam").
  3. Change the PROTONVERSIONNAME to the Proton version used by the game (The exact naming for the version can be found as the name of the folder in "/home/$USER/.steam/Steam/SteamApps/Common"), and change the PROTONSUBDIRECTORYNAME to the folder inside of said Proton directory that leads to a "bin" folder containing an executable named "wine" (By default, this is already set for Proton's Experimental version which uses a "files" directory instead of "dist" which is used by Proton 3.7).

Note: More notes are provided in the file which gives more detail about certain parameters.

Usage

  1. Simply launch CE.sh by using ./CE.sh in a terminal.

Note: Only do this after launching the game through Proton for the first time, as this script assumes it has already gone through the initial setup phase.

License

See the Unlicense for more details.

About

License:The Unlicense


Languages

Language:Shell 100.0%