Give Feedback
0 of 0
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 SteamOS)!
- 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 SteamOS)!
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, and
- Tobey.FileTree, a configurable BepInEx plugin which logs the game's file tree to aid in troubleshooting issues.
Compatibility with QModManager
The TL;DR is that QModManager is compatible with BepInEx, but there are some things to bear in mind.
General FAQ
There is an FAQ in the stickies of the Posts tab.
Easy Automated Installation
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. If everything runs correctly, you will see the BepInEx console pop up on your desktop.
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 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 (⌘ Space, type terminal).
3. Copy the command from 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
ℹ️ macOS users should follow the idiot's guide to macOS installation.
⚠️ IMPORTANT NOTE ⚠️
If you later install QModManager, please make sure to choose NOT to overwrite any files when you do.
This is because QModManager overwrites this pack's files with an old version of BepInEx, and many BepInEx plugins require the latest version. QModManager is compatible with this pack's version of BepInEx.
If you do overwrite files when you install QModManager, you will need to reinstall this pack for some BepInEx plugins to work.
To install manually, follow these instructions:
1. Download Tobey's BepInEx Pack for Subnautica from the Files tab.
2. Extract the contents of the downloaded archive into the game folder:
- On Windows and Linux (SteamOS etc.), the game folder is the folder containing the game executable Subnautica.exe
- On macOS, the game folder is the folder containing the game executable Subnautica.app
3. Depending on your operating system:
- Windows users: Run the game. If everything runs correctly, you will see the BepInEx console pop up on your desktop.
- Linux (SteamOS etc.) & macOS users: Follow the configuration instructions for your operating system below:
Configuration on Linux (SteamOS etc.)
1. In Steam, go to the game's properties and set the launch arguments to:
WINEDLLOVERRIDES="winhttp=n,b" %command%2. Run the game via Steam
Configuration on macOS
Follow the idiot's guide to macOS installation.
Useful links
- BepInEx: writing basic plugin walkthrough
- BepInEx: useful plugins for modding
- BepInEx: patching game methods at runtime
Issues, questions, etc.
First, check the FAQ in the stickies of the Posts tab to see if there is an answer to your question/issue.
If not, at this moment, you can use the following channels to ask for help
- Subnautica Modding Community Discord
- BepInEx Discord -- Only technical support for THIS PACKAGE. No support for plugins.