BepInExPack for Enter the Gungeon

This is BepInEx 5.4.21 pack for Enter the Gungeon.

BepInEx is a general purpose framework for Unity modding. BepInEx includes tools and libraries to

• load custom code (hereafter plugins) into the game on launch;
• patch in-game methods, classes and even entire assemblies without touching original game files;
• configure plugins and log game to desired outputs like console or file;
• manage plugin dependencies.

BepInEx is currently one of the most popular modding tools for Unity on GitHub.

This pack's contents

This pack is preconfigured and usable for Enter the Gungeon modding.
In particular, the changes from base BepInEx releases are:

• Added preconfigured BepInEx.cfg with console enabled.
• Added BepInEx.MonoMod.Loader
• Added scripts necessary to run the game on macOS, Linux and Windows (both 32bit and 64bit)

Installation (game, automated)

This is the recommended way to install BepInEx on the game.

1. Download and install Thunderstore Mod Manager or r2modman
2. Click Install with Mod Manager button on top of the page
3. Run the game via the mod manager

Installation (manual)

If you are installing this manually, do the following

1. Extract the archive into a folder. Do not extract into the game folder.
2. Move the contents of BepInExPack_EtG folder into <Steam Location>\steamapps\common\EtG.
3. Follow either Windows or Unix game running instructions below:

Configuration (Windows)

No need to configure. Simply run the game. If everything is correct, you will see a console pop up.

Configuration (Linux and macOS)

1. Make start_game_bepinex.sh executable with chmod u+x start_game_bepinex.sh.

2. In Steam, go to the game's properties and set the launch arguments to

   ./start_game_bepinex.sh %command%
   

   Note to advanced users: You can use the full path to the script instead. This way, you can install this pack entirely outside of the game folder.

3. Run the game via Steam.

At this moment, you will not see any clear indication if BepInEx works. It is suggested to test by installing a simple plugin such as MessageCenter from BepInEx.Utility.

Checking BepInEx version and load status

If BepInEx was loaded successfully into the game, you should see BepInEx console open when the game launches (Windows only).

Useful links

• BepInEx: writing basic plugin walkthrough
• BepInEx: useful plugins for modding
• BepInEx: patching game methods at runtime

Issues, questions, etc.

At this moment, you can use the following channels to ask for help

• Enter the Gungeon Modding Discord
• BepInEx Discord -- Only technical support for THIS PACKAGE. No support for plugins.

Changelog

5.4.2101

• Fixed argument parsing for Linux script

5.4.2100

• Initial version