Nautilus: Subnautica Modding API

## This prototype has been archived, please visit [this](https://github.com/SubnauticaModding/Nautilus) repository instead. ## Contents - [🌐 About](#-about) - [⬇️ Installation](#%EF%B8%8F-installation) - [📚 Resources / links](#-links) - [❤️ Contributors](#%EF%B8%8F-contributors) - [🤝 Contributing](#-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: Adding/editing items, implementing custom sprites & textures, custom audio, a Subnautica-styled mod configuration menu, and so much more!

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. For more information on Nautilus and its capabilities, please refer to our documentation.

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

⬇️ Installation

1. Download the Subnautica BepInEx Pack.

2. Extract/unzip the BepInEx x64 zip file to your game folder

   • Where is my Subnautica/game folder?

     - Steam:         C:\Program Files (x86)\Steam\steamapps\common\Subnautica
     - Epic Games:   C:\Program Files\Epic Games\Subnautica
     - Xbox PC:       C:\XboxGames\Subnautica\Content
     ###### Note: the above paths are the default locations, yours may vary
   • How do I extract the zip file?

     - Extracting/unzipping a zip file is as simple as right clicking it, and selecting the `Extract here` prompt. We highly recommend the use of a zipping tool besides the Windows default one, such as [WinRAR](https://www.rarlab.com/download.htm), or [7-Zip](https://7-zip.org/download.html).
3. Download Nautilus from Nexus Mods, Submodica or GitHub Releases.
4. Extract/unzip the Nautilus zip file to your Subnautica\BepInEx folder
5. Confirm your Subnautica\BepInEx\plugins now looks like this:

   If it doesn't look like this, try figure out where your Nautilus folder has gone, and move it into the plugins folder

   

6. Launch the game, and enjoy! (a good way to confirm Nautilus has loaded is to check the game Options for a Mods tab)

If you have any trouble installing the mod, please join our Discord server, and explain whats going on in a help and support channel.

📚 Links

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

❤️ Contributors

To everyone who has taken the time to contribute to Nautilus and/or SMLHelper, we cannot thank you enough!

• Table of contributors 📌
• Up-to-date contributor data from GitHub
• SMLHelper repository (contains any lost contributor info)

An unusual issue when mirroring the repository has caused many SMLHelper contributors to disappear from the widget on Nautilus's GitHub page, even if their contributions were correctly carried over to Nautilus.

🤝 Contributing

We welcome all kinds of contributions; simply ensure you have read through our Contribution Guidelines before submitting a pull request.
If you are not capable of writing code, but have feature ideas, or bug reports, feel free to submit an issue instead.