Skip to content

Commit

Permalink
Added deprecation notice
Browse files Browse the repository at this point in the history
  • Loading branch information
Metious committed May 5, 2023
1 parent 53d8afe commit 214414e
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@
SMLHelper is a complete library that helps you out on your Subnautica modding adventures by making adding new items, changing items, adding models, sprites a LOT easier.
Check out [the wiki page](https://github.com/SMLHelper/SMLHelper/wiki) for details on how to use it.

## ⚠️Deprecation Notice⚠️
SMLHelper has been deprecated and will no longer receive updates.
If you're using the latest version of Subnautica, use [Nautilus](https://github.com/SubnauticaModding/Nautilus) instead.
Nautilus contains all the features SML used to offer and more.

Both libraries are compatible and can be present simultaneously. However, we encourage modders to update to Nautilus as SML is deprecated. To get started, see the [Updating to Nautilus](https://subnauticamodding.github.io/Nautilus/guides/sml2-to-nautilus.html) guide.

## Contributing
We would love to have people contribute to SMLHelper.
To get started, first fork the repo and then clone it to your local environment.
Expand Down

0 comments on commit 214414e

Please sign in to comment.