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 Thunderstore.
• Optional MimicAPI integration pre-wired but disabled - uncomment to enable.

Requirements

Installation

• Recommended: install via a Thunderstore 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.

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:

https://github.com/DooDesch-Mods/Mimesis-Boilerplate

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.

Changelog

Version 1.1.1

• fix(compat): support mimesis 0.3.2 in 1.1.1 (d13a5c0)
• ci: build on every push and pull request, in both configurations (#5) (52f82f3)
• chore: move onto the shared build layer, take the version from the tag (#4) (33c20d0)
• fix(ci): read NEXUS_MOD_ID from vars in the Discord embed (3caafcd)
• ci: link Nexus in the Discord release embed (#3) (a894cad)
• ci: post a real embed to the Discord feed on release (#2) (c51cc66)
• ci: let GitHub generate the release notes under ours (#1) (576d695)
• docs: point support link to the per-product page (10b0f44)
• docs: point support link to the per-product page (9dfae5f)
• Remove redundant HarmonyInstance.PatchAll() (MelonLoader auto-patches; avoids double-apply) (6853ef7)
• docs: add support link (support.doodesch.de) to README (dd83171)
• docs: add support link (support.doodesch.de) to README (b5912a1)
• docs: rewrite README to the June 2026 standard (UTF-8, accurate config/deps, current badges) (8894365)
• Revise README.md to improve structure and clarity, adding a Table of Contents, enhancing setup instructions, and detailing software requirements for mod development. (702a727)
• Update icon.png to improve visual representation in Thunderstore (c8f2f41)
• Update README.md and setup_mod.sh to enhance mod setup instructions, including removal of original Git metadata and optional Git re-initialization steps. (215ef6b)
• Enhance README.md and add setup_mod.sh script for streamlined mod setup process, including automatic renaming and configuration updates. (3d0e77a)
• Refactor README.md for improved formatting and clarity in instructions for SSH key and Thunderstore API token setup (349de5e)
• Update README.md with detailed instructions for obtaining Thunderstore API token and link to upload guide (d401b49)
• Update README.md with correct Mimesis app link and add MelonLoader requirement (7a7cc7a)
• Add MIT License file and update copyright year in existing LICENSE.md (799a0a6)
• Initial commit of Boilerplate mod template including project structure, configuration, and GitHub Actions workflow for automated builds and releases. (c6e0a5e)
• first commit (f833f7c)