VBPatcher 0.9.0

Description:

VBPatcher 0.9.0

VBPatcher

Valheim BepInEx Patcher


About


Valheim BepInEx Patcher (VBP) is a CLI application for patching the Unity modding plugin, BepInEx, to its latest release (whether LTS or experimental).


VBP was originally created as a solution for an issue that occurs while using the Vortex modding tool to mod the game Valheim, whilst having BepInEx installed.


When opening Vortex to begin modding Valheim, the modding tool automatically downloads what it incorrectly perceives to be the "latest" version of BepInEx (a necessary requirement for the vast majority of mods available) which is generally incorrect, and often takes a long time to be fixed.


Unfortunately, this means if you were using an experimental/newer/different build of BepInEx, it has been overwritten by whatever build Vortex installed.


This occurs each and every time you open Vortex, and became a major annoyance for me, so I decided to create a quick solution to make this problem less annoying.





Installation
Using PIP (Recommended)


To install VBP using pip, enter the following:


python -m pip install VBPatcher





Done!


Manual Installation (NOT Recommended)


Download the project's latest release *.zip archive from the "releases" tab and extract to location of choice, or clone repository with the git client of your preference with:


gh repo clone schlopp96/VBPatcher





Open terminal and navigate to the extracted directory "~./VBPatcher".


Enter the following to install necessary dependencies:


pip install -r requirements.txt






Done!


Usage


Make sure you do not have Vortex, Thunderstore, or any other modding tools running, and that you are done with any modding processes.


Each time Vortex is opened to mod Valheim, your BepInEx version will be downgraded again, so I highly recommend running this script every time before playing!




Open the application, which can be run within a terminal using the following command:


vbpatcher



You can also run VBPatcher from the main program file:

~./VBPatcher/main.py.





Once the script is run, you will be presented with an option menu, allowing you to choose from the following commands:

[1]. Patch BepInEx to the latest stable release.
[2]. Patch BepInEx to the latest developmental/experimental "bleeding-edge" build.
[3]. Patch BepInEx first with the latest stable release, and then with the latest experimental build to ensure a safe installation.
[4]. Check for and download new releases/builds of BepInEx.
[5]. Start Valheim.
[6]. Exit the application.



Once an option is chosen, you will then be asked to confirm that the correct option/location is chosen.

For example, once the option to apply a patch is confirmed, the script will begin patching the appropriate files immediately, and should finish in seconds.



Upon successful patching, the script will ask the user if they'd like to start Valheim.


If you choose to run the game, the patcher will automatically close itself after running the game's executable.


If you choose to NOT run the game, the patcher will return to the main menu.



Note that you can also find the latest bleeding-edge-builds of BepInEx here.


How It Works


VBPatcher functions by simply copying the relevant patch files & places/overwrites core files responsible for the BepInEx version downgrade.


The patch files will all be placed in either one of two potential locations within Valheim's install directory


The location of the game's install directory is different depending on the operating system of the user.


For Windows, the default install path for Valheim is:

C:\Program Files (x86)\Steam\steamapps\common\Valheim



For MacOS, the default install path for Valheim is:

~./Library/Application Support/Steam/steamapps/common/Valheim





Patches will be applied to the BepInEx folder, itself found within the game's installation folder:

~./Steam/steamapps/common/Valheim/BepInEx.




Opening VBPatcher


Within a terminal, open VBP with the following command:


vbpatcher








Or optionally within a python environment:


>>> import VBPatcher # Import package
>>> VBPatcher.vbp() # Call method to open program



>>> from VBPatcher import vbp # Import package
>>> vbp() # Call method to open program








From here, follow the on-screen prompts to operate the program.


Choose an operation to run by entering the corresponding number (1-6) and pressing enter.



Usage Example


The following depicts using VBPatcher from a command line to first check for any new updates before installing the latest base/stable-release of BepInEx, then the newest dev-build/bleeding-edge patch builds:






Contact

If you have any questions, comments, issues, complaints, etc, feel free to:

contact me through my email at: [email protected].
Submit an issue to the project's GitHub repository