{"id":24583714,"url":"https://github.com/toebeann/subnautica-support","last_synced_at":"2025-03-17T17:15:36.953Z","repository":{"id":145444873,"uuid":"584923438","full_name":"toebeann/subnautica-support","owner":"toebeann","description":"Vortex support for Subnautica","archived":false,"fork":false,"pushed_at":"2024-02-27T14:53:01.000Z","size":519,"stargazers_count":4,"open_issues_count":5,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-24T04:48:06.498Z","etag":null,"topics":["mod-manager","modding","modding-tools","subnautica","vortex-extension"],"latest_commit_sha":null,"homepage":"https://www.nexusmods.com/site/mods/202","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/toebeann.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null},"funding":{"github":["toebeann"],"ko_fi":"toebean_","custom":["https://paypal.me/tobeyblaber"]}},"created_at":"2023-01-03T21:37:45.000Z","updated_at":"2024-06-22T12:23:36.000Z","dependencies_parsed_at":"2023-07-10T16:46:24.033Z","dependency_job_id":null,"html_url":"https://github.com/toebeann/subnautica-support","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toebeann%2Fsubnautica-support","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toebeann%2Fsubnautica-support/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toebeann%2Fsubnautica-support/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toebeann%2Fsubnautica-support/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/toebeann","download_url":"https://codeload.github.com/toebeann/subnautica-support/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244075638,"owners_count":20393979,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mod-manager","modding","modding-tools","subnautica","vortex-extension"],"created_at":"2025-01-24T04:48:34.824Z","updated_at":"2025-03-17T17:15:36.930Z","avatar_url":"https://github.com/toebeann.png","language":"TypeScript","funding_links":["https://github.com/sponsors/toebeann","https://ko-fi.com/toebean_","https://paypal.me/tobeyblaber"],"categories":[],"sub_categories":[],"readme":"# Subnautica Support for [Vortex]\n\n## Description\n\nThis 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.\n\nAt this time, the following mod types are supported:\n\n- BepInEx Pack for Subnautica\n- BepInEx plugins\n- BepInEx patchers\n- QModManager\n- QMods\n- CustomCraft2 plugin packs\n- CustomHullPlates addon packs\n- CustomPosters addon packs\n\nIf 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](https://github.com/toebeann/subnautica-support/issues) 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!\n\n## How to install\n\nThis extension requires [Vortex] ^1.9.0. To install, click the Vortex button at the top of [the Nexus Mods page](https://www.nexusmods.com/site/mods/202) 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`.\n\nYou 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.\n\nAfterwards, restart Vortex and you can begin installing supported Subnautica mods with Vortex.\n\n***\n\n**\u003ccenter\u003e\u003cbig\u003eThe rest of this page is intended for mod authors only.\u003cbr/\u003eUsers can simply follow the instructions above to install, and you're done!\u003c/big\u003e\u003c/center\u003e**\n\n\u003ccenter\u003e\u003ca href=\"https://ko-fi.com/toebean_\" target=\"_blank\"\u003e\u003cimg src=\"https://uploads-ssl.webflow.com/5c14e387dab576fe667689cf/61e11d503cc13747866d338b_Button-2-p-800.png\" alt=\"Support toebeann on Ko-fi\"/\u003e\u003c/a\u003e\u003c/center\u003e\n\n***\n\n## How to make my mod compatible with this extension?\n\nAssuming your mod is of a supported type, simply follow the packaging examples for that mod type below.\n\nDon'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!\n\nIf your mod is not of a supported type, you will need to [raise an issue or pull request on the GitHub repository](https://github.com/toebeann/subnautica-support/issues) 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.\n\n### Packaging examples\n\n#### BepInEx plugins\n\nAny of the following structures are valid:\n\n```\n- MyBepInExPlugin.dll\n```\n\n```\n- My BepInEx Plugin\n  - MyBepInExPlugin.dll\n```\n\n```\n- plugins\n  - MyBepInExPlugin.dll\n```\n\n```\n- plugins\n  - My BepInEx Plugin\n    - MyBepInExPlugin.dll\n```\n\n```\n- BepInEx\n  - plugins\n      - MyBepInExPlugin.dll\n```\n\n```\n- BepInEx\n  - plugins\n    - My BepInEx Plugin\n      - MyBepInExPlugin.dll\n```\n\n#### BepInEx patchers\n\nAny of the following structures are valid:\n\n```\n- patchers\n  - MyBepInExPatcher.dll\n```\n\n```\n- patchers\n  - My BepInEx Patcher\n    - MyBepInExPlugin.dll\n```\n\n```\n- BepInEx\n  - patchers\n      - MyBepInExPatcher.dll\n```\n\n```\n- BepInEx\n  - patchers\n    - My BepInEx Patcher\n      - MyBepInExPatcher.dll\n```\n\n#### BepInEx plugin/patcher combos\n\nAny of the following structures are valid:\n\n```\n- patchers\n  - MyBepInExPatcher.dll\n- plugins\n  - MyBepInExPlugin.dll\n```\n\n```\n- patchers\n  - My Mod Name\n    - MyBepInExPatcher.dll\n- plugins\n  - My Mod Name\n    - MyBepInExPlugin.dll\n```\n\n```\n- BepInEx\n  - patchers\n    - MyBepInExPatcher.dll\n  - plugins\n    - MyBepInExPlugin.dll\n```\n\n```\n- BepInEx\n  - patchers\n    - My Mod Name\n      - MyBepInExPatcher.dll\n  - plugins\n    - My Mod Name\n      - MyBepInExPlugin.dll\n```\n\n#### QMods\n\nAny of the following structures are valid:\n\n```\n- My QMod\n  - mod.json\n  - MyQMod.dll\n```\n\n```\n- QMods\n  - My QMod\n    - mod.json\n    - MyQMod.dll\n```\n\n```\n- mod.json\n- MyQMod.dll\n```\n\n#### Mods which can be installed as either a QMod or a BepInEx plugin\n\nMods which meet all of the following criteria are eligible to be installed as either a QMod or a BepInEx plugin:\n\n- has a `mod.json` manifest for QModManager\n- has an assembly containing a `BaseUnityPlugin` class with a `BepInPlugin` attribute applied to it\n- has the following structure:\n  ```\n  - My Mod\n    - mod.json\n    - MyMod.dll\n  ```\n\nWhen 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.\n\n#### CustomCraft2 plugin packs\n\nAny 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.\n\n```\n- CustomCraft2SML\n  - Assets\n    - MyCC2Asset.png\n  - WorkingFiles\n    - MyCC2Mod.txt\n```\n\n```\n- CustomCraft2SML\n  - WorkingFiles\n    - MyCC2Mod.txt\n```\n\n#### CustomHullPlates addon packs\n\nAny 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.\n\n```\n- CustomHullPlates\n  - HullPlates\n    - MyHullPlate\n      - icon.png\n      - info.json\n      - texture.png\n```\n\n```\n- HullPlates\n  - MyHullPlate\n    - icon.png\n    - info.json\n    - texture.png\n```\n\n```\n- MyHullPlate\n  - icon.png\n  - info.json\n  - texture.png\n```\n\n#### CustomPosters addon packs\n\nAny 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.\n\n```\n- CustomPosters\n  - Posters\n    - MyPoster\n      - icon.png\n      - info.json\n      - texture.png\n```\n\n```\n- Posters\n  - MyPoster\n    - icon.png\n    - info.json\n    - texture.png\n```\n\n```\n- MyPoster\n  - icon.png\n  - info.json\n  - texture.png\n```\n\n### Mixed CustomHullPlates/CustomPosters addon packs\n\nAny 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.\n\n```\n- CustomHullPlates\n  - HullPlates\n    - MyHullPlate\n      - icon.png\n      - info.json\n      - texture.png\n- CustomPosters\n  - Posters\n    - MyPoster\n      - icon.png\n      - info.json\n      - texture.png\n```\n\n```\n- HullPlates\n  - MyHullPlate\n    - icon.png\n    - info.json\n    - texture.png\n- Posters\n  - MyPoster\n    - icon.png\n    - info.json\n    - texture.png\n```\n\n```\n- MyHullPlate\n  - icon.png\n  - info.json\n  - texture.png\n- MyPoster\n  - icon.png\n  - info.json\n  - texture.png\n```\n\n#### My mod is being installed strangely!\n\nIf 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](https://github.com/toebeann/subnautica-support/issues) with a link to your mod page or with a sample archive attached so that I can get it fixed.\n\n## Copyright notice\n\nSubnautica Support - Vortex support for Subnautica\n\nCopyright (C) 2023 Tobey Blaber\n\nThis program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.\n\nThis program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License along with this program; if not, see \u003chttps://www.gnu.org/licenses\u003e.\n\n[Vortex]: https://www.nexusmods.com/about/vortex/\n[Vortex Mod Manager]: https://www.nexusmods.com/about/vortex/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftoebeann%2Fsubnautica-support","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftoebeann%2Fsubnautica-support","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftoebeann%2Fsubnautica-support/lists"}