Notifications
Notification preferences
notifications_off

No unread notifications right now

You're up to date
View All

You're up to date

0 of 0

File information

Last updated

Original upload

Created by

toebeann

Uploaded by

toebeann

Virus scan

Safe to use

Tags for this mod

Current section

About this mod

BepInEx is a general purpose framework for Unity modding. This is a BepInEx pack for Subnautica, preconfigured and ready to use on Windows, macOS and Linux - including Steam Deck handhelds!

Requirements
Permissions and credits
Mirrors
Changelogs
Donations


Tobey's BepInEx Pack for Subnautica

This is a BepInEx pack for Subnautica, preconfigured and ready to use on Windows, macOS and Linux - including Steam Deck handhelds!

BepInEx is a general purpose modding 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 ready to use for Subnautica modding.
In particular, this pack comes with

  • Tobey.Subnautica.ConfigHandler, a configurable BepInEx patcher to automatically take care of BepInEx configuration for QModManager compatibility,
  • Tobey.UnityAudio, a configurable BepInEx patcher to automatically add Unity audio support when mods need it,
  • Tobey.FileTree, a configurable BepInEx plugin which logs the game's file tree to aid in troubleshooting issues, and
  • Tobey.BepInEx.Timestamp, a configurable BepInEx patcher which logs the current timestamp.


Compatibility with QModManager

The basic summary is that QModManager is compatible with BepInEx, but there are some things to bear in mind.

🛑 Caution

Do not install QModManager unless you are on the legacy branch, otherwise it will cause issues.

Easy Automated Installation

💬 Important

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

Check the file Subnautica > BepInEx > LogOuput.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 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 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 nofication 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, and has extra features you won't get if you install manually!

1. Download Tobey's BepInEx Pack for Subnautica from the Files tab. 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 and 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

Quick Start for Windows

Extract the archive 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.

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


Quick Start for Linux and Steam Deck handhelds

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

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.


Quick Start for macOS

It is strongly recommended that macOS users install with gib, as manual installation 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 this folder by right-clicking the game in their Steam library and selecting Manage > Browse local files.

1. Download Tobey's BepInEx Pack for Subnautica from the Files tab.

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 (e.g. double click it) and drag-and-drop the files and folders into the game folder!

If done correctly, inside your Subnautica 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
  • Subnautica_Data
  • doorstop_config.ini
  • Subnautica.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!

ℹ️ 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 Subnautica > 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 regenerated 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 section below.

💬 Important

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

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

Installing mods


Please see the Installing mods section of the README for a reference guide on how to install mods.




Useful links for mod authors


Issues, questions, etc.

First, please make sure to check that the answer you're looking for isn't already somewhere on this page. Use Ctrl+F to search for keywords.

Second, check the FAQ to see if there is an answer there.

If not, you can use the following channels to ask for help:


Licensing


The BepInEx pack available for download via this page contains binaries from the following projects, redistributed without modification and in accordance with their licenses: