SMLHelper (modification assistant)

SMLHelper (modification assistant)

A library that helps you easily add items, sprites, crafting logic, and more to your game!

Spend less time figuring out how to make your mod work and more time accomplishing what you can do with it!

A library that helps you add items, models, sprites and more to your game in a very easy way!

Before asking any questions, please read the FAQ!

Also, do not attempt to change files in the Modding Helper folder, especially folders containing the word "Cache". They are very important in determining how the SMLHelper adds items to the game, and require that they be left untouched, especially if you don't know what you are doing!

Install

• Download and install QMods.
• Download the archive.
• Open the archive using WinRar or 7zip.
• Drag and drop the "Modding Helper" folder into the QMods folder. (If your QMods folder doesn't exist, run your game at least once so QModManager can make it, or you can make the folder yourself.)

FAQ

What's this?

This library basically allows you to easily communicate with your game so that you can focus more on the functionality of the mod you are developing. It does nothing by itself, but it is a "tool" to help other mods.

Is there already a Modding Helper?

Yes, but the difference is that this is a completely new version of Modding Helper; V2, that's what we call it. The reason for this is because we've made significant improvements to how the library works, and how other mods use it. It also fixes a bunch of bugs, adds a lot of new features, and overall it's just a huge improvement.

Is it compatible with mods using the old Modding Helper?

Of course it is! We spent a long time making sure V2 is backwards compatible with all older mods; no need to wait for mod authors to update!

What if I have an older version?

Don't delete old folders! Simply replace the files in the original Modding Helper folder with the files in the 2.0 archive. This is the same as updating to a new version.

I'm a modder. How to enable debug logging?

Debug logging (for development and troubleshooting) can be enabled by changing the value in the new file EnableDebugLogs.txt.

However, debug logging can also be toggled from the in-game Mods menu, as most SMLHelper operations (and therefore logs) occur

This is usually only useful for subsequent game loads before the main menu loads.

Other resources

For modders and developers:

See the wiki to learn how to use this library!

Here is the source code:

https： //github.com/SMLHelper/SMLHelper

For players:

As of version 2.1, there is a new language patching feature in SMLHelper

You can use this to provide your own custom translation or alternative text for any mod that supports SMLHelper.

Learn how to use language overrides on your wiki