ImGuiOverlayPlugin

While the name might be symbol salad, the purpose is quite simple. This is a BepInEx plugin that provides Dear ImGui for your mods.

• Dear Imgui bindings for C# are provided by Hexa.NET
• Windowing and graphics are handled by SDL3 and OpenGL

Usage

• Compile and install the plugin
• Reference the plugin and Hexa.NET.ImGui dlls in your own plugins
• Provide ImGui code to run via the ImGuiPlugin.OnGuiRender delegate

Important

The overlay runs on a separate thread and will crash if you attempt to access Unity thread data. To access or run Unity code in your GUI, please do so through the UnityThreadDispatcher

Requirements

• BepInEx 6 (IL2CPP, Windows)
• .NET 6
• A Windows or Linux system (other platforms untested)
• You may need to add the BepInEx NuGet repository as a package source (use https://nuget.bepinex.dev/v3/index.json)

Compiling

1. Build the project for each target platform
2. Copy the native libraries from the output into the main build output folder, depending on the platfom(s) of your game
3. Copy the build output (the font/ folder and all DLLs) from the bin to a folder in your game's BepInEx/plugins folder