Converting AtlyssModLoaders to BepInEx - Robocat999/AtlyssModLoader GitHub Wiki

Have an existing AtlyssModLoader Mod and need to convert it to BepInEx? These steps should cover the necessary bare minimum to accomplish this. See the BepInEx docs for a more detailed understanding of its ecosystem.

Reference Changes

  • Add using BepInEx; to the file start
    • Add a reference to BepInEx.dll. You can find this file in BepInEx\core after having installed BepInEx to Atlyss
  • Uninstall the Nuget version of Harmony
    • Add a reference to 0Harmony.dll. Same places as the last .dll
  • Add a reference to UnityEnginge.dll
    • Found in ATLYSS\ATLYSS_Data\Managed

Script Changes

  • Change Init() to Awake()
  • The main class and Awake() are no longer static
  • Extend the main class with BaseUnityPlugin. For example, public class MyModClass : BaseUnityPlugin
  • Add tag to main class header [BepInPlugin("GUID", "MOD_NAME", "VERSION FORMATTED LIKE 1.0.0.0")]
    • The "GUID" is that string you put into harmony. Something like "net.robocat999.ExampleMod" or "atlyss.mod.robocat999.ExampleMod"

Optional but recommended things

  • Add tag to main class header [BepInProcess("ATLYSS.exe")]
    • This limits the mod to only running on ATLYSS.