-
Notifications
You must be signed in to change notification settings - Fork 37
Home
Last updated for version 2.0
To get started, reference the dll file SMLHelper.dll
located in your Subnautica directory, under QMods/Modding Helper/SMLHelper.dll
or in your BelowZero directory, under QMods/SMLHelper_BZ/SMLHelper.dll
The file SMLHelper.xml
is also available there and will provide Visual Studio with documentation tooltips for all the methods, classes, and fields provided by SMLHelper. You do not need to reference the XML directly. It is implicitly referenced when you add the dll to your project.
The Quick Start Guide is perhaps the best place to start if this is your first time looking at this wiki and using SMLHelper.
If you are looking to use SMLHelper primarily to mod in your own custom items, it is recommended you use the newer style of adding items rather than dealing with ModPrefab
directly.
Because development of this library sometimes outpaces the updates to the wiki, it's recommended that you make use of the XML documentation (viewable from within Visual Studio).
If there is something missing or ambiguous, please create an issue or contact us on the Subnautica Modding Discord using our tags:
- PrimeSonic:
@PrimeSonic#0667
- Metious:
@Metious#3682
Please note that some pages are under construction and the links to them will be enabled as they are completed
[Adding]
- Items/GameObjects using Asset Classes
- Asynchronous loading for ModPrefab
- [Custom Scanner Unlocks]
- Items/GameObjects to the Spawning System
- [Recipes to uncraftable items]
- [Custom Mouse Click Actions]
[Editing]
- Background Type
- Crafting Time
- Equipment Type
- Quick Slot Type
- Size in Inventory
- [Recipes for craftable items]
- Harvest Settings
- BioReactor Fuel Values
- [Scanning Count/Time]
- [Spawning (Where/How often/How many)]
[General Utilities]
- In-Game Options Menu
- Adding crafting recipes for other mods items
- Using items from other mods
- Texture/Sprite Utilities
- [Adding/Playing Audio]
- Config Files using Abstract Json Config class
- Custom Console Commands
- [Registering OnSave/OnQuit Actions]
[Language]