BepInExPack for Peglin

This is BepInEx 5.4.19 pack for Peglin.

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 Peglin modding.
In particular, the changes from base BepInEx releases are:

• Added preconfigured BepInEx.cfg with console enabled.
• Updated Doorstop configuration and BepInEx to open the console.
• Included libraries for running the game on macOS.

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_Peglin folder into <Steam Location>\steamapps\common\Peglin.

3. Check that you have installed it correctly. If done correctly, your folder will look as follows

   

4. Follow either Windows or macOS 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 (macOS, game)

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

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

   <pwd>/run_bepinex.sh %command%
   

   Where <pwd> is the path to the game's .app

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.

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

• Peglin Modding Discord
• BepInEx Discord -- Only technical support for THIS PACKAGE. No support for plugins.

Changelog

5.4.2100

• Updated BepInEx to 5.4.21

5.4.1901

• Added dependency on PeglinCore package

5.4.1900

• Initial release with BepInEx 5.4.19 (changelog)