BepInEx
BepInEx5.4.17 mod plugin framework, Mod framework
About this mod Machine translation
BepInEx Framework (Author: bbepis)
This is the pack of all the things you need to both start using mods, and start making mods using the BepInEx framework.
To install, refer to installation guide on R2Wiki.
What each folder is for:
BepInEx/plugins - This is where normal mods/plugins are placed to be loaded.
For developers: There's no set format for what you need to name your plugins to load; if they're a valid plugin.dll file, they'll be loaded.
However please be considerate and isolate your files in their own folders, to prevent clutter, confusion, and in general, dependency hell. For example: BepInEx/plugins/YourMod/Plugin.dll.
BepInEx/patchers - These are more advanced types of plugins that need to access Mono.Cecil to edit.dll files during runtime. Only copy paste your plugins here if the author tells you to.
For developers: More info here:
BepInEx/monomod - MonoMod patches get placed in here. Only copy paste your plugins here if the author tells you to.
BepInEx/config - If your plugin has support for configuration, you can find the config file here to edit it.
BepInEx/core - Core BepInEx.dll files, you'll usually never want to touch these files (unless you're updating)
BepInEx framework (Author: bbepis)
This is the framework necessary to load Mod plugins.
The installation is very simple, just put the BepInEx folder, doorstop_config.ini, and winhttp.dll into the root directory of the game.
What the frame contains:
BepInEx/plugins - Almost all Mod dlls need to be placed in this folder, unless otherwise specified by the Mod author.
Example: BepInEx/plugins/YourMod/Plugin.dll.
BepInEx/patchers - Some mods may use advanced functions such as Mono.Cecil. In this case, they need to be placed in this folder. You will only use them when the mod author specifically states.
If you are a mod author, you can find more information here:
BepInEx/config - If the Mod supports the use of configuration files, then the configuration file will be generated in this folder by default.
BepInEx/core - BepInEx's core dll folder, you will need to open this unless you need to update the framework in the future.
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.