After you have created your mod, read this section to learn how to distribute it properly.
Your mod is located in \Mods\yourmod\ . When you want to distribute the mod, simply zip this folder. There is a "HOW_TO_INSTALL_MOD.txt" in the \Mods directory, which should help users to set up the mod correctly, but feel free to write your own instructions also if you have some special things that the user must do.
Things to do before you start distributing your mod:
* Make sure you have written a short description of your mod in the description.txt
in your mod directory. Please keep it short. It's not actually a "description" as such, but more of a short name for the mod. This text is used in the Shadowgrounds Launcher, in the mod selection drop-down box.
* Copy ALL of your mod to another directory, for example to C:\MyModDistributionVersion\Mods\ . This is to make sure that you won't accidentally delete any files from the actual development version of your mod. Then go to that directory and then your mod's directory and do the following:
- Delete file BEFORE_DISTRIBUTING_MOD.txt
- Delete ModDeveloper profile (Profiles\ModDeveloper) and ModDeveloper_instructions.txt (Profiles)
- Delete cpp.exe, re.exe, scriptdev.exe and cygwin1.dll
- Delete the whole \Editor folder from your mod package. If you leave it, then everyone else can edit your maps too, which is probably not a good idea. The folder also takes up a lot of harddisk space.
* Create a ZIP or RAR archive of your mod; compress the whole Mods directory (in C:\MyModDistributionVersion\ or wherever you created it). If you have created multiple mods, then delete their directories, so that only one mod directory is under \Mods (unless you want to distribute multiple mods in one package, which is not recommended)
- Make sure the ZIP/RAR archive has a directory structure of \Mods\yourmodname\... , meaning that users can simply extract the package to their Shadowgrounds directory, and not worry about manually extracting to the correct directory
- Alternatively you can also use an installer instead of ZIP/RAR. In that case please follow the general guidelines as told above.
Frozenbyte recommends that you don't include the Active.txt, which defines the used mod. In our opinion it is best to let the users select your mod on their own but of course this is up to you.
If you provide good instructions on how to install your mod, you can consider "dropping" the Mods directory from your distributable mod ZIP/RAR/installer.