Skip to content

Commit

Permalink
chore: Updated README.md (#2)
Browse files Browse the repository at this point in the history
* Update README.md

* Moved table of contents above the 'About' section

* Removed hyperlink on 'GitHub Releases' text

* Added text to the 'About' section

* Added Discord and link references

* Fixed spelling

---------

Co-authored-by: Metious <[email protected]>
  • Loading branch information
RamuneNeptune and Metious committed Apr 24, 2023
1 parent 33a2d94 commit 38ba7d5
Showing 1 changed file with 36 additions and 11 deletions.
47 changes: 36 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,49 @@

![banner](https://user-images.githubusercontent.com/71298690/233505405-e89fbc70-31c9-45a2-bb31-64e1f498d4a7.png)

[![Discord](https://img.shields.io/discord/324207629784186882?logo=discord&logoColor=white)](https://discord.gg/UpWuWwq)
[![GitHub contributors](https://img.shields.io/github/contributors/SubnauticaModding/Nautilus?style=flat-square)](https://github.com/SubnauticaModding/Nautilus/graphs/contributors)
[![License](https://img.shields.io/github/license/SubnauticaModding/Nautilus?style=flat-square)](https://github.com/SubnauticaModding/Nautilus/blob/master/LICENSE.md)

## Contents
- [🌐 About](#about)
- [⬇️ Installation](#installation)
- [📚 Resources / links](#links)
- [🤝 Contributing](#contributing)

## About
Nautilus is a modding library that aims on enhancing developer productivity by offering common helper utilities as easy to use and robust as possible.

Nautilus offers systems such as adding/editing items, icons, spawns, sounds and so much more!
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](https://subnauticamodding.github.io/Nautilus).

This project was derived from [SMLHelper](https://github.com/SubnauticaModding/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](https://github.com/SubnauticaModding/SMLHelper) instead.

## Installation
1. Download [BepInEx](https://www.nexusmods.com/subnautica/mods/1108).
Install it by extracting the content of the zip into your Subnautica folder (usually `C:\Program Files (x86)\Steam\steamapps\common\Subnautica`)
2. Download Nautilus from either [Nexus Mods](https://www.youtube.com/watch?v=dQw4w9WgXcQ), [Submodica](https://www.youtube.com/watch?v=dQw4w9WgXcQ) or GitHub Releases.
Drag and drop the `plugins` folder in the zip into your BepInEx folder.
1. Download the [Subnautica BepInEx Pack](https://www.nexusmods.com/subnautica/mods/1108).
Install it by extracting the contents of the zip into your <b>Subnautica folder</b>:
- 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](https://www.youtube.com/watch?v=dQw4w9WgXcQ), [Submodica](https://www.youtube.com/watch?v=dQw4w9WgXcQ) or GitHub Releases.
Drag and drop the `plugins` folder in the zip into your `BepInEx` folder.
1. Drop the `plugins` folder here: `PathToSubnautica\BepInEx\`
2. It should end up like this: `PathToSubnautica\BepInEx\plugins\Nautilus\`

If you got trouble installing the mod, please join our [Discord server](https://discord.gg/UpWuWwq).
If you have any trouble installing the mod, please join our [Discord server](https://discord.gg/UpWuWwq), and explain your issue in one of the help and support channels.

## Links
* [Documentation](https://subnauticamodding.github.io/Nautilus) ([source](https://github.com/SubnauticaModding/Nautilus/tree/docs/Nautilus/Documentation))
* [Update To Nautilus From SMLHelper](https://subnauticamodding.github.io/Nautilus/guides/sml2-to-nautilus.html)
* [Subnautica Modding Discord Server](https://discord.gg/UpWuWwq)
* Developer resources:
* [Documentation](https://subnauticamodding.github.io/Nautilus) ([source](https://github.com/SubnauticaModding/Nautilus/tree/docs/Nautilus/Documentation))
* [Updating to Nautilis from SMLHelper](https://subnauticamodding.github.io/Nautilus/guides/sml2-to-nautilus.html)
* Other links:
* [Subnautica Modding Discord Server](https://discord.gg/UpWuWwq)

## Contributing
Please read through our [Contribution Guidelines](CONTRIBUTING.md) 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](https://github.com/SubnauticaModding/Nautilus/issues/new) instead.
If you have an idea for a feature or a bug to report but are not capable of writing code, [submit an issue](https://github.com/SubnauticaModding/Nautilus/issues/new) instead.

0 comments on commit 38ba7d5

Please sign in to comment.