CatsOnPeak
TODO: Fill in short mod description at max 250 characters.
About this mod Author’s original text
Cats On Peak
Adds a great cat!
Future features?
- Cat petting (make noise)
- Regional variations of the cat
- Cat ears on bingbong
- Cat floats magically
Development tips
Run peak on the secondary monitor
dotnet build
Template Instructions
You can remove this section after you've set up your project.
Next steps:
- Create a copy of the Config.Build.user.props.template file and name it Config.Build.user.props
- This will automate copying your plugin assembly to BepInEx/plugins/
- Configure the paths to point to your game path and your BepInEx/plugins/
- Game assembly references should work if the path to the game is valid
- Search TODO in the whole project to see what you should configure or modify
Packaging & Publishing
This template comes packaging built-in, using ThunderPipe.
You can build packages by building with release configuration:
dotnet build -c Release -v d
[!NOTE]
You can learn about different build options with dotnet build --help.
-c is short for --configuration and -v d is --verbosity detailed.
The built package will be found at./artifacts.
You can directly publish by including -p:PublishTS=true in the command. See the Config.Build.user.props.template file for configuration instructions.
[!TIP]
Make sure the local package looks fine in./artifacts/first, then publish with dotnet build -c Release -p:PublishTS=true -v d to avoid potential mistakes.
Install & use Install: BepInEx plugin
- The archive from playbuff is the mod itself — usually a BepInEx plugin (a .dll or a plugin folder once unzipped).
- Recommended: use a community mod manager (such as r2modman) — pick this game, import the mod, and the manager sets up BepInEx and its dependencies for you.
- Manual route: install the BepInEx loader in the game folder, then drop the unzipped .dll or plugin folder into BepInEx/plugins/.
- Launch the game — the BepInEx console logs every plugin it loads; seeing this mod in the log means it is installed.
Mods with listed dependencies need those installed too, or they will not load. Options are usually changed in-game or in the plugin's config file.
Install these first, or the mod will not work: