MiniCozyRoomLoFiModding.BepInExTemplate 1.0.1

Mini Cozy Room: Lo-Fi BepInEx Template

• Mini Cozy Room: Lo-Fi BepInEx Template
  • Installing
    • From NuGet (Recommended)
    • Manually
  • Creating a Project
    • Project Structure
    • Setting Up The Config File
    • Thunderstore Packaging
    • GitHub Actions Publishing

This repository provides a dotnet new template tailored for Mini Cozy Room: Lo-Fi BepInEx plugin development.

Installing

.NET templates must be installed before they can be used. Installing the template adds it to dotnet new; it does not create a project by itself.

From NuGet (Recommended)

Run:

dotnet new install MiniCozyRoomLoFiModding.BepInExTemplate

Manually

If you are contributing to the template or prefer a local install:

1. Clone or download this repository.
2. Open a terminal at the repository root.
3. Run:

dotnet new install .

To update a locally installed copy:

dotnet new install . --force

To uninstall:

dotnet new uninstall .

Once installed, the template appears as Mini Cozy Room: Lo-Fi BepInEx Plugin with short name mcrlfmod.

Creating a Project

Open a terminal in your Mini Cozy Room: Lo-Fi modding workspace and run:

dotnet new mcrlfmod --output ModName --guid com.github.YourAccount.ModName --ts-team YourThunderstoreTeam

This creates a new directory containing your plugin project.

Project Structure

Example:

~/Workspace/MiniCozyRoomLoFi$ dotnet new mcrlfmod --output MyCoolMod --guid com.github.YourAccount.MyCoolMod --ts-team YourThunderstoreTeam
The template "Mini Cozy Room: Lo-Fi BepInEx Plugin" was created successfully.

~/Workspace/MiniCozyRoomLoFi$ cd MyCoolMod/
~/Workspace/MiniCozyRoomLoFi/MyCoolMod$ tree
.
├── CHANGELOG.md
├── Config.Build.user.props.template
├── Directory.Build.props
├── Directory.Build.targets
├── icon.png
├── LICENSE
├── MyCoolMod.slnx
├── README.md
└── src
    └── MyCoolMod
        ├── MyCoolMod.csproj
        ├── Plugin.cs
        └── thunderstore.toml

3 directories, 12 files

Your mod source files live in ./src/<project-name>/. Files above that level contain shared project configuration.

Setting Up The Config File

At the root of your generated project, copy Config.Build.user.props.template to Config.Build.user.props.

That file controls optional deployment to your local BepInEx plugins directory and the local game assembly references used for development.

If DeployModFilesEnabled stays true, make sure your configured plugins directory already exists, typically under your game's BepInEx/plugins/ folder.

You may still configure MiniCozyRoomLoFiPluginsDir separately if you want build output copied to a local BepInEx/plugins/ directory.

Thunderstore Packaging

This template includes Thunderstore packaging via TCLI.

Before publishing, review src/<project-name>/thunderstore.toml and replace placeholder values such as your package description, repository URL, and the Thunderstore community identifier if applicable.

The community slug for Mini Cozy Room: Lo-Fi is intentionally left as a placeholder in this repository because it has not been safely confirmed.

You can build a Thunderstore package by running:

dotnet build -c Release -v d

The built package will be placed in artifacts/thunderstore/.

You can also publish with TCLI by adding -property:PublishTS=true, once the Thunderstore metadata is configured correctly.

GitHub Actions Publishing

Coming soon.