11

Bootstrapping

Andreas Pardeike edited this page 2019-04-17 17:46:52 +02:00

Table of Contents

• Manual patching
• Checking for existing patches

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

To instantiate Harmony, you simply call

var harmony = HarmonyInstance.Create("com.company.project.product");

The id should be in reverse domain notation and must be unique. In order to understand and react on existing patches of others, all patches in Harmony are bound to that id.

This allows other authors to execute their patches before or after a specific patch by using the HarmonyBefore and HarmonyAfter annotations.

Once you have a Harmony instance, you can delegate the search for patch methods to Harmony by calling

harmony.PatchAll(Assembly.GetExecutingAssembly());

which will search the give assembly for all classes that are annotated with Harmony annotations. All patches are registered automatically and you're done.

Manual patching

For more control, you can patch like this:

var harmony = HarmonyInstance.Create("com.company.project.product");
var original = typeof(TheClass).GetMethod("TheMethod");
var prefix = typeof(MyPatchClass1).GetMethod("SomeMethod");
var postfix = typeof(MyPatchClass2).GetMethod("SomeMethod");
harmony.Patch(original, new HarmonyMethod(prefix), new HarmonyMethod(postfix));

Checking for existing patches

To get a list of already patched methods, you call

var harmony = HarmonyInstance.Create("com.company.project.product");

var methods = harmony.GetPatchedMethods();
foreach (var method in methods)
{
	//...
}

If you want to know if a specific method is already patched, you can call HarmonyInstance.GetPatchInfo(MethodInfo):

var harmony = HarmonyInstance.Create("com.company.project.product");

var original = typeof(TheClass).GetMethod("TheMethod");
var info = harmony.GetPatchInfo(original);
if (info == null) return; // not patched
foreach (var patch in info.Prefixes)
{
	Console.WriteLine("index: " + patch.index);
	Console.WriteLine("index: " + patch.owner);
	Console.WriteLine("index: " + patch.patch);
	Console.WriteLine("index: " + patch.priority);
	Console.WriteLine("index: " + patch.before);
	Console.WriteLine("index: " + patch.after);
}
foreach (var patch in info.Postfixes)
{
	//...
}
foreach (var patch in info.Transpilers)
{
	//...
}
// all owners shortcut
Console.WriteLine("all owners: " + info.Owners);

Next: Patching

Contents

1 Bootstrapping
2 Patching
3 Target method annotations
4 Execution flow
5 Priority annotations
6 Utilities