JKohlman / Nautilus-Proto

Nautilus, the Subnautica Modding API.

Nautilus: Subnautica Modding API

Contents

• 🌐 About
• ⬇️ Installation
• 📚 Resources / links
• 🤝 Contributing

About

Nautilus is a modding library that aims to enhance developer productivity by offering common helper utilities as easy to use and robust as possible. Notable systems which Nautilus offers include but not limited to: Adding/editing items, implementing custom sprites & textures, custom audio, Subnautica-style configuration menu, and so much more!
For more information on Nautilus capabilities, please refer to our documentation.

This project was derived from SMLHelper with an improved codebase and maintainability. Nautilus offers all the features SML used to offer in a more robust implementation. Additionally, Nautilus took another route of managing handlers to fix many bugs and timing issues that were persistent in SML.
We hope to keep improving the modding experience in Subnautica to allow developers to create mods more easily and eliminate the implementation concerns in the mod-making process.

⚠️ Nautilus is only supported on the latest version of Subnautica. If you're playing on the Legacy branch of Steam, use SMLHelper instead.

Installation

1. Download the Subnautica BepInEx Pack.
   Install it by extracting the contents of the zip into your Subnautica folder:

   • Steam - C:\Program Files (x86)\Steam\steamapps\common\Subnautica (default path)
   • Epic Games - C:\Program Files\Epic Games\Subnautica (default path)
   • Xbox PC - C:\XboxGames\Subnautica\Content (default path)

2. Download Nautilus from one of Nexus Mods, Submodica or GitHub Releases.

   1. Drag and drop the plugins folder in the zip into your BepInExfolder located in PathToSubnautica\BepInEx\.
   2. It should end up like this: PathToSubnautica\BepInEx\plugins\Nautilus\

If you have any trouble installing the mod, please join our Discord server, and explain your issue in one of the help and support channels.

Links

• Developer resources:
  • Documentation (source)
  • Updating to Nautilus from SMLHelper
• Other links:
  • Subnautica Modding Discord Server

Contributing

Please read through our Contribution Guidelines before submitting a pull request. We welcome all kinds of contributions.
If you have an idea for a feature or a bug to report but are not capable of writing code, submit an issue instead.