Harmony Early Access

A library for patching, replacing and decorating .NET and Mono methods during runtime. Intended to ensure that all mods in a player's modlist are using the latest version of Harmony to minimize conflicts. We also added a Debug UI! Available via CTRL+ALT+H.

Notes

This is an unofficial distribution of the Harmony library maintained by the community to have an easier way to manage external library dependencies. The repository of the mod - Bannerlord.Harmony.

Installation

This module should be the highest in loading order. Any other module that requires to be set at the top (Better Exception Window, ButterLib, MCM, etc.) should be loaded after this mod.

For Players

This mod is intended to ensure that all mods in a player's modlist are using the latest version of Harmony to minimize conflicts.

For Modders

We added a Debug UI! Available via CTRL+ALT+H.

You still need to reference Harmony as a NuGet package, it is not required to include 0Harmony.dll in the final /bin output of your module. You do need to add this to your SubModule.xml

This way the game will ensure that the Harmony library is loaded before your mod.

Versioning

The Module combines the Harmony version used and the Build Id that published the Module. The Build Id is simply added to the end. 2.0.2.22 indicates that Harmony 2.0.2.0 is used and 22 is the Build Id. 2.0.0.1025 indicates that Harmony 2.0.0.10 is used and 25 is the Build Id.

We considered using the Rimworld approach with introducing our own version system, but it won't give a clear way to detect which Harmony version the Module contains. It's easier for the user to report the version of the Module used than to check the assembly version/send it.

Troubleshooting

• If the game crashes on start, most likely you are using or you were using Fixed Launcher. When installed, it copies 0Harmony.dll which prevents Bannerlord.Harmony from working.

• If Fixed Launcher was uninstalled or never installed, check that the following files are not in the game's main /bin folder (Mount & Blade II Bannerlord\bin\Win64_Shipping_Client)

• TaleWorlds.MountAndBlade.Launcher.exe.config

• 0Harmony.dll

• LauncherPatcher.dll

• LauncherPatcher.pdb

About

Harmony gives you an elegant and high level way to alter the functionality in applications written in C#. It works great in games and is well established in titles like 7 Days To Die, BattleTech, Besiege, Cities:Skylines, Kerbal Space Program, Oxygen Not Included, Ravenfield, Rimworld, Sheltered, Stardew Valley, Staxel, Subnautica, The Ultimate Nerd Game, Total Miner, Unturned and many more.

It is also used in unit testing WFP controls and in many other areas.

How it works

If you develop in C# and your code is loaded as a module/plugin into a host application, you can use Harmony to alter the functionality of all the available assemblies of that application. Where other patch libraries simply allow you to replace the original method, Harmony goes one step further and gives you:

• A way to keep the original method intact

• Execute your code before and/or after the original method

• Modify the original with IL code processors

• Multiple Harmony patches co-exist and don't conflict with each other

• Works at runtime and does not touch any files

Documentation

Please check out the documentation.

Contribute

pardeike put thousands of hours into this project and its support. So every little action helps:

• Upvote this stackoverflow answer
• Spread the word in your developer communities
• Become a GitHub sponsor or a Patreon

This project uses the great MonoMod.Common library by 0x0ade.