Harmony 2

Introduction

Harmony gives you an elegant and high level way to alter functionality in applications written in C#. It does this at runtime by monkey patching methods unlike other solutions that change the content of dll files.

It supports Mono and .NET environments on Windows, Unix and macOS except when Unity uses the stripped down NetStandard profile (.NET 4.x profile works fine). Harmony is used in mainstream Unity games and many other applications.

Designed to be used by multiple users (usually called Mods) that would otherwise override each others hooks, it was originally created for the game RimWorld and its large modding community by Andreas Pardeike.

Enjoy! /Andreas Pardeike

Getting Started

If you want a single file, dependency-merged assembly, you should use the Lib.Harmony nuget package. This is the preferred way.

If you instead want to supply the dependencies yourself, you should use the Lib.Harmony.Thin nuget package. You get more control but you are responsible to make all references available at runtime.

Documentation

You can learn more about Harmony by using the top menu links. The main section [Harmony] brings you to the full documentation that explains everything about Harmony and gives you lots of high level examples. In the second section [API Documentation] you can browse the public API and all its methods and classes.

If you find a factual error or if you have feedback about the documentation you are welcome to

• fork the repository and create a pull request
• file a documentation Issue on the repo
• or write about it on the official discord

New to modding and C#? Beside the basic language features you need at least a good overview of Reflection in C#. Read this short and useful introduction.

Community

If you feel stuck or have questions that this site does not answer, feel free to join the official Discord Server or file a GitHub Issue.

Help by promoting this library so other developers can find it. One way is to upvote this stackoverflow answer. Or spread the word in your developer communities. Thank you!

Contact

Andreas Pardeike [email protected] twitter: @pardeike

Donations

Donations keep me going: https://www.patreon.com/pardeike