Difference between revisions of "Modding:Migrate to Harmony 2.0"

From Stardew Valley Wiki
Jump to navigation Jump to search
(initial draft)
 
(+ best practices)
Line 4: Line 4:
  
 
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.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.
 +
 +
==Before you start==
 +
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.
  
 
==Basic changes==
 
==Basic changes==
Line 10: Line 13:
 
# Recompile the mod.
 
# Recompile the mod.
  
−
That's it! If you're using the [[Modding:Modder Guide/APIs/Harmony|recommended code API]], usage is otherwise 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 is otherwise identical. Harmony 2.0.0 adds a number of new features; see the [https://harmony.pardeike.net official documentation] for more info.
  
 
[[Category:Modding]]
 
[[Category:Modding]]

Revision as of 01:56, 26 January 2020

←Index

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; 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.

Before you start

Make sure you follow best practices outlined in the Harmony guide. In particular, use the EnableHarmony option (don't reference the Harmony DLL directly) and use the code API.

Basic changes

  1. Change using Harmony; to using HarmonyLib;.
  2. Change HarmonyInstance harmony = HarmonyInstance.Create("your mod id"); to Harmony harmony = new Harmony("your mod id");.
  3. Recompile the mod.

That's it! Otherwise usage is otherwise identical. Harmony 2.0.0 adds a number of new features; see the official documentation for more info.

Retrieved from "https://stardewvalleywiki.com/mediawiki/index.php?title=Modding:Migrate_to_Harmony_2.0&oldid=95503"