Installing BepInEx on Mono Unity

Important

Builds for this guide are only available via Bleeding Edge builds!

Download the correct version of BepInEx.

Download BepInEx from one of the available sources.
Pick a version depending on your OS:
- Windows
- Linux
- macOS
Download one of the following versions:
- Unity.Mono-win-x86 for games with 32-bit executables
- Unity.Mono-win-x64 for games with 64-bit executables
Download one of the following versions:
- Unity.Mono-linux-x86 for games with 32-bit executables
- Unity.Mono-linux-x64 for games with 64-bit executables
Download Unity.Mono-macos-x64. Only builds for 64-bit games are supported at the moment.
Extract the contents into the game root.

After you have downloaded the correct game version, extract the archive contents into the game folder.
- Windows
- Linux
- macOS
The game root folder is where the game executable is located.

On Linux, the game root folder is where the executable <Game>.x86 or <Game>.x86_64 is located.

On macOS, the root folder is where the game <Game>.app is located.
Do the first-time run to generate configuration files
- Windows
- Linux
- macOS
Run the game executable. This step should generate the BepInEx configuration file into the BepInEx/config folder and an initial log file BepInEx/LogOutput.txt.
Note

If you are modding a Steam game, you need to configure Steam to run BepInEx

First, open the included run script run_bepinex.sh in a text editor of your choice. Edit the line
```
executable_name="";
```
to be the name of the game executable. On Linux, this is simply the name of the game executable.

Finally, open the terminal in the game folder and make the run_bepinex.sh script executable:
```
chmod u+x run_bepinex.sh
```
You can now run BepInEx by executing the run script:
```
./run_bepinex.sh
```
This command should generate a BepInEx configuration file into the BepInEx/config folder and an initial log file BepInEx/LogOutput.txt.
Note

If you are modding a Steam game, you need to configure Steam to run BepInEx

First, open the included run script run_bepinex.sh in a text editor of your choice. Edit the line
```
executable_name="";
```
to be the name of the game executable. On macOS, this is the name of the game app with .app extension, for example, HuniePop.app.

Finally, open the terminal in the game folder and make the run_bepinex.sh script executable:
```
chmod u+x run_bepinex.sh
```
You can now run BepInEx by executing the run script:
```
./run_bepinex.sh
```
This command should generate a BepInEx configuration file into the BepInEx/config folder and an initial log file BepInEx/LogOutput.txt.
Configure BepInEx to suit your needs.

Open BepInEx/config/BepInEx.cfg in a text editor of your choice. All options are documented directly in the configuration file.

Additionally, refer to refer to the configuration guide for more information.