Skip to main content
The ChroMapper Plugin Template gets you from zero to a working ChroMapper plugin in minutes. It scaffolds a complete C# project pre-wired with HarmonyLib patching, all the necessary Unity engine references, and a post-build step that automatically copies your plugin DLL into ChroMapper’s Plugins directory.

Prerequisites

What you need before getting started: .NET SDK, ChroMapper, and environment setup

Quickstart

Install the template and create your first plugin in under five minutes

Harmony Patching

Learn how to patch ChroMapper methods at runtime using HarmonyLib

Reference

Template parameters, ChroMapper API attributes, and configuration options

​
What’s included

The template provides everything you need to start building immediately:

Plugin entry point

A ready-to-use Plugin.cs with [Plugin] and [Init] attributes correctly configured

HarmonyLib patching

HarmonyLib pre-referenced so you can start writing [HarmonyPatch] classes right away

Unity references

All common Unity engine modules referenced via ChroMapperDir — no manual DLL hunting

Auto-deploy on build

Post-build step copies your DLL directly into ChroMapper’s Plugins folder

​
How it works

1

Set ChroMapperDir

Point the ChroMapperDir environment variable at your ChroMapper installation directory
2

Install the template

Run dotnet new install to register the template with the .NET CLI
3

Scaffold your plugin

Run dotnet new chromapperplugin with your author name to create a new project
4

Build and play

Build the project — your plugin DLL is automatically copied to ChroMapper and ready to load

Build docs developers (and LLMs) love

Get started for freeTalk to us