<aside> 💡 Please ensure you read ‘Setup your environment’ and ‘Build and test your mod’ before reading this.

</aside>

This page give you a starter to write mods if you are not familiar with modding and BepInEx, as well as give basic tips for Cult of the Lamb modding.

The starting plugin

When you create your mod, you should start with something like that :

using BepInEx;

namespace MyFirstPlugin
{

    [BepInPlugin(PluginInfo.PLUGIN_GUID, PluginInfo.PLUGIN_NAME, PluginInfo.PLUGIN_VERSION)]
    public class Plugin : BaseUnityPlugin
    {
        private void Awake()
        {
            // Plugin startup logic
            Logger.LogInfo($"Plugin {PluginInfo.PLUGIN_GUID} is loaded!");
        }
    }

}

Let’s see this in details :

The metadata

[BepInPlugin(PluginInfo.PLUGIN_GUID, PluginInfo.PLUGIN_NAME, PluginInfo.PLUGIN_VERSION)]

Those are the metadata of the game.

• PLUGIN_GUID is the GUID (Globally Unique IDentifier) of your mod, you create it at start and never change it after. It should also be unique and not conflict with any other mod GUID.
• PLUGIN_NAME is the display name of your mod
• PLUGIN_VERSION is the version of the mod. Please follow semver format (basically MAJOR.MINOR.PATCH)

Access ‘PluginInfo’ to modify them :

namespace MyFirstPlugin
{
    public static class PluginInfo
    {
        public const string PLUGIN_GUID = "MyFirstPlugin";
        public const string PLUGIN_NAME = "MyFirstPlugin";
        public const string PLUGIN_VERSION = "1.0.0";
    }
}