Subnautica
0 of 0

File information

Last updated

Original upload

Created by

Subnautica Modding Community

Uploaded by

metious

Virus scan

Safe to use

About this mod

A library that helps you add items, sprites, crafting logic, etc into the game the easy way!
Spend less time figuring out how to get your mod to work and more time on what you can do with it!

Requirements
Permissions and credits
Translations
  • Russian
Changelogs
A library that helps you add items, models, sprites, etc into the game in a very easy way!

Before asking any questions, please read the FAQ!

Also, DO NOT try to change the files in the Modding Helper folder, especially the folders that contain the word "Cache". They are very crucial in determining how SMLHelper will add items into the game, and it is REQUIRED that they are not touched, especially if you don't know what you're doing!

Installation
1. Download and install QMods.
2. Download the archive.
3. Open up the archive with WinRar or 7zip. 
4. Drag-and-drop the "Modding Helper" folder into your QMods folder. (if your QMods folder doesn't exist, run the game at least once so that QModManager can make it, or you can make the folder yourself.)

FAQ

What is this?
This library is basically allows you to easily communicate with the game so that you can focus more on the mod's features you are developing. It does nothing on its own, but is rather a "tool" to help other mods.

Isn't there already a Modding Helper?
Yes, but the difference is that this is a brand-new version of Modding Helper; V2, is what we're calling it. The reason for that is because we've done a major revamp of how the library works, and how other mods can use it. It also fixes a bunch of bugs, adds lots of new features, and overall, its just a huge improvement.

Is it compatible with mods that use the old Modding Helper?
Not anymore. As of version 2.3, all of the legacy APIs have since been removed.
We chose this time to do it since the "Little Big Update" had all mods requiring updates anyways.

How do I update to a new version?
Do not delete your old folder! Just replace the files in the original Modding Helper folder with the ones from the new archive.
It's the same as updating to a new version.

I am a modder. How do I enable debug logging?

  • Debug logging (for development and troubleshooting) can be enabled by changing the value in the new file EnableDebugLogs.txt.
  • Debug logging can also be toggled from the in-game Mods menu, however, since most of the SMLHelper actions (and thus logs) take place
  • before the main menu loads, this will mostly only be useful for subsequent loads of the game.



Additional Resources

For modders and developers:
Please refer to the Wiki to get to know how to use this library!
https://github.com/SMLHelper/SMLHelper/wiki
And here's the source code:
https://github.com/SMLHelper/SMLHelper

For players:
As of the 2.1 release, there is a new Language Patcher feature in SMLHelper
You can use this to provide your own custom translations or alternate text for any SMLHelper enabled mod.
Learn how to use the Language Overrides on the wiki