Installing BepInEx - KryziK/sun-haven-modding GitHub Wiki
BepInEx can be installed manually by performing the following steps:
- At the time of writing, the ideal version of BepInEx is 5.4.22.
- Pick a version depending on your OS:
- Windows (x64): BepInEx_x64_5.4.22.0.zip
- Linux/MacOS: BepInEx_unix_5.4.22.0.zip
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:
Note: If you play Sun Haven on Steam, you can right click it in your Steam Library, "Manage" > "Browse local files".
- Simply run the game executable. This should generate BepInEx configuration file into
BepInEx/config
folder and an initial log file BepInEx/LogOutput.txt.
- First, Configure Steam to run BepInEx.
- Then, open the included run script
run_bepinex.sh
in a text editor of your choice. - Edit the line
executable_name="";
to be the name of the game executable.- On Linux, this is simply the name of the game executable.
- On macOS, this is the name of the game app with
.app
extension. For example:SunHaven.app
- Finally, open the terminal in the game folder and make the run_bepinex.sh script executable:
chmod u+x run_bepinex.sh
- You can now run BepInEx by executing the run script:
./run_bepinex.sh
- This should generate BepInEx configuration file into
BepInEx/config
folder and an initial log fileBepInEx/LogOutput.txt
.
- If you did step #3, exit the game after the first run.
- 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!
Mac-specific instructions, provided by Morthy, can be found here: