brndd / vanilla-tweaks

Custom QoL patches to the 1.12.1 WoW client
MIT License
152 stars 24 forks source link

Build and tests

vanilla-tweaks

These are some custom patches for the old 1.12.1 World of Warcraft client, which lacks many of the conveniences of more modern clients.

Current patches

Usage

Download the release matching your operating system from the releases page. Extract the executable from the archive into your WoW directory.

Simple usage (Windows)

Open your WoW directory and drag WoW.exe on top of vanilla_tweaks.exe. This will create a new file called WoW_tweaked.exe, which has all the patches applied with their default settings. You should then start the game from WoW_tweaked.exe instead. You may also rename your original WoW.exe to something else and then rename WoW_tweaked.exe to WoW.exe if you prefer. However, do note that this may cause issues if the server you are playing on uses the game's update system to update the game.

Customizing the settings

To customize the values changed by the patches, or to disable some patches, you must run vanilla-tweaks from the command line.

First, open a command prompt and navigate to your WoW directory. The easiest way to do this on Windows is to click File -> Open Windows PowerShell. On Mac, you can control-click the folder in the path bar and select Open in Terminal. On Linux, you can probably right-click on an empty space in the directory and open a terminal from there, but as a Linux user you probably know how to use the cd command anyway.

With your terminal open in your WoW directory, you may then run vanilla-tweaks with custom parameters like this:

./vanilla-tweaks --no-sound-in-background --nameplatedistance 60 WoW.exe

The example here disables the sound in background patch and sets nameplate distance to 60 feet rather than 40.

To see a full list of the available options, you may use the --help parameter:

./vanilla-tweaks --help

Launch scripts

(Pull requests to add scripts for other platforms here are welcome!)

Linux/Lutris

Here is an example Lutris launch script that clears the game's cache folder and regenerates the patched executable if WoW.exe has changed since the last time the patches were applied (e.g. the server shipped an update to the game files).

Make sure to modify the game path to match your installation. You can then enable the script by setting it in Lutris via Configure > System Options > Pre-launch script (make sure "Wait for pre-launch script completion" is active).

#!/bin/bash

cd /media/ssd0/games/turtle-wow/drive_c/turtle_client_116/
#Clear cache
rm -f /media/ssd0/games/turtle-wow/drive_c/turtle_client_116/WDB/*

#Check hash of WoW.exe to see if it has changed
if ! sha256sum --status --check WoW.exe.sha256; then
    echo "WoW.exe has changed, updating WoW.exe.sha256 and WoW_tweaked.exe"
    sha256sum WoW.exe > WoW.exe.sha256
    ./vanilla-tweaks WoW.exe
fi