Skip to content

About

Windows toolkit for modding Unity games with BepInEx: install BepInEx, UnityExplorer and UniTweak, manage plugins (zip drag & drop, disable, profiles), browse game code (dump.cs) with Harmony snippets, create plugin projects, back up BepInEx. Mono and IL2CPP.

Topics

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

BepInEx Unity ModKit

CI License: MIT Platform: Windows 10/11

A Windows toolkit for modding Unity games with BepInEx. It installs BepInEx for you, keeps track of the plugins in each game, and, if you write plugins yourself, lets you look inside a game's code and generates a ready-to-build plugin project.

Plugin Management tab

What it does

Tab What it is for
Game Inspector Tells you what kind of game a folder is (Mono or IL2CPP, Unity version, 32/64-bit) and installs, updates or removes the matching BepInEx. One-click install of UnityExplorer and UniTweak.
dump.cs Browser Browse every class, method and field of a game and copy ready-made Harmony code. Can generate the dump.cs for you (IL2CPP through Il2CppDumper, Mono with a built-in reader).
Plugin Creator Creates a plugin project (.csproj, Plugin.cs, an example patch, a build-and-deploy script) with the right references for the game.
Game Library Finds the Unity games on your PC (Steam, Epic, GOG and your own folders), shows their BepInEx status, updates several at once, and backs up or restores a game's BepInEx.
Plugin Management Lists the plugins of a game. Add plugins by dragging in a .dll, folder or .zip; disable, enable and delete them; open their config; save and switch between profiles.

Everything has a built-in Help (the ? button or F1) that explains each tab in plain words, so you do not need to read this page to get started.

Download

Download the zip from the Releases page, unzip it anywhere and run BepInExUnityModKit.exe. It is a single self-contained file: no installer and no .NET installation needed. Requires Windows 10 or 11 (64-bit). The exe is also available on its own.

ModKit is not code-signed, so Windows SmartScreen may show a warning the first time ("More info", then "Run anyway"). Each release has a SHA256SUMS.txt to verify your download, and you can build the exe yourself from this repository (see below).

Quick start

Just want to use mods?

  1. Open Game Library and press Scan for games.
  2. Select your game and press Install / update BepInEx.
  3. Start the game once and close it again (IL2CPP games need a few minutes and an internet connection for this first start).
  4. Open Plugin Management, select the game and drag a plugin's .dll or .zip into the list.

Writing your own plugins? Generate a dump.cs in the dump.cs Browser, find the method you want to change and copy its Harmony prefix, then create a project in the Plugin Creator and paste the code in.

Status: developed and tested on Windows 11 with Steam games and custom game folders. GOG and Epic discovery follows those launchers' documented formats but has not been tried on real installs yet. If your game is not found, add its folder with "Add folder..." or "Add single game folder..." and please open an issue.

Screenshots

Game Library
Game Library: BepInEx status of every Unity game
Game Inspector
Game Inspector: detection, install, UnityExplorer and UniTweak
dump.cs Browser
dump.cs Browser: search a game's code, copy Harmony snippets
Plugin Creator
Plugin Creator: a ready-to-build project with the right references
Help window
Built-in Help with a page for every tab
Options
Options: accent color, RGB wave, update check

The games, paths and plugins in the screenshots are made up.

Safe by design

  • It asks first. Nothing is downloaded or written into a game folder without a confirmation that lists the files.
  • It can undo what it did. Every install is recorded in a manifest; uninstall removes exactly those files, restores anything it replaced and removes folders it created only if they are empty. It never deletes files it did not install. The one exception is the Delete button in Plugin Management, which moves a plugin to the Recycle Bin after you confirm.
  • Backups. The Game Library can zip a game's BepInEx state before an update and restore it later.
  • No telemetry, no account. ModKit talks only to GitHub and builds.bepinex.dev. When it starts, the Game Library asks for the latest BepInEx version (read-only) so it can show "Outdated". Downloads need your confirmation, and the check for newer ModKit releases is off unless you turn it on. Details: Network use and privacy.
  • Everything stays next to the exe. Settings, the game list, backups and dumps are stored beside BepInExUnityModKit.exe (or in %AppData%\BepInExUnityModKit if that folder is read-only). Delete them with the exe to remove ModKit.

Documentation

Build from source

You need Windows 10/11 and the .NET 8 SDK.

git clone https://github.com/crmbz0r/BepInExUnityModKit.git
cd BepInExUnityModKit
dotnet test
.\publish.ps1        # runs the tests, then writes the single-file exe to .\publish

You can also open ModKit.sln in Visual Studio 2022 (17.8 or newer, ".NET desktop development" workload).

Credits and licenses

ModKit is released under the MIT License. It uses Mono.Cecil and the .NET Community Toolkit (both MIT). It downloads, only on request, BepInEx, Il2CppDumper, UnityExplorer and UniTweak from their own repositories; they stay under their own licenses. See THIRD_PARTY_NOTICES.md.

Disclaimer

ModKit is an independent project and is not affiliated with Unity Technologies, BepInEx or any game publisher. Modding can break a game or violate its terms of service, especially in online games. Use it for single-player games, back up your saves, and use it at your own risk.

About

Windows toolkit for modding Unity games with BepInEx: install BepInEx, UnityExplorer and UniTweak, manage plugins (zip drag & drop, disable, profiles), browse game code (dump.cs) with Harmony snippets, create plugin projects, back up BepInEx. Mono and IL2CPP.

Topics

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages