OXP Distribution - Revision history

Norby: OXZ guide link

2014-08-18T10:05:36Z

OXZ guide link

Cim: Some updates for 1.80

2014-08-08T20:43:03Z

Some updates for 1.80

GGShinobi: /* General */ linked explanation how conflicts can occur if no unique names are used

2013-01-29T14:32:54Z

‎General: linked explanation how conflicts can occur if no unique names are used

GGShinobi: /* Packaging */ typo

2013-01-29T07:43:27Z

‎Packaging: typo

Cim: /* Updating */

2012-07-11T14:36:34Z

‎Updating

Cim: /* General */ Avoid use of generic names

2012-07-11T14:34:59Z

‎General: Avoid use of generic names

Capt. Murphy: Added Packaging Retexture/Remodel OXPs section.

2012-02-04T13:59:29Z

Added Packaging Retexture/Remodel OXPs section.

Jaz: /* Packaging */ added suggestion on documentation

2011-12-28T00:36:22Z

‎Packaging: added suggestion on documentation

Eric Walch: box.com

2011-11-21T21:43:25Z

box.com

Maik: added version numbering scheme to file names

2011-11-15T08:50:24Z

added version numbering scheme to file names

@@ Line 46: / Line 46: @@
 * Create a wiki page for your OXP if you can, or ask around the BB for help with setting one up.
 * At the very least, provide enough information for creating a one-liner in the [[OXP List]].
 ==Updating==
 # '''Always''' update the version number, no matter how small the change is.

@@ Line 1: / Line 1: @@
 Making sure that users can easily find, download, understand, and install your OXP helps making it more popular and keeps requests for help to a minimum. The following best practices help you achieve that.
 ==General==
-* Make sure that the file names in your plists precisely match the actual file names, including the capitalization. File names on non-Windows systems are case-sensitive.
+* Make sure that the file names in your plists precisely match the actual file names, including the capitalization. File names on non-Windows systems (and even on Windows when using OXZ format) are case-sensitive.
-* Include requires.plist in your OXP.
+* Include [[requires.plist]] and [[manifest.plist]] in your OXP (if using OXZ format, requires.plist can be omitted)
 * Avoid file names with spaces. They make it harder for people who use the command line.
 * Avoid the use of generic names for textures, models, scripts, and keys in .plist files as they may [[OXP howto#Unique names|lead to conflicts with other OXPs]]. Prefixing the names with the OXP name is recommended (e.g. "MyOXP_MetalTexture.png" not "MetalTexture.png")
 {|
 | style="padding-top: 3px; vertical-align: top" |
@@ Line 33: / Line 35: @@
 |}
-==Distribution==
+===Distribution===
 # Create a zip file based on the "MyNewOXP_x.y.z_yyyy-mm-dd" directory and name it "MyNewOXP_x.y.z_yyyy-mm-dd.zip"
 #* While there are other, more efficient compression tools (such as rar, 7z), zip is available out-of-the-box on all operating systems that are officially supported by Oolite.
@@ Line 58: / Line 60: @@
 *Secondly create two separate OXPs named ''ShipSetName''_Replace.oxp and ''ShipSetName''_Addition.oxp or similar. These should contain the Config folder for your ships. End users can install one or the other depending on whether they want your ships to replace the core Oolite ships entirely, or if they want your ships to appear in addition to the core Oolite ships, or in addition to another retexture OXP which has replaced the core Oolite ships.
-*The shipdata.plist in ''ShipSetName''_Addition.oxp should reference each ship with a unique identifier. For example your version of the adder may be referenced as  "''ShipSetName''_adder". You will also need to include a demoships.plist so that your ships will appear on the demoships parade and a shipyard.plist referencing the ships that are player purchasable.
+*The shipdata.plist in ''ShipSetName''_Addition.oxp should reference each ship with a unique identifier. For example your version of the adder may be referenced as  "''ShipSetName''_adder". You will also need to include a shipyard.plist referencing the ships that are player purchasable. You should use <code>like_ship</code> to copy the template entries from the main ship data, for example
 *End users will need to download the ''ShipSetName''_Resources.oxp and either the ''ShipSetName''_Addition.oxp or the ''ShipSetName''_Replace.oxp depending on their preference. In general end users cannot install multiple 'replacement' type retexture OXPs without them conflicting. However they can install one 'replacement' type retexture OXP, and as many 'addition' type retexture OXPs as they wish to achieve more variety of ships in game. Providing your retexture/remodel OXP in this format facilitates this end user choice.

@@ Line 4: / Line 4: @@
 * Include requires.plist in your OXP.
 * Avoid file names with spaces. They make it harder for people who use the command line.
-* Avoid the use of generic names for textures, models, scripts, and keys in .plist files as they may lead to conflicts with other OXPs. Prefixing the names with the OXP name is recommended (e.g. "MyOXP_MetalTexture.png" not "MetalTexture.png")
+* Avoid the use of generic names for textures, models, scripts, and keys in .plist files as they may [[OXP howto#Unique names|lead to conflicts with other OXPs]]. Prefixing the names with the OXP name is recommended (e.g. "MyOXP_MetalTexture.png" not "MetalTexture.png")
 ==Packaging==

@@ Line 15: / Line 15: @@
 #* If you prefix the names of the readme and license files with MyNewOXP you are making it easier for users to keep all files that belong to OXPs in one place.
 #* If you instead put the readme etc. files into the .oxp directory then Mac users will have a harder time finding them as .oxp directories are presented as packages.
-#* Several OXP authors put a copy of the readme and manuals in both the main folder and the OXP folder. This is covers most situations/OSes.
+#* Several OXP authors put a copy of the readme and manuals in both the main folder and the OXP folder. This covers most situations/OSes.
 #* See the [http://aegidian.org/bb/viewtopic.php?f=4&t=7047 Licensing OXPs] thread on the Oolite Bulleting Board for information about licensing.
 # Inside the MyNewOXP_x.y.z_yyyy-mm-dd.oxp directory add the Config, Models, etc. directories that make up your OXP.

@@ Line 45: / Line 45: @@
 * At the very least, provide enough information for creating a one-liner in the [[OXP List]].
 ==Updating==
 # Update your readme file with a new entry to the version history.
 # Rename the directories based on the release date of your new version, create a new zip file, and upload it.

@@ Line 47: / Line 47: @@
 # Both modify the first post in the OXP thread that you created, and post a new message in the same thread. In the first post, update the download location and provide up-to-date version information. In the new message, mention that there is a new version and give whatever other information is necessary.
 #* If you only modify the first post, then the BB will not show that the thread changed. If you only add a new post, users will miss the new version if they only look at the first post.
 [[Category:Oolite]][[Category:Oolite expansion packs]][[Category:factual]]

@@ Line 33: / Line 33: @@
 #* While there are other, more efficient compression tools (such as rar, 7z), zip is available out-of-the-box on all operating systems that are officially supported by Oolite.
 #* If you are working on a Mac, please use either a compression tool like [http://www.macupdate.com/app/mac/12350/yemuzip YemuZip], or the "compress" command from the context menu in Finder followed by a run through [http://www.macupdate.com/app/mac/25497/zipcleaner ZipCleaner]. Otherwise, OS X specific files that are not relevant for other platforms will be included and lead to confusion.
-# Upload the zip file to an easily accessible online storage. Most OXP authors use [http://box.net box.net] for distribution nowadays. It is free up to 5GB and does not annoy your users with advertisements.
+# Upload the zip file to an easily accessible online storage. Most OXP authors use [http://box.com box.com] for distribution nowadays. It is free up to 5GB and does not annoy your users with advertisements.
 ==Announcement==

@@ Line 7: / Line 7: @@
 {|
 | style="padding-top: 3px; vertical-align: top" |
-# Create a directory named after your OXP, e.g. "MyNewOXP_yyyy-mm-dd". Make sure this directory '''does not''' end with the .oxp suffix. Replace yyyy-mm-dd with your OXP's release date (yyyy: year, mm: month, dd:day), e.g. 2011-03-05 for March 5th, 2011.
+# Create a directory named after your OXP, e.g. "MyNewOXP_x.y.z_yyyy-mm-dd". Make sure this directory '''does not''' end with the .oxp suffix.
-# Inside "MyNewOXP_yyyy-mm-dd", add the readme, the license, and additional files, and the actual OXP directory, named MyNewOXP_yyyy-mm-dd.oxp. Make sure this directory '''does''' end with the .oxp suffix.
+#* Replace x.y.z with the version number, e.g. 1.0.0 for the initial release, or 1.0.1 for a small follow-up bug fix release.
 #* If you prefix the names of the readme and license files with MyNewOXP you are making it easier for users to keep all files that belong to OXPs in one place.
 #* If you instead put the readme etc. files into the .oxp directory then Mac users will have a harder time finding them as .oxp directories are presented as packages.
 #* See the [http://aegidian.org/bb/viewtopic.php?f=4&t=7047 Licensing OXPs] thread on the Oolite Bulleting Board for information about licensing.
-# Inside the MyNewOXP_yyyy-mm-dd.oxp directory add the Config, Models, etc. directories that make up your OXP.
+# Inside the MyNewOXP_x.y.z_yyyy-mm-dd.oxp directory add the Config, Models, etc. directories that make up your OXP.
 | style="vertical-align: top" |
 {|
 | style="border-style: solid; border-width: 1px; padding-left: 5px; padding-right: 5px" |
 Example:
- MyNewOXP_2011-11-17
+ MyNewOXP_1.0.1_2011-11-17
  +- MyNewOXP readme.txt
  +- MyNewOXP license.txt
- +- MyNewOXP_2011-11-17.oxp
+ +- MyNewOXP_1.0.1_2011-11-17.oxp
     +- Config
     +- Models
@@ Line 28: / Line 28: @@
 |}
 ==Distribution==
-# Create a zip file based on the "MyNewOXP_yyyy-mm-dd" directory and name it "MyNewOXP_yyyy-mm-dd.zip"
+# Create a zip file based on the "MyNewOXP_x.y.z_yyyy-mm-dd" directory and name it "MyNewOXP_x.y.z_yyyy-mm-dd.zip"
 #* While there are other, more efficient compression tools (such as rar, 7z), zip is available out-of-the-box on all operating systems that are officially supported by Oolite.
 #* If you are working on a Mac, please use either a compression tool like [http://www.macupdate.com/app/mac/12350/yemuzip YemuZip], or the "compress" command from the context menu in Finder followed by a run through [http://www.macupdate.com/app/mac/25497/zipcleaner ZipCleaner]. Otherwise, OS X specific files that are not relevant for other platforms will be included and lead to confusion.