Changes

'''This page is for modders. Players: see [[Modding:Mod compatibility]] instead.'''

'''This page is for modders. Players: see [[Modding:Mod compatibility]] instead.'''

This page explains how to update your mods for compatibility with Harmony 2.0.0. This only applies to mods which use Harmony directly; [[Modding:Modder Guide/APIs/Harmony|this is discouraged]] in most cases, isn't officially part of SMAPI's public API, and isn't subject to SMAPI's normal versioning policy.

This page explains how to update your mods for compatibility with Harmony 2.0. This only applies to mods which use Harmony directly; [[Modding:Modder Guide/APIs/Harmony|this is discouraged]] in most cases, isn't officially part of SMAPI's public API, and isn't subject to SMAPI's normal versioning policy.

__TOC__

__TOC__

==Before you start==

==What's new?==

Make sure you follow best practices outlined in the [[Modding:Modder Guide/APIs/Harmony|Harmony guide]]. In particular, use the <code>EnableHarmony</code> option (don't reference the Harmony DLL directly) and use the code API.

See the [https://github.com/pardeike/Harmony/releases/tag/v2.0.0 Harmony 2.0 release notes] and [https://harmony.pardeike.net Harmony 2.0 documentation] for more info.

==Basic changes==

==Migration steps==

# Change <code>using Harmony;</code> to <code>using HarmonyLib;</code>.

# Change <code>using Harmony;</code> to <code>using HarmonyLib;</code>.

# Change <code>HarmonyInstance harmony = HarmonyInstance.Create("your mod id");</code> to <code>Harmony harmony = new Harmony("your mod id");</code>.

# Change <code>HarmonyInstance harmony = HarmonyInstance.Create("your mod id");</code> to <code>Harmony harmony = new Harmony("your mod id");</code>.

# Recompile the mod.

# Recompile the mod.

That's it! Otherwise usage should be identical. Harmony 2.0.0 adds a number of new features; see the [https://harmony.pardeike.net official documentation] for more info.

That's it! Otherwise usage should be identical.

[[Category:Modding]]

[[Category:Modding]]