Packing your project for distribution

[Capt'n Skunky]

Attention Mod Authors!

OUTDATED AS OF VERSION 0.21. UPDATE COMING

I would like to suggest some tips and tricks for packing your project up into an archive file to be used as a standardized template.

Archive Filename: The file for download should include your project name and version number. The reason for this is so people can organize their downloads and quickly see if they have downloaded the current version.

Example: MechJeb 1.8.3.zip, NovaPunch 2.1.7z, DamnedAerospace 1.1.rar

File & Folder Structure: Since most people will extract your project to a folder that contains other projects, the first thing inside your archive should be a folder with the same name as the archive, i.e. the project name and version number. Inside that folder should be your readme.txt and the folders for Parts, Plugins, etc.

Example:

MechJeb 1.8.3.zip

->readme.txt (optional)

->\Parts\[partname]\[files]

->\Ships\VAB\[files] (optional)

->\Ships\SPH\[files] (optional)

->\Plugins\[files]

->\PluginData\[files] (optional)

->\Source\MechJeb 1.8.3\[files] (optional)

->\[other folders]\[misc files] (optional)

This format will insure that no files are overwritten by accident (except the readme, tho GME handles it). If you are using Generic Mod Enabler, it will properly rename the readme by adding the project name to the filename. All other files will give a warning about being over written.

Cheers!

Capt'n Skunky

KSP Community Manager

Edited June 6, 2013 by Capt'n Skunky
Import errors fixed