Adds support for Subnautica to Vortex, enabling you to easily automate installation of mods for Subnautica without having to worry about where the files are supposed to go, etc.
Other user's assetsAll the assets in this file belong to the author, or are from free-to-use modder's resources
Upload permissionYou are not allowed to upload this file to other sites under any circumstances
Modification permissionYou must get permission from me before you are allowed to modify my files to improve it
Conversion permissionYou are not allowed to convert this file to work on other games under any circumstances
Asset use permissionYou must get permission from me before you are allowed to use any of the assets in this file
Asset use permission in mods/files that are being soldYou are not allowed to use assets from this file in any mods/files that are being sold, for money, on Steam Workshop or other platforms
Asset use permission in mods/files that earn donation pointsYou are not allowed to earn Donation Points for your mods if they use my assets
Author notes
This author has not provided any additional notes regarding file permissions
File credits
This author has not credited anyone else in this file
Donation Points system
Please log in to find out whether this mod is receiving Donation Points
Changed: Reduce disk footprint of BepInEx.AssemblyInspection.Console.exe binary
Fixed: Improve detection of whether QModManager is currently enabled with Vortex
Full changelog available at: https://github.com/toebeann/subnautica-support/releases/tag/v3.3.3
Version 3.3.2
Changed: Filter out the QModManager manifest file (mod.json) when installing a hybrid QMod\BepInEx plugin as a BepInEx plugin
Full changelog available at: https://github.com/toebeann/subnautica-support/releases/tag/v3.3.2
Version 3.3.1
Users affected by an issue where QModManager and some QMods were not being installed correctly should reinstall QModManager and the affected QMods.
Fixed: Fix QModManager not installing correctly
Fixed: Resolve issue where QMod archives which include a "QMods" folder result in nested "QMods" folders when installed
Full changelog available at: https://github.com/toebeann/subnautica-support/releases/tag/v3.3.1
Version 3.3.0
Changed: Change license from LGPL-3.0 to GPL-3.0
Changed: Only notify user to install QModManager on the legacy branch if user has at least one QMod enabled
Changed: Offer to reinstall the BepInEx pack when necessary rather than just notifying the user that it needs to be reinstalled
Changed: Offer to reinstall QModManager when necessary rather than just notifying the user that it needs to be reinstalled
Added: Offer to enable the BepInEx pack when it is detected as disabled
Added: Offer to enable QModManager on the legacy branch when it is detected as disabled and the user has at least one QMod enabled
Added: Offer to disable QModManager when not on the legacy branch
Added: Add a changelog GUI to automatically let users know about updates
Removed: Drop support for Vortex versions older than 1.8.0
Fixed: Correct handling of `BepInEx.cfg` on legacy branch for BepInEx packs without an included `BepInEx.legacy.cfg`
Fixed: Stop notifying users to reinstall BepInEx pack when changing to/from the legacy branch if reinstalling it would not update the `BepInEx.cfg` file
Full changelog available at: https://github.com/toebeann/subnautica-support/releases/tag/v3.3.0
Version 3.2.8
Maintenance: Improvement to logic around usage of BepInEx.AssemblyInspection.Console
Maintenance: Output of BepInEx.AssemblyInspection.Console will now be validated with zod (https://github.com/colinhacks/zod)
Full changelog available at: https://github.com/toebeann/subnautica-support/releases/tag/v3.2.8
Version 3.2.7
Resolves an issue where in some rare cases, CustomHullPlates and CustomPosters packs would not be installed. Users affected by this issue should retry installing affected CustomHullPlates and CustomPosters packs after updating the extension.
Full changelog available at: https://github.com/toebeann/subnautica-support/releases/tag/v3.2.7
Version 3.2.6
Resolves an issue where CustomPosters and CustomHullPlates packs were not being installed correctly. Users affected by this issue should reinstall their CustomPosters and CustomHullPlates packs after updating the extension.
Full changelog available at: https://github.com/toebeann/subnautica-support/releases/tag/v3.2.6
Version 3.2.5
Resolves an issue where changing gamemode away from Subnautica would cause an Illegal invocation error to be reported by Vortex.
Full changelog available at: https://github.com/toebeann/subnautica-support/releases/tag/v3.2.5
Version 3.2.4
Fixes an issue where new installations of the extension appear as incompatible in Vortex.
Version 3.2.3
Resolves an issue where some old QModManager mods require 0Harmony109.dll or 0Harmony12.dll from QModManager, but it was not getting installed. Users affected by this issue will simply need to reinstall QModManager after updating the extension.
Version 3.2.2
Will assume the user is on the stable branch if the Steam app manifest cannot be read for any reason.
Version 3.2.1
Fixes an issue where in some cases Steam users would receive an error "Cannot read properties of undefined (reading 'BetaKey')" when attempting to discern their branch.
Version 3.2.0
Will now handle mods which can be installed either as BepInEx plugins or QMods appropriately, i.e. when on legacy branch, install as QMod, else install as BepInEx plugin.
Version 3.1.0
Improvements to QMM/BepInEx handling.
New installations of QModManager will be treated as a BepInEx plugin/patcher mod, i.e. QMM will not override BepInEx core files, and BepInEx will need to be installed separately.
Will automatically handle configuring the BepInEx.cfg for QMM compatibility when the user is on the legacy branch.
User will now be notified to reinstall BepInEx when changing to/from the legacy branch to ensure the BepInEx.cfg is set correctly.
When installing BepInEx on top of an existing version of QMM which came packaged with BepInEx, will now notify the user to reinstall QMM to address file conflicts.
Dialog and notification wording has been revamped.
The dialog warning you about QMM being installed on the stable branch has now been changed to a notification so as not to be completely obnoxious.
Dropped chokidar in favour of native node fs.watch for determining when the Steam branch has changed.
Version 3.0.0
Added support for the Subnautica 2.0 Living Large update.
Version 2.2.2
Reverted changes made in previous versions 2.2 and 2.2.1.
This extension adds support for Subnautica to Vortex Mod Manager, enabling you to easily automate installation of mods for Subnautica without having to worry about where the files are supposed to go, etc.
At this time, the following mod types are supported:
BepInEx Pack for Subnautica
BepInEx plugins
BepInEx patchers
QModManager
QMods
CustomCraft2 plugin packs
CustomHullPlates addon packs
CustomPosters addon packs
If you are developing a different kind of mod and would like it to be supported by this extension, please raise an issue or pull request on the GitHub repository with a link to your mod page so that I can take a look at how you are packaging it. Please make sure to include instructions for how you would expect it to be installed, so that I can have Vortex automate the process. PRs welcome!
How to install
This extension requires Vortex ^1.9.0. To install, click the Vortex button at the top of the page to open this extension within Vortex, and then click Install. Alternatively, within Vortex, go to the Extensions tab, click "Find More" at the bottom of the tab, search for "Subnautica Support" and then click Install.
You can also manually install it by downloading the main file and dragging it into the "drop zone" labelled "Drop File(s)" in the Extensions tab at the bottom right.
Afterwards, restart Vortex and you can begin installing supported Subnautica mods with Vortex.
The rest of this page is intended for mod authors only. Users can simply follow the instructions above to install, and you're done!
How to make my mod compatible with this extension?
Assuming your mod is of a supported type, simply follow the packaging examples for that mod type below.
Don't forget to set your latest main file as your main Vortex file, and make sure that the "Remove the 'Download with Manager' button" option is unticked!
If your mod is not of a supported type, you will need to raise an issue or pull request on the GitHub repository with a link to your mod page so that I can take a look at how you are packaging it. Please make sure to include instructions for how you would expect it to be installed.
Packaging examples
BepInEx plugins
Any of the following structures are valid:
- MyBepInExPlugin.dll
- My BepInEx Plugin - MyBepInExPlugin.dll
- plugins - MyBepInExPlugin.dll
- plugins - My BepInEx Plugin - MyBepInExPlugin.dll
- BepInEx - plugins - MyBepInExPlugin.dll
- BepInEx - plugins - My BepInEx Plugin - MyBepInExPlugin.dll
BepInEx patchers
Any of the following structures are valid:
- patchers - MyBepInExPatcher.dll
- patchers - My BepInEx Patcher - MyBepInExPatcher.dll
- BepInEx - patchers - MyBepInExPatcher.dll
- BepInEx - patchers - My BepInEx Patcher - MyBepInExPatcher.dll
- BepInEx - patchers - My Mod Name - MyBepInExPatcher.dll - plugins - My Mod Name - MyBepInExPlugin.dll
QMods
Any of the following structures are valid:
- My QMod - mod.json - MyQMod.dll
- QMods - My QMod - mod.json - MyQMod.dll
- mod.json - MyQMod.dll
Mods which can be installed as either a QMod or a BepInEx plugin
Mods which meet all of the following criteria are eligible to be installed as either a QMod or a BepInEx plugin:
has a mod.json manifest for QModManager
has an assembly containing a BaseUnityPlugin class with a BepInPlugin attribute applied to it
has the following structure: - My Mod - mod.json - MyMod.dll
When a user installs an eligible mod, if the user is on the legacy branch it will be installed as a QMod. Otherwise, it will be installed as a BepInEx plugin.
CustomCraft2 plugin packs
Any of the following structures are valid. Note that although these examples only include a single asset and/or working file each, the extension will happily install packs containing multiple of each.
Any of the following structures are valid. Note that although these examples only include a single hull plate, the extension will happily install packs containing multiple hull plates.
Any of the following structures are valid. Note that although these examples only include a single poster, the extension will happily install packs containing multiple posters.
Any of the following structures are valid. Note that although these examples only include a single hull plate and poster each, the extension will happily install packs containing multiple of each.
If you have followed the packaging examples above and your mod is still being incorrectly installed by this extension, please raise an issue on the GitHub repository with a link to your mod page or with a sample archive attached so that I can get it fixed.