Harmony 2 has come a long way since the last release 1.2.0.1. Here are all the changes:
CI/CD on Azure, Travis and AppVeyor
-Switched to MonoMod.Common for shared low level patching with MonoMod project
-Works with more .NET versions
-Inline prevention for Mono
-4th patch type: Finalizer - for handling and manipulating exceptions
-Reverse Patching (original onto one of your stub methods)
-Convenience extension methods for CodeInstruction
-Selective debug log with [HarmonyDebug] annotation - works even with future changes of the method
-Prepare/Cleanup will be called even with exceptions during patching
-Cleanup can now receive and return the current Exception during patching
-Better exception reporting with HarmonyException
-Automatic documentation generated to https://harmony.pardeike.net
-AccessTools has methods for declared members
-FastAccess now deals with generics
-Manipulator transpiler helper
-Get IL code from a method
+
CI/CD with GitHub Actions
+Switched to MonoMod.Core for shared low level patching with MonoMod project
+Works with more .NET versions
+Inline prevention for Mono
+4th patch type: Finalizer - for handling and manipulating exceptions
+Reverse Patching (original onto one of your stub methods)
+Convenience extension methods for CodeInstruction
+Selective debug log with [HarmonyDebug] annotation - works even with future changes of the method
+Prepare/Cleanup will be called even with exceptions during patching
+Cleanup can now receive and return the current Exception during patching
+Better exception reporting with HarmonyException
+Automatic documentation generated to https://harmony.pardeike.net
+AccessTools has methods for declared members
+FastAccess now deals with generics
+Manipulator transpiler helper
+Get IL code from a method
Support for IL InlineSignature (patching methods with CALLI)
Priority field spelling
-Traverse can handle static members
-Methods returning struct types are now patchable
-Main API is now properly divided into static/instance methods
-HarmonyMethod and other high level API throws on null input
-Patch sorting
-DeepCopy works with nullable types
-Patch annotations API cleaned up
-FieldRef covers more cases and is simplified
-__result assignability checks
-Handling __state without Prefix
-Debug log writes out full type names
-Documentation now uses compiled code snippets for correctness
+
Priority field spelling
+Traverse can handle static members
+Methods returning struct types are now patchable
+Main API is now properly divided into static/instance methods
+HarmonyMethod and other high level API throws on null input
+Patch sorting
+DeepCopy works with nullable types
+Patch annotations API cleaned up
+FieldRef covers more cases and is simplified
+__result assignability checks
+Handling __state without Prefix
+Debug log writes out full type names
+Documentation now uses compiled code snippets for correctness
Traverse works with inherited fields, properties and methods
Removed Self-patching
-Renamed Add() extension on IEnumerable<T> and T[] to AddItem() to avoid conflicts
+
Removed Self-patching
+Renamed Add() extension on IEnumerable<T> and T[] to AddItem() to avoid conflicts
HarmonyInstance is now called Harmony and Harmony namespace is now called HarmonyLib
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!
+
Enjoy! /Andreas Pardeike
Installation is usually done by copying and referencing 0Harmony.dll from your project or by using the Lib.Harmony nuget package.
+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.
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
@@ -84,11 +85,11 @@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!
Andreas Pardeike
-andreas@pardeike.net
+
Andreas Pardeike +andreas@pardeike.net twitter: @pardeike
Donations keep me going:
+
Donations keep me going: https://www.patreon.com/pardeike
diff --git a/docs/manifest.json b/docs/manifest.json index fa2a2894..4133d502 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -861,7 +861,7 @@ "output": { ".html": { "relative_path": "articles/new.html", - "hash": "TxZ1W6tAON14wnGIhKz1hhpvlm5svvi3FrD/yHXrqV0=" + "hash": "JJMJFE3U10OyOg55zOqQnGpM28EInGDd4ocMMpYSnCg=" } }, "is_incremental": false, @@ -1076,7 +1076,7 @@ "output": { ".html": { "relative_path": "index.html", - "hash": "arONXyny3QgSGGjRlj2FdKeCSeq75Z8dEbobnz7tpss=" + "hash": "oHE+wstPm/Fz0ced4JwDCZ85ehEu2a2f6hld0CY4MaY=" } }, "is_incremental": false,