Boilerplate
A boilerplate template for Mimesis mods. Replace this with your mod description.
About this mod Author’s original text
MIMESIS - Boilerplate
🛟 Need help or found a bug? Get support at support.doodesch.de/boilerplate.
A starter template for building MelonLoader mods for MIMESIS. Clone it, rename it, and you have a ready-to-build mod skeleton that matches the project conventions.
This is a developer template, not a player-facing feature mod. Installing it does nothing in game - it only logs that it initialized. If you are a player, there is nothing to configure here. If you are a modder, use it as the starting point for a new Mimesis mod.
Features
- Minimal MelonMod entry point that initializes preferences - no game behavior is patched.
- MelonPreferences config scaffold demonstrating the standard preferences pattern.
- A Harmony patch stub showing the Prefix/Postfix pattern, with the patch body commented out.
- A one-command setup script that renames the project to your mod name and removes the template Git history.
- A GitHub Actions workflow that builds on a version tag and publishes to GitHub Releases and.
- Optional MimicAPI integration pre-wired but disabled - uncomment to enable.
Requirements
| Component | Version |
|---|---|
| MIMESIS | 0.3.2 |
| MelonLoader | 0.7.3+ |
Installation
- Recommended: install via a mod manager (r2modman or Gale).
- Manual: download the package, extract Boilerplate.dll into MIMESIS/Mods, and launch once to generate the config.
Configuration
Stored in UserData/MelonPreferences.cfg under the Boilerplate category.
| Option | Description | Default | Values/Range |
|---|---|---|---|
| Enabled | Enable Boilerplate functionality. When disabled, the mod will not modify game behavior. The template only logs this value. | true | boolean (true/false) |
Usage
There is no in-game usage and no keybinds. This is a developer template - it produces no visible effect in game.
For the full setup guide (rename script, build steps, GitHub Actions, and optional MimicAPI), see the repository:
Credits / License
Author: DooDesch. Licensed under the MIT License.
AI disclosure
The mod icon is AI-generated.
Built against MIMESIS 0.3.2 / MelonLoader 0.7.3.
Install & use Install: follow the bundled instructions
- Unzip the archive from playbuff and read the bundled readme / instructions first.
- Most mods rely on the game's mod loader — the usual route is a community mod manager (such as r2modman): pick this game, install, and it handles the loader and dependencies.
- For a manual install, put the mod files into the matching Mod / plugins folder inside the game directory.
- Launch the game to confirm it loaded; mods with listed dependencies need those installed as well.
Install locations vary a lot between mods — the bundled readme is the most reliable guide.
Install these first, or the mod will not work: