SonicGD.Lib.Harmony
2.3.1
dotnet add package SonicGD.Lib.Harmony --version 2.3.1
NuGet\Install-Package SonicGD.Lib.Harmony -Version 2.3.1
<PackageReference Include="SonicGD.Lib.Harmony" Version="2.3.1" />
paket add SonicGD.Lib.Harmony --version 2.3.1
#r "nuget: SonicGD.Lib.Harmony, 2.3.1"
// Install SonicGD.Lib.Harmony as a Cake Addin #addin nuget:?package=SonicGD.Lib.Harmony&version=2.3.1 // Install SonicGD.Lib.Harmony as a Cake Tool #tool nuget:?package=SonicGD.Lib.Harmony&version=2.3.1
<p align="center"> <img src="https://raw.githubusercontent.com/pardeike/Harmony/master/HarmonyLogo.png" alt="Harmony" width="180" /><br> <b>Version 2</b><br> A library for patching, replacing and decorating<br> .NET and Mono methods during runtime. </p>
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, SCP: Secret Laboratory and many more.
It is also used in unit testing WPF 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
Installation
Installation is done by using 0Harmony.dll in your project or by using the Lib.Harmony nuget package.
Documentation
Please check out the documentation and join the official discord server.
Contribute
I 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.
Harmony 1
Harmony 1 is deprecated and not under active development anymore. The latest version of it (v1.2.0.1) is stable and contains only minor bugs. Keep using it if you are in an environment that exclusively uses Harmony 1. Currently Harmony 1.x and 2.x are NOT COMPATIBLE with each other and SHOULD NOT BE MIXED. The old documentation can still be found at the Wiki.
<br>
<p align="center"> <a href="../../releases/latest"> <img src="https://img.shields.io/github/release/pardeike/harmony.svg?style=flat" /> </a> <a href="https://www.nuget.org/packages/lib.harmony"> <img src="https://img.shields.io/nuget/v/lib.harmony.svg?style=flat" /> </a> <a href="https://harmony.pardeike.net"> <img src="https://img.shields.io/badge/documentation-%F0%9F%94%8D-blue?style=flat" /> </a> </p> <p align="center"> <a href="https://dev.azure.com/pardeike/Harmony/_build"> <img src="https://pardeike.visualstudio.com/Harmony/_apis/build/status/Build%20and%20test" /> </a> <a href="https://discord.gg/xXgghXR"> <img src="https://img.shields.io/discord/131466550938042369.svg?style=flat&logo=discord&label=discord" /> </a> <a href="../../blob/master/LICENSE"> <img src="https://img.shields.io/github/license/pardeike/harmony.svg?style=flat" /> </a> </p> <p align="center"> <a href="mailto:andreas@pardeike.net"> <img src="https://img.shields.io/badge/email-andreas@pardeike.net-blue.svg?style=flat" /> </a> <a href="https://twitter.com/pardeike"> <img src="https://img.shields.io/badge/twitter-@pardeike-blue.svg?style=flat&logo=twitter" /> </a> </p>
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 is compatible. net5.0-windows was computed. net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 is compatible. netcoreapp3.1 is compatible. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net35 is compatible. net40 was computed. net403 was computed. net45 was computed. net451 was computed. net452 is compatible. net46 was computed. net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 is compatible. net48 is compatible. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETCoreApp 3.0
- MonoMod.Core (>= 1.0.0)
-
.NETCoreApp 3.1
- MonoMod.Core (>= 1.0.0)
-
.NETFramework 3.5
- MonoMod.Core (>= 1.0.0)
-
.NETFramework 4.5.2
- MonoMod.Core (>= 1.0.0)
-
.NETFramework 4.7.2
- MonoMod.Core (>= 1.0.0)
-
.NETFramework 4.8
- MonoMod.Core (>= 1.0.0)
-
.NETStandard 2.0
- MonoMod.Core (>= 1.0.0)
- System.Reflection.Emit (>= 4.7.0)
-
net5.0
- MonoMod.Core (>= 1.0.0)
- System.Text.Json (>= 5.0.2)
-
net6.0
- MonoMod.Core (>= 1.0.0)
- System.Text.Json (>= 5.0.2)
-
net7.0
- MonoMod.Core (>= 1.0.0)
- System.Text.Json (>= 5.0.2)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.