Jump to content

Mod Loader/CSharp APIs

From WikiName

These pages describe the C# APIs available to BepInEx plugins. A plugin needs a dependency on yuu.dressmaker.mods and a reference to DressmakerMods.dll. Check the linked page for its minimum Mod Loader version and any extra assemblies.

Choose what you need

To... Open
Add a tab with toggles, sliders, or actions in Mod Settings ModSettingsApi
Register fabrics or load a shader AssetBundle FabricModApi
Add garment pieces and tags with icons or sketches GarmentModApi
Add or hide rotating music tracks SoundtrackModApi
Change shop purchase sounds PurchaseSoundModApi
Add an in-game debug command DebugConsoleApi

If your mod only adds content, you probably don't need C#. Make a mod.json pack instead; the mod author's guide has starter packs for fabrics, accessories, garments, and stories.

Before you start

  • Keep pack and item IDs the same when you release updates. Saved dresses and inventories can refer to them.
  • Some APIs have to wait until a game controller is ready. Follow the timing notes on that API's page.
  • If an API gives you an IDisposable handle, keep it and dispose of it when your plugin unloads.
  • Test both game branches before listing support for both. A plugin that patches game code directly may need branch-specific work.
  • When something fails to register, check BepInEx/LogOutput.log.

The linked pages include the field lists, method names, and examples. Copies of the original text references are still included in ReferencesForModding in the release ZIP.

Back to the Mod Loader guide