Installation

⚠️ DOCS ARE MOVING ⚠️
These docs are for BepInEx 4 and thus might be out-of-date!
Documentation is currently being updated for BepInEx 5.
For the latest documentation, refer to the new BepInEx docs page.

About BepInEx

BepInEx is a framework for Unity games running on Mono. BepInEx provides means of patching the game's assemblies and loading plugins via custom MonoBehaviours.

Requirements

BepInEx requires a game using Unity that uses Mono runtime (i.e. has mono.dll). BepInEx has been successfully tested to be working on Unity versions 5.4 - 2017.2.

Upgrading from previous versions

For upgrading guide, refer to the migration guide.

Installation

1. Download the latest BepInEx from releases page.
2. Extract the contents of the archive into the game's root folder
3. If the game's executable is 32-bit version, replace winhttp.dll with the one in x86 folder.
4. Run the game once to let BepInEx create configuration files and folders
5. Install plug-ins and patchers into BepInEx folder
6. Configure BepInEx with BepInEx/config.ini