Writing Code

Note

Make sure you have created a project. Once you have a project, you can start coding!

You should have a project that looks like this:

• .gitignore
• CHANGELOG.md
• Directory.Build.targets
• icon.png
• LICENSE
• README.md
• ResoniteMod.sln
• thunderstore.toml
• Directory.config/

  • dotnet-tools.json
• Directorysrc/

  • DirectoryResoniteMod/

    • Plugin.cs
    • ResoniteMod.csproj

Tip

The Plugin.cs file contains your code while the csproj files are for build configuration. You can look inside all of the files and look for comments that explain what everything does.

Open the project in your IDE of choice where the .sln file is, and then open the Plugin.cs file. It should look something like this:

Plugin.cs

using BepInEx;
using BepInEx.Logging;
using BepInEx.NET.Common;
using BepInExResoniteShim;

namespace ResoniteMod;

[ResonitePlugin(PluginMetadata.GUID, PluginMetadata.NAME, PluginMetadata.VERSION, PluginMetadata.AUTHORS, PluginMetadata.REPOSITORY_URL)]
[BepInDependency(BepInExResoniteShim.PluginMetadata.GUID, BepInDependency.DependencyFlags.HardDependency)]
public class Plugin : BasePlugin
{
    internal static new ManualLogSource? Log;

    public override void Load()
    {
        // Plugin startup logic
        Log = base.Log;
        Log.LogInfo($"Plugin {PluginMetadata.GUID} is loaded!");
    }
}

This is a very basic BepInEx 6 plugin.

Work in progress documentation, more will be added. For now, for more info, see BepInEx’s own documentation:

Creating a new plugin project—Plugin structure

You can also follow the links to learn more about each thing mentioned:

Logging: lethal.wiki

Custom Configs: lethal.wiki

Patching Code: lethal.wiki

For patching/hooking methods, you can use MonoMod or HarmonyX. See lethal.wiki for more in-depth introductions on using them.

Note

MonoDetour is also an option for hooking, but it’s in pre-release state and therefore is not fit for production usage yet. You can find its documentation at https://monodetour.github.io/

All of these libraries are compatible with each other as HarmonyX and MonoDetour simply use MonoMod.RuntimeDetour under the hood.

Writing Your First Patch

work in progress.

Publishing Your Mod Upload your mod for everyone to download!