-
Notifications
You must be signed in to change notification settings - Fork 135
LEGACY General Harmony Patcher Exectuable
The executable should only be used to inject/remove the mod loader method call into/from a game’s assembly; each stage will deploy/remove all libraries required by the mod loader to function correctly. Optionally, if a Unity3D assembly is detected, the patcher will inject the Vortex In-Game Overlay (VIGO) loader method as well.
Please note that modern Unity3D games (likely version 2018 and above) are currently distributed with a restricted Mono runtime library which disables reflection. The patcher will attempt to identify games with tampered runtime libraries and replace them with untampered versions. Please inform us if/when this functionality fails to replace the library.
Given that the patcher is a standalone executable, it is possible to execute it outside Vortex but please note that the mod loader is not designed to install or manage mods on its own.
Any errors which may have occurred during patch injection will be logged inside Vortex’s appdata folder “C:\Users{YOUR_USERNAME}\AppData\Roaming\Vortex\harmonypatcher.log” Discuss this article
Argument | Description |
---|---|
-h |
Displays the help screen. |
-g or extension= e.g. ./VortexHarmonyExec.exe -g "../game-untitledgoose"
|
(optional) Path to the game extension’s folder. Currently this is used to retrieve game-specific UI asset bundles stored inside the game’s extension folder. |
-m or managed= e.g. ./VortexHarmonyExec.exe -m "../path_to_game_assembly"
|
Used to define the full file path to the game assembly we wish to patch. Alternatively just a folder path can be defined and the patcher will assume we’re attempting to mod a Unity3D game and will try to load Assembly-CSharp.dll
|
-i or install= e.g. -i "../lib/"
|
Path to the patcher’s built dependencies - these are copied over to the game’s dataPath. |
-e or entry= e.g. -e "NameSpace.ClassName::MethodName"
|
The entrypoint for the patch. This defines the function where we wish to insert/inject the patcher function call for the game to use. |
-r e.g. ./VortexHarmonyExec.exe -r
|
(optional) Adding the -r argument will inform the patcher that it needs to attempt to remove the Vortex patch. The entrypoint and game assembly still need to be provided. |
This wiki and the Vortex Readme document contains a lot of information, please take your time and read these instructions carefully.
We provide detailed changes for each Vortex release.
If you have any questions about Vortex usage or want to share some information with the Vortex community, please go to one of the following places:
- About
- Install
- Troubleshooting
- Troubleshooting
- Developers
- Troubleshooting
- Developers
- Valheim
- Bannerlord
- BepInEx
- How to test a game extension
- How to package a game extension
- How to upload an extension to Nexus
- How to submit a game extension for review
Warning
The below documentation has not been checked for quality since migrating to GitHub Wiki and the information contained is potentially out of date and\or repeated.
- Frequently Asked Questions
- Getting Started
- Deployment Methods
- Downloading from Nexus Mods
- Managing File Conflicts
- Managing your Load Order
- Managing Save Games
- Setting up Profiles
- Keyboard Shortcuts
- How to create mod installers
- External Changes
- The Vortex Approach to Load Order
- Moving Vortex to a new PC
- Modding Skyrim Special Edition with Vortex
- Modding Mount & Blade II: Bannerlord with Vortex
- Modding Monster Hunter: World with Vortex
- Modding The Witcher 3 with Vortex
- Modding Baldur's Gate 3 with Vortex
- Modding Stardew Valley with Vortex
- Modding Valheim with Vortex
- Error Messages
- Misconfigured Documents Folder
- .NET 6 Install Issues
- Downgrading Extensions
- Command Line Parameters
- Introduction to Vortex extensions
- Creating a game extension (JavaScript)
- Creating a theme
- Game detection
- Adding a main page
- Adding a load order page
- Building UI with Vortex and React
- Packaging an extension
- Introduction
- Packaging extensions
- Project management
- Harmony Patcher Exectuable
- Vortex Harmony Mod Loader
- Setting up your dev environment
- Creating a theme
- Creating a game extension