Standard for Mod Packaging

[Site Bot]

Article link: Standard for Mod Packaging

 

NOTE: This is not yet complete, and is still under discussion here. Feel free to give input!

 

This is how all mod creators should package their mods for the end user's ease of use as well as the use of mod managers. This standard was conceived on The Nexus Forums.

 

First, it is preferable for you to use .7z or .zip archives when packaging your mod. The reason for this is that the utilities for extracting those archives is free and those archives are widely supported by other archive software.

 

Second, the archive should follow this structure:

http://www.fallout3nexus.com/imageshare/images/933056-1227008757.gif

Where Authname should be replaced with your name, Modname should be replaced with your mod's name, and Version should be replaced with the version of your mod. Anything between two are folders and ... are files related to your mod that go in the folders. Anything with the file name ending in .ext means that the file type is of your choice (Screenshot 1.ext can be Screenshot 1.jpg or Screenshot 1.png, etcetera). If you are not putting any files in some of these folders, then you should leave out the folder.

 

The following is an example of the package for Bob's Super Gun 0.1:

http://www.fallout3nexus.com/imageshare/images/933056-1227008844.gif

[LHammonds]

My thoughts on this can be found here.

 

LHammonds

[jaysus]

may i add that it might be useful not to use blanks, dots or similiar in filenames...

files like "screenshot 2.jpg" should be "screenshot2.jpg", "supergun.espme.esp" to "supergunespme.esp"

there are still programs out there which dont support all that fancy windows stuff and could lead to unrecognizable files... unlikely but possible