Tobey's BepInEx Pack for Subnautica: Below Zero

This is a BepInEx pack for Subnautica: Below Zero, preconfigured and ready to use on Windows, macOS and Linux (including SteamOS)!

In particular, this pack comes with:

• Tobey's Subnautica Config Handler, a configurable BepInEx patcher to automatically configure BepInEx for backwards compatibility with legacy mods (e.g. QModManager),
• Tobey's Unity Audio Patcher for BepInEx, a configurable BepInEx patcher to automatically add Unity audio support,
• Tobey's Game Info Logger for BepInEx, a simple BepInEx plugin to log information about the currently loaded Unity game,
• Tobey's File Tree Logger for BepInEx, a configurable BepInEx plugin which logs the file tree to aid in troubleshooting,
• Tobey's Timestamp Logger for BepInEx, a configurable BepInEx patcher which logs the current timestamp, and
• Tobey's macOS Process Fix for Subnautica: Below Zero, a BepInEx patcher which allows BepInEx plugins with the process filter SubnauticaZero to load on macOS.

Compatibility with QModManager

The TL;DR is that QModManager is compatibile with BepInEx, but there are some things to bear in mind.

Easy Automated Installation

[!IMPORTANT]

With just this pack installed, you will not see any changes in-game!

Check the file BepInEx > LogOutput.log to determine whether BepInEx has loaded.

Windows (Vortex)

Vortex is a tool for installing and managing mods on Windows. It can install all kinds of mods for Subnautica: Below Zero and other games, including this pack.

1. Install Vortex Mod Manager if you haven't already. Make sure it's fully up-to-date.
2. Click the Vortex button at the top of the Nexus Mods mod page to install.
3. Check the 🔔 notifications area at the top right of Vortex:
   • If you have QModManager installed, Vortex might notify you to reinstall/uninstall QModManager. Just do whatever it says.
   • If you see a notification saying "Elevation needed to deploy," click Elevate and authorize the elevation.
   • If you see any other notifications saying "Deployment needed" or similar, click Deploy.
4. Run the game.

macOS (gib)

gib is a command-line tool which automates installation of BepInEx on macOS, as installing it manually is quite cumbersome and error-prone. gib makes it easy.

1. Download Tobey's BepInEx Pack for Subnautica: Below Zero. Make sure to unzip it in your Downloads folder if your browser doesn't do this automatically.
2. Open Terminal with Launchpad or Spotlight (press ⌘ Space, type terminal, press Enter).
3. Copy the command from the Usage section of the gib README and paste it into the Terminal with ⌘ V, and press Enter to run it.

If you get stuck, refer to the gib README for help.

Manual Installation

[!TIP]

Make sure to check out the Installing mods section once you have finished installing this pack!

[!TIP]

The game folder is the folder containing the game's executable (e.g. SubnauticaZero.exe).

Steam users can find the game folder by right-clicking the game in their Steam library and selecting Manage > Browse local files.

Quick start

Windows

Extract the .zip into the game folder replacing any files if prompted, run the game once to generate all needed files and folders, then quit the game at the main menu and you're good to go. Remember to check the Installing mods section for info on how to install mods!

If something doesn't go according to plan or you need further guidance, please refer to the full instructions. Don't worry, it looks harder than it is. Please don't skimread!

Linux and Steam Deck handhelds

Same as for Windows but additionally follow step 4 from the full instructions.

For Steam Deck handhelds, switch to Desktop mode to follow the instructions. Once you've got it all working, you'll be able to play with mods in either Desktop or Gaming mode as preferred.

macOS

It is strongly recommended that macOS users install with gib, as manual installation on macOS is extremely tedious and error prone!

If you are a glutton for punishment and are determined to install manually, follow the idiot's guide to macOS installation.

Full instructions for Windows, Linux and Steam Deck handhelds

[!TIP]

The game folder is the folder containing the game's executable (e.g. Subnautica.exe).

Steam users can find the game folder by right-clicking the game in their Steam library and selecting Manage > Browse local files.

To install manually, follow these instructions:

1. Download Tobey's BepInEx Pack for Subnautica: Below Zero.

2. Make sure the game is not running.

3. Extract the contents of the downloaded archive into the game folder. Replace any files if prompted.

   ℹ️ That just means open the .zip file and drag the files and folders out into the game folder!

   If done correctly, inside your game folder it should look something like this (the entries in bold being from the pack):

   ⚠️ This list is used as a reference and is non-exhaustive, there will be other stuff, please don't delete anything!

   • BepInEx
   • SubnauticaZero_Data
   • doorstop_config.ini
   • SubnauticaZero.exe
   • winhttp.dll

   ⚠️ If you are missing any of these files or folders, you are probably installing to the wrong place, and this pack will not work.

4. Skip this step if you play on Windows!

   Linux and Steam Deck handheld users: go to your Steam library, right-click the game, select Properties... and set the launch options:

   WINEDLLOVERRIDES="winhttp=n,b" %command%
   

   ⚠️ Do not set the launch options if you play the game on Windows, or the game won't run!

   ℹ️ If preferred, Linux users can instead set the Wine configuration (winecfg) for the game to add winhttp as a DLL override via the Libraries tab. Remove the launch options if applicable. Full instructions here.

5. Run the game as normal.

   Note that if you own the game on Steam, you should always launch it with Steam - do not run the .exe file directly (nor via a shortcut to the .exe), as launching the .exe directly causes issues for BepInEx. You can set up a BepInEx-compatible shortcut on your desktop by right-clicking the game in Steam and selecting Manage > Add desktop shortcut.

   The same may apply to other platforms, e.g. Epic Games Launcher, Microsoft Store, etc.

   Launching the game with Vortex should be fine too.

6. Exit the game at the main menu.

Assuming you have followed these instructions correctly, inside the BepInEx folder there will now be a file LogOutput.log (or simply LogOutput - it's the same thing). This is your log file, and it will be egenerated every time the game runs with technical and diagnostic information about your installed mods, and any errors that might happen while playing. It's very useful for troubleshooting, and it is recommended to share it whenever asking for help with your mods. It is equivalent to the BepInEx console window you might be familiar with, containing all of the same information.

If this file is missing, it usually means that you have not installed the pack correctly and you should probably try again from scratch. Make sure to pay careful attention to the instructions and don't skimread any of the steps.

Otherwise, you can now install mods according to the Installing mods section below.

[!IMPORTANT]

With just this pack installed, you will not see any changes in-game!

Check the file BepInEx > LogOutput.log to determine whether BepInEx has loaded.

Installing mods

[!IMPORTANT]

Always make sure the game is not running when installing, removing or otherwise changing mod files!

[!NOTE]

The paths in this section are relative to the game folder, i.e. BepInEx/plugins = [game folder]/BepInEx/plugins, where [game folder] is the path to the folder containing the game's executable (e.g. SubnauticaZero.exe).

Steam users can find the game folder by right-clicking the game in their Steam library and selecting Manage -> Browse local files.

[!TIP]

"Extract the .zip" simply means take the contents of the .zip file and put them in the specified location.

For example, if you are told to "extract the .zip" or "extract the contents of the archive" into BepInEx/plugins, then you can simply open the .zip archive by double-clicking on it, then just select everything inside and drag the contents into your BepInEx/plugins folder. Easy!

[!CAUTION]

Nautilus and SMLHelper are inco