BepInExPack for Valheim

This is BepInEx 5.4.22 pack pre-configured for Valheim. It is maintained by Azumatt, Vapok, and Margmas in the Valheim community. If changes to the pack need to be made but BepInEx itself doesn't need to update typically we will increment the version for Thunderstore. Example: 5.4.2201, this does not mean that BepInEx itself needed to update, likely it's a small change for the game or something needed to change in the description etc.

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

• Added preconfigured BepInEx.cfg with console enabled.
• Added scripts necessary to run both game and dedicated server on Linux machines

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 (server, automated)

There are some managed dedicated server that support simple and automatic BepInEx installation.
Here is a list of known ones (list updated as more is known).
Note: Some of the links may be affiliate links

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

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

   

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

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

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

   ./start_game_bepinex.sh %command%
   

   Note to advanced users: You can change ./start_game_bepinex.sh to full path to the script. This way you can install this pack entirely outside of 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.

Configuration (Linux, server)

This guide assumes you have enough knowledge working with Linux.
If not, it is suggested you use a server host that supports it out of the box.

1. Make start_server_bepinex.sh executable with chmod u+x start_server_bepinex.sh.
2. Edit start_server_bepinex.sh to change the launch parameter like you would with Valheim's own launch script.
3. Run start_server_bepinex.sh to start the server.

If done correctly, you will see BepInEx bootstrap messages in the terminal.

Checking BepInEx version and load status

If BepInEx was loaded successfully into the game, you should see BepInEx version info in top left corner of the main menu:

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

• BepInEx Discord -- Only technical support for THIS PACKAGE. No support for plugins. Most likely your issue is caused by a game update that could make your mods (plugins) not function correctly. This can cause various issues not related to BepInEx. Please only join this discord if you are sure that your issue is related to the modding framework and not a recent game update or plugin update

List of Valheim Modding Discords

• Valheim Modding - General Valheim Modding
• Valheim Modding - Community for Mod Authors
• OdinPlus - Modding Community
• Jötunn, the Valheim Library - Modding API for Valheim

List of Author-Specific Discords

• Azumatt
• DefendYourBase/Hugo
• Horem
• Krumpac
• Lord_Hayze
• OrianaVenture
• RandyKnapp
• Therzie
• Vapok

Feel free to ask Azumatt, Vapok, or Margmas to add your own if you are a mod author

Changelog

5.4.2202

• ReadMe Updated to remove links to BepInEx Discord
• Preloader version incremented.
• Update made to Preloader to ensure assembly's are being patched correctly.
  • This should remove the warning message that shows when BepInEx starts.
• Modders: Unstripped Corlibs are still removed. If you are having issues with System depenencies, please include those dependencies directly into your project.

5.4.2201

• As of Valheim 0.217.24, There is no longer a need for the unstripped corlibs to be shipped with BepInEx.
  • This version removes the corlibs and instructs doorstop not to include them.
  • For modders, this is important, as you'll want to make sure you are referencing Unity from the Game Folder now.