IdleSlayerMods.Common 1.2.5-ML

Core library for idle slayer mods

Getting started

In order to get started, simply download the mod from Nexus or from Nuget, then include it as a reference in your plugin project.

Current features:

Mod Utils

Your unity components must be registered via this method before they are usable in your code. RegisterComponent() can be called at any point, but must be called at any point before accessing your component.

For example:

var obj = new GameObject();
obj.AddComponent<MyCustomBehaviour>();

This code will break. The code below will also break, as the component is registered AFTER the call to add it to a GameObject

var obj = new GameObject();
obj.AddComponent<MyCustomBehaviour>();

ModUtils.RegisterComponent<MyCustomBehaviour>();

So that leaves, of course, registering your component BEFORE adding it to a GameObject

ModUtils.RegisterComponent<MyCustomBehaviour>();

var obj = new GameObject();
obj.AddComponent<MyCustomBehaviour>();

Logger Extension

Mod Helper

Achievement Helper

BaseConfig:

Planned:

• Modded Achievement section in options
• Global list of modded achievements that can be appended to
• Simple UI button creation
• Custom random box events

Usage

The ModHelper class is currently only accessible in the Game scene of Idle Slayer.

In order to make use of the ModHelper behaviour object, you can either:

1. Make use of the ModHelperMounted event.
2. Find the injected GameObject and use GetComponent<ModHelper>().

Using the ModHelperMounted event (Method 1)

In your Plugin.cs, you'll need to add a static ModHelper variable. This is so that your MonoBehaviour classes will have access to the helper, via the Plugin class.

You then need to create a event delegate for the event handler which will return the ModHelper instance that exists in the game.

See example:

using IdleSlayerMods.Common;
public class Plugin : MelonMod
{
    internal static ModHelper ModHelperInstance;
    
    public override void OnInitializeMelon()
    {
        ModHelper.ModHelperMounted += SetModHelperInstance;
    }

    private static void SetModHelperInstance(ModHelper instance) => ModHelperInstance = instance;
}

To access within a MonoBehaviour script will then be as simple as:

using UnityEngine;
public class CustomBehaviour : MonoBehaviour
{
    void Start()
    {
        Plugin.ModHelperInstance.ShowNotification("Custom message!");
    }
}

The ModHelperMounted event happens in the Awake lifecycle, thus it is recommended to access the instance from Start() or any point after that to avoid potential race conditions.

Using BaseConfig

Using the base config simplifies mod settings creation.

See Using BaseConfig