OXP howto plist - Revision history

Cholmondely: Added link to OXP Verifier, structure

2021-10-06T17:49:35Z

Added link to OXP Verifier, structure

Cholmondely: Tagged as Legacy scripting

2021-08-09T09:47:00Z

Tagged as Legacy scripting

ADCK: /* shipdata.plist */ fixed link

2010-05-21T05:20:04Z

‎shipdata.plist: fixed link

Commander McLane: added category Oolite scripting

2009-09-08T12:39:29Z

added category Oolite scripting

Murgh: insert for Ahruman's overview

2006-07-04T00:22:12Z

insert for Ahruman's overview

Murgh: /* example 2 */ typo

2006-01-31T11:05:57Z

‎example 2: typo

Murgh: more tutorial

2006-01-31T11:02:57Z

Rxke: /* ''shipdata.plist'' */

2006-01-24T18:20:22Z

‎''shipdata.plist''

Murgh: better plutil

2006-01-23T09:19:37Z

better plutil

Arexack: /* ''script.plist'' */

2006-01-23T01:17:04Z

‎''script.plist''

@@ Line 9: / Line 9: @@
 A good way to learn the correct way to make plists, is to examine the ones found within Oolite and working OXPs. The format is ideal to freely copy/paste items between various lists, and alter them as desired.  This also minimizes the chance of little parser errors.
 Since a very small mistake is enough to stop a plist from being accepted, it's important to be exact about every letter and sign. The Mac Terminal utility has a very practical tool for catching parser errors. After opening Terminal, simply type '''plutil''', add one space, and drag and drop the plist in question onto the Terminal window. This will cause the 'address' of the plist to be shown.  Hit return, and Terminal will reveal whether or not the plist is OK.  If it's not, you will be given a clue to what is wrong, and the line number of the error.
-== Basic Examples  ==
+== Basic Examples of plists ==
 The plists for a very simple OXP, for instance one containing a space advertising billboard, could contain this:

← Older revision		Revision as of 09:47, 9 August 2021
Line 215:		Line 215:

	[[Category:Oolite]]		[[Category:Oolite]]
−	[[Category:Oolite scripting]]	+	[[Category:Oolite scripting]] [[Category:Legacy scripting]]

@@ Line 74: / Line 74: @@
 This is the only mandatory plist inside folder ''Config'', to accompany the model named billboard1.dat in ''Models'', and billboard1_texture.png in ''Textures'', which would complete the minimal billboard.oxp, placing a slow spinning, lifeless object into the game.
-Because ''roles'' contains asteroid(0.05), this should cause our billboard to have a rare (and weird) appearance in the middle of an [[asteroid]] field.  This is a little awkward and not much chance of seeing our model frequently, so we would make a small addition to ''roles''.
+Because ''roles'' contains asteroid(0.05), this should cause our billboard to have a rare (and weird) appearance in the middle of an [[Asteroid_(Oolite)|asteroid]] field.  This is a little awkward and not much chance of seeing our model frequently, so we would make a small addition to ''roles''.
        <key>roles</key>
@@ Line 80: / Line 80: @@
 and include another plist in order to force an appearance of our model.  This by either a [[script.plist]] or [[planetinfo.plist]].
 === ''[[script.plist]]'' ===

← Older revision		Revision as of 12:39, 8 September 2009
Line 216:		Line 216:

	[[Category:Oolite]]		[[Category:Oolite]]
		+	[[Category:Oolite scripting]]

@@ Line 1: / Line 1: @@
 [[Image:plist-XML-ASCII-ill.png|thumb|right|300px|the plist formats, XML and ASCII]]
-== To Begin ==
+== plist ==
 Since a very small mistake is enough to stop a plist from being accepted, it's important to be exact about every letter and sign. The Mac Terminal utility has a very practical tool for catching parser errors. After opening Terminal, simply type '''plutil''', add one space, and drag and drop the plist in question onto the Terminal window. This will cause the 'address' of the plist to be shown.  Hit return, and Terminal will reveal whether or not the plist is OK.  If it's not, you will be given a clue to what is wrong, and the line number of the error.
 == Basic Examples  ==
@@ Line 31: / Line 22: @@
  <?xml version="1.0" encoding="UTF-8"?>
- <!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+ <!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "<nowiki>http://www.apple.com/DTDs/PropertyList-1.0.dtd">
- <plist version="1.0">
+ <plist version="1.0"></nowiki>
  <dict>
     <key>billboard1</key>
@@ Line 98: / Line 89: @@
  <?xml version="1.0" encoding="UTF-8"?>
- <!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+ <!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "<nowiki>http://www.apple.com/DTDs/PropertyList-1.0.dtd">
- <plist version="1.0">
+ <plist version="1.0"></nowiki>
  <dict>
     <key>billboard_at_witchpoint</key>
@@ Line 145: / Line 136: @@
 === ''[[planetinfo.plist]]'' ===
-As the above scripts are a very general method of summoning our entity (although scripts could easily be a great deal more specific!), the [[planetinfo.plist]] gives an easy oportunity to be specific within a system. Used for many things including customizing planets and system data, its also simple to add [[script_actions]] for an entity appearance.
+As the above scripts are a very general method of summoning our entity (although scripts could easily be a great deal more specific!), the [[planetinfo.plist]] gives an easy oportunity to be specific within a system. Used for many things including customizing planets and system data, its also simple to add [[Shipdata.plist#script_actions|script_actions]] for an entity appearance.
 ==== example 1 ====
@@ Line 187: / Line 178: @@
 Note that coordinates such as these are not interchangable between planets, as stations will be located at different places from system to system.
-== WrapUp ==
+==== example 3 ====
-So put your shipdata and your script or planetinfo into the ''Config'' folder which, along with ''Textures'' and ''Models'', is placed in a folder to be named '''billboard.oxp'''. These are just a very few of the plist options for a model OXP, but enough to introduce an entity into the game universe.
+Place your shipdata and your script or planetinfo into the ''Config'' folder which, along with ''Textures'' and ''Models'', is placed in a folder to be named '''billboard.oxp'''. These are just a very few of the plist options for a model OXP, but enough to introduce an entity into the game universe.

@@ Line 183: / Line 183: @@
-This is unnecessarily complex for a virgin planetinfo experiment, but goes to show how specific one may be. In this case, ''addSystemShips'' is replaced with ''addShipsAt'', and what follows is a quite exact destination using the ''coordinate scheme'' (as described in [[Methods]]) . The numbers following '''pwm''' plots a point very close to the Lave station buoy, and using ''addShipsAtPrecisely'' would do so to even more exactl degree.  To see the pwm coordinates at any time in space, press ''shift-f''.
+This is unnecessarily complex for a virgin planetinfo experiment, but goes to show how specific one may be. In this case, ''addSystemShips'' is replaced with ''addShipsAt'', and what follows is a quite exact destination using the ''coordinate scheme'' (as described in [[Methods]]) . The numbers following '''pwm''' plots a point very close to the Lave station buoy, and using ''addShipsAtPrecisely'' would do so to an even more specific degree.  To see the pwm coordinates at any time while flying in space, press '''shift-f'''.
 Note that coordinates such as these are not interchangable between planets, as stations will be located at different places from system to system.
 == WrapUp ==

@@ Line 10: / Line 10: @@
  <plist version="1.0">
-...the various types of plist data will make up the body, and then in closing...
+...the various types of data will make up the body, and then in closing...
  </plist>
@@ Line 18: / Line 18: @@
 == Correcting with PLUTIL (Macintosh) ==
-Since a very small mistake is enough to stop a plist from being accepted, it's important to be exact about every letter and sign. The Mac Terminal utility has a very practical tool for catching parser errors. After opening Terminal, simply type '''plutil''', add one space, and drag and drop the plist in question onto the Terminal window. This will cause the 'address' of the plist to be shown.  Hit return, and Terminal will reveal whether or not the plist is OK.  If it's not, you will be given a clue what is wrong, and the line number of the error.
+Since a very small mistake is enough to stop a plist from being accepted, it's important to be exact about every letter and sign. The Mac Terminal utility has a very practical tool for catching parser errors. After opening Terminal, simply type '''plutil''', add one space, and drag and drop the plist in question onto the Terminal window. This will cause the 'address' of the plist to be shown.  Hit return, and Terminal will reveal whether or not the plist is OK.  If it's not, you will be given a clue to what is wrong, and the line number of the error.
@@ Line 24: / Line 24: @@
 == Basic Examples  ==
-The plists for a very simple OXP, for instance one containing a space advertising billboard, will contain this:
+The plists for a very simple OXP, for instance one containing a space advertising billboard, could contain this:
 ===  ''[[shipdata.plist]]'' ===
@@ Line 71: / Line 71: @@
        <string>Billboard</string>
        <key>roles</key>
-       <string>billboard advertising asteroid(0.05)</string>
+       <string>asteroid(0.05)</string>
        <key>scanClass</key>
        <string>CLASS_ROCK</string>
        <key>thrust</key>
-       <real>0.0</real>
+       <real>0.05</real>
        </dict>
  </dict>
@@ Line 83: / Line 83: @@
 This is the only mandatory plist inside folder ''Config'', to accompany the model named billboard1.dat in ''Models'', and billboard1_texture.png in ''Textures'', which would complete the minimal billboard.oxp, placing a slow spinning, lifeless object into the game.
-Because ''roles'' contains asteroid(0.05), this should cause our billboard to have a rare (and odd) appearance in the middle of an [[asteroid]] field.  This isn't much, so we include another plist.
+Because ''roles'' contains asteroid(0.05), this should cause our billboard to have a rare (and weird) appearance in the middle of an [[asteroid]] field.  This is a little awkward and not much chance of seeing our model frequently, so we would make a small addition to ''roles''.
 === ''[[script.plist]]'' ===
  <?xml version="1.0" encoding="UTF-8"?>
@@ Line 108: / Line 112: @@
-This will ensure that one entity with the ''role'' 'billboard' will pop up at the Witchpoint every time a player arrives.
+This will ensure that one entity with the ''role'' 'billboard' will pop up at the Witchpoint every time a player arrives.  A very simple 'rendezvous' script.
-Include this in the ''Config'' folder which is placed along with ''Textures'' and ''Models'' in a folder to be named billboard.oxp. These are the bare plist essentials for a model OXP.
+So put your shipdata and your script or planetinfo into the ''Config'' folder which, along with ''Textures'' and ''Models'', is placed in a folder to be named '''billboard.oxp'''. These are just a very few of the plist options for a model OXP, but enough to introduce an entity into the game universe.

@@ Line 14: / Line 14: @@
  </plist>
-There is no better way to learn the correct way to make plists, than to examine the working ones found within Oolite and OXPs. The format lends itself to easily copy/paste desired items, and change them as fancied.  This also minimizes the chance of little parser errors.
+There is no better way to learn the correct way to make plists, than to examine the ones found within Oolite and working OXPs. The format lends itself to easily copy/paste desired items, and change them as fancied.  This also minimizes the chance of little parser errors.
-== Correcting ==
+== Correcting with PLUTIL (Macintosh) ==
-Since a very small mistake is enough to stop a plist from being accepted, it's important to be exact about every letter and sign. The Mac Terminal utility has a very practical tool for catching parser errors. After opening Terminal, simply type '''plutil''', add one space, and drag and drop the plist in question onto the Terminal window. Hit return, and Terminal will reveal whether or not the plist is OK.  If it's not, you will be given a clue what is wrong, and the line number of the error.
+Since a very small mistake is enough to stop a plist from being accepted, it's important to be exact about every letter and sign. The Mac Terminal utility has a very practical tool for catching parser errors. After opening Terminal, simply type '''plutil''', add one space, and drag and drop the plist in question onto the Terminal window. This will cause the 'address' of the plist to be shown.  Hit return, and Terminal will reveal whether or not the plist is OK.  If it's not, you will be given a clue what is wrong, and the line number of the error.

← Older revision		Revision as of 01:17, 23 January 2006
Line 112:		Line 112:

	Include this in the ''Config'' folder which is placed along with ''Textures'' and ''Models'' in a folder to be named billboard.oxp. These are the bare plist essentials for a model OXP.		Include this in the ''Config'' folder which is placed along with ''Textures'' and ''Models'' in a folder to be named billboard.oxp. These are the bare plist essentials for a model OXP.
−