Installing BepInEx - KryziK/sun-haven-modding GitHub Wiki

Manually

BepInEx can be installed manually by performing the following steps:

1. Download the correct version of BepInEx.

2. Extract the contents into the game root folder.

After you have downloaded the correct version, extract the contents of the zip archive into the game folder (the folder that Sun Haven is installed in).

OS Location
Windows Where the Sun Haven.exe game executable is located.
This is likely %ProgramFiles(x86)%\Steam\steamapps\common\Sun Haven
Linux Where the executable <Game>.x86 or <Game>.x86_64 is located.
MacOS Where the game <Game>.app is located.

On Windows, your Sun Haven folder should look like this:

image

Note: If you play Sun Haven on Steam, you can right click it in your Steam Library, "Manage" > "Browse local files".

3. (Optional) Do a first run to generate configuration files.

Windows

  1. Simply run the game executable. This should generate BepInEx configuration file into BepInEx/config folder and an initial log file BepInEx/LogOutput.txt.

Linux/MacOS:

  1. First, Configure Steam to run BepInEx.
  2. Then, open the included run script run_bepinex.sh in a text editor of your choice.
  3. Edit the line executable_name=""; to be the name of the game executable.
    1. On Linux, this is simply the name of the game executable.
    2. On macOS, this is the name of the game app with .app extension. For example: SunHaven.app
  4. Finally, open the terminal in the game folder and make the run_bepinex.sh script executable: chmod u+x run_bepinex.sh
  5. You can now run BepInEx by executing the run script: ./run_bepinex.sh
  6. This should generate BepInEx configuration file into BepInEx/config folder and an initial log file BepInEx/LogOutput.txt.

4. Install desired mods.

  1. If you did step #3, exit the game after the first run.
  2. Download your desired mods, and extract their folder or DLL into BepInEx/plugins.

On Windows, here's a sample of what the Custom Textures mod might look like once installed properly.

Note that, on Windows, you can either have texture replacement files loose within the CustomTextures folder, or you can organize them into sub-folders. Note: Just make sure you don't have two texture files with the same name (meaning they would replace the same texture) or else they may conflict!

Good:

image

Bad:

image

Mac

Mac-specific instructions, provided by Morthy, can be found here:

https://docs.google.com/document/d/e/2PACX-1vS35RZEE9GSYzgCeNnZ1MhqS9wN_-LXwMBF48LIDQtjWl_aNC3y5qKa9UtjXwnlQDjSonvndUeXPp65/pub

Resources

⚠️ **GitHub.com Fallback** ⚠️