Packing your mod
After you have finished the mod you were working on, you can pack it and include it into the game, whatever it is to test the functionality, or distribute it to the community.
Preparing the mod
Before packing up the mod, it is recommended to double check the code of your mod and other relevant configuration file, especially when you plan to distribute it.
Installing the necessary tools
To easily pack a mod, you can use the Mod Framework CLI available for Windows, Mac, and Linux. It provides command line interface for packing up your mod and checking the code syntax for issues.
To pack your mod with the Mod Framework CLI, you can use the following command after opening the directory containing them od.
The tool will also warn you of possible code syntax issues and other configuration problems related to your mod.
It is recommended not to ignore the warnings issued by the tool, as such issues can negatively impact your mod and its functionality.
Packing a mod manually
If you prefer to pack the mod manually, or if the Mod Framework CLI is not available on your platform, you can use other methods to pack a mod.
To pack a mod manually, simply place the mod files inside a zip archive, then rename the zip archive to swpmod
. For example if the zipped folder is called myMod.zip
, rename it to myMod.swpmod
.
Syntax checking is not available when manually packing a mod, therefore, it is recommended to double check the code and configuration files.
What is next
After successfully packing up your mod, either by using the SwordigoPlus Workspace IDE, by using the Mod Framework CLI, or by manually packing it, you can now load it into the game and even distribute it to the community.
Last updated