Getting Started - MSUTeam/MSU GitHub Wiki

• NOTE: MSU guarantees backwards compatibility for documented features and code only. Undocumented features/code of MSU may be changed at any time without notice, so we advise against using/referencing such code in your projects.

First of all, it is recommended that you save the aspects of your mod in the global namespace. Please don't use a simple key that might be taken up by other mods, such as mod. A clean way to do this is to define your ID, Version and Name in there.

::MyCoolMod <- {
    ID = "my_mod_id",
    Version = "1.0.0",
    Name = "MyCoolMod"
}

The first step of making a mod that is fully compatible with MSU is registering with Modding Script Hooks. You'll need to initialize your mod with ::mods_registerMod(::MyCoolMod.ID, ::MyCoolMod.Version).

The next step is queueing your mod after MSU. To do this, use mod_msu as the queueing parameter:

::mods_queue(::MyCoolMod.ID, "mod_msu", function()
{

If you want to use systems, you will need to define a mod object. See the Mod page for a detailed explanation. Example: ::MyCoolMod.Mod <- ::MSU.Class.Mod(::MyCoolMod.ID, ::MyCoolMod.Version, ::MyCoolMod.Name);