[MoonLoader] Mod Loader Compatibility

04 Out 2020, 15:06

Hey guys.

In this tutorial I will show how to make your scripts compatible with Mod Loader.
Note: This is not a tutorial per se, but more of a compilation of notes.

Required:
MoonLoader
Mod Loader
Mod Loader Support for MoonLoader
Note: The user is also required to have these installed.

Let's begin.

1. Paths
It is recommended to use relative paths for scripts instead of (semi-)absolute paths.
What is mean is, instead of using getWorkingDirectory(), use thisScript().directory whenever you can. So even if the user has installed the script somewhere else, the correct path will be returned.

2. Libraries
So your script requires a non-standard library. What do you do?
Simple. Just distribute it along with the script!

Example:
Your script requires a library named TestLib.

1. Paste this at the top of your script before any requires:

Código: Selecionar tudo

function setPackagePathPortable(path)
    for i, path in ipairs(type(path) == "table" and path or {path}) do
        local dir = thisScript().directory .. "\\" .. path .. "\\"
        package.path = dir .. "?.lua;" .. dir .. "?.luac;" .. dir .. "?\\init.lua;" .. dir .. "?\\init.luac;" .. package.path
        package.cpath = dir .. "?.dll" .. package.cpath
    end
end

2. Call the function:

Código: Selecionar tudo

setPackagePathPortable("TestScript")

Note: You can also pass a table to set multiple paths:

Código: Selecionar tudo

setPackagePathPortable({"TestScript", "TestScript2"})

Note: Paste the function above and call it from below, otherwise it will not work if called from out of main().

3. Require the library:

Código: Selecionar tudo

require("TestLib")

4. Put the libary at script directory/TestScript/TestLib.lua

Complete code:

Código: Selecionar tudo

function setPackagePathPortable(paths)
	local paths = type(paths) == "table" and paths or {paths}
	for i, path in pairs(paths) do
		package.path =  thisScript().directory .. "\\" .. path .. "\\?.lua;" .. package.path
		package.path =  thisScript().directory .. "\\" .. path .. "\\?\\init.lua;" .. package.path
		package.path =  thisScript().directory .. "\\" .. path .. "\\?.luac;" .. package.path
		package.path =  thisScript().directory .. "\\" .. path .. "\\?\\init.luac;" .. package.path
		package.cpath =  thisScript().directory .. "\\" .. path .. "\\?.dll;" .. package.cpath
	end
end

setPackagePathPortable("TestScript")

require("TestLib")

print("required")

And it will work for both installations (with and without Mod Loader).

Note: It is recommended to use a separate folder for your script's files (including libraries) to avoid messy directories and erroneous file replacement.

I encourage to do this for any library (including but not limit to: MoonAdditions, ImGui etc.).

Advantages:

All the dependencies are provided with the mod, so the user does not have to worry. Along with easy drap-and-drop installation most of the time.
Takes care of version compatibility. In case of outdated libraries, I think the responsibility falls on the mod maker to update the mod.

That's it for now. Thoughts, ideas criticism, and questions welcome!

3. Library Portability
Although most libraries will work with the method above (2) by default, some may need additional tinkering to work depending on how they are written.

mimgui:
Hey guys. I figured out how to make mimgui (version 1.7.0 of imgui) portable.
Download the modified version: https://drive.google.com/file/d/1Ri87cm ... sp=sharing
Modified files: init.lua, imgui.lua

Using the example from above (2. Libraries), here is the directory structure:

modloader\
|---TestScript\
|---moonloader\
|---TestScript.lua
|---TestScript\
|---TestLib.lua
|---mimgui\

You have to place the 'mimgui' folder inside the 'TestScript' folder. Also notice how the mod folder has the same name as the script name. You should follow this advice.
Now, open the modified files:
1. Open init.lua.
You will see the following line at the top:

Código: Selecionar tudo

local sDirectory = "TestLib" -- set to your mod folder

Edit the string "TestLib" to your mod folder path. "TestScript" in this case.
2. Open imgui.lua
Do the same as step 1 above.

You have successfully configured mimgui to be portable.

08 Nov 2020, 17:18

Added a tutorial on how to configure mimgui to be portable. See: 3. Library Portability.

01 Jan 2021, 04:50

I updated the link to your version of mimgui. It'd be better if you pr the changes you made here. That should resolve any issues with future versions if they come.

01 Jan 2021, 17:13

Grinch_ escreveu: ↑
01 Jan 2021, 04:50
I updated the link to your version of mimgui.

I mean, this version is not compatible with regular installation. I will try to make it compatible with regular installation too, or I could fork/clone a new version.

01 Jan 2021, 17:34

HzanRsxa2959 escreveu: ↑
01 Jan 2021, 17:13

Grinch_ escreveu: ↑
01 Jan 2021, 04:50
I updated the link to your version of mimgui.
I mean, this version is not compatible with regular installation. I will try to make it compatible with regular installation too, or I could fork/clone a new version.

I see. Will keep both of them added for now.

Forum.MixMods

[MoonLoader] Mod Loader Compatibility

[MoonLoader] Mod Loader Compatibility

Re: [MoonLoader] Mod Loader Compatibility

Re: [MoonLoader] Mod Loader Compatibility

Re: [MoonLoader] Mod Loader Compatibility

Re: [MoonLoader] Mod Loader Compatibility