#About .luma files
A .luma file holds a whole mod: its luma.json, layers, files, assets and code for every platform. One .luma works on Windows, Linux, macOS, Android and iOS. Players never need LumaLink.
#Packing a mod
Set the version in
luma.json. UseMAJOR.MINOR.PATCH, such as1.2.0, and raise it with every release, so players and other mods can tell versions apart.If the mod has code, build it for every platform.
Shell lumalink build MOD-FOLDERPack the mod.
Shell lumalink pack MOD-FOLDERLumaLink checks the mod with every rule first. If the check finds an error, nothing is written. When the check passes, LumaLink writes
MOD-ID-VERSION.lumabeside the folder. To choose another file, use-o FILE.
To also check that every mod your mod needs is present, pass the folder that holds them with --mods FOLDER. For every option, see lumalink pack.
#Checking a .luma
Before you share a .luma, check the file itself the way Nebula will:
lumalink check MOD-ID-VERSION.lumaTo confirm that a .luma is exactly what its folder packs to, run lumalink verify MOD-ID-VERSION.luma --source MOD-FOLDER. For more information, see lumalink check and lumalink verify.
#Sharing a mod
Share the .luma file itself. When your mod needs another mod, such as LumaKit, say so where you share it. Nebula ships LumaKit, so players already have it.
If your mod asks for permissions, say what each one is for. Players see your reasons, from the --why text, when they turn the mod on.
#How players add a mod
Players add a .luma in one of these ways:
- Windows, Linux and macOS: Drop the file on the game's window. Or open Settings, select Mods, then Import file.
- Android: Open the file with Nebula from a file manager. Or open Settings, select Mods, then Import file.
Nebula checks the mod and shows the result. A mod with an error is not added. A new mod is on at the next start. If it has code or asks for permissions, Nebula asks the player first.