OXP howto - Revision history

Cholmondely: /* Scripting with JavaScript */ Added note about legacy scripting

2021-12-05T12:09:49Z

‎Scripting with JavaScript: Added note about legacy scripting

Cholmondely: /* OXP tutorials */ Added link

2021-11-24T19:43:40Z

‎OXP tutorials: Added link

Cholmondely: /* Models */ Added note

2021-11-08T09:25:43Z

‎Models: Added note

Cholmondely: /* See Also */ Added more links

2021-11-06T20:00:42Z

‎See Also: Added more links

Cholmondely: /* Scripting with JavaScript */ Added link

2021-10-18T17:59:40Z

‎Scripting with JavaScript: Added link

Cholmondely: /* OXP Verifier */ Added detail

2021-10-06T17:46:34Z

‎OXP Verifier: Added detail

Cholmondely: /* OXP Verifier */ tweak

2021-10-06T17:45:07Z

‎OXP Verifier: tweak

Cholmondely: /* OXP Verifier */ Another link, explanations

2021-09-12T13:40:55Z

‎OXP Verifier: Another link, explanations

Cholmondely: /* OXP Verifier */ Added link

2021-09-12T13:30:12Z

‎OXP Verifier: Added link

Cholmondely: Added quote from Cim

2021-09-12T12:15:24Z

Added quote from Cim

← Older revision		Revision as of 12:09, 5 December 2021
Line 158:		Line 158:

	JavaScript is the preferred scripting interface for worldScripts and shipScripts. The legacy scripting interface (see [[script.plist]]) still works, but is not supported. See [[Scripting Oolite with JavaScript]] for more information.		JavaScript is the preferred scripting interface for worldScripts and shipScripts. The legacy scripting interface (see [[script.plist]]) still works, but is not supported. See [[Scripting Oolite with JavaScript]] for more information.
		+
		+	Note that most of the [[Legacy Scripting]] still works perfectly well (XML & OpenStep)!

	==Hidden settings==		==Hidden settings==

@@ Line 186: / Line 186: @@
 Oolite changes affecting different varieties of OXPs happened with v.1.76 (2011), v.1.80 (2014) & v1.82 (2015).
 *[http://www.aegidian.org/bb/viewtopic.php?f=4&t=20937 MasterClass: How to OXP (updating SoThisTC)] by [[User:Spara|Spara]] who teaches computing in Helsinki! (2021)
-*[https://archive.org/details/GettingStartedWithOoliteOXZDevelopment Getting started with OXZ Development] ''An .odt for Open Office'': By Bugbear (2012). 2 example OXPs: a pirate-ridden solar systems warning tool & Witchspace Blockades
+*[https://archive.org/details/GettingStartedWithOoliteOXZDevelopment Getting started with OXZ Development] ''An .odt for Open Office'': By Bugbear (2012). 2 example OXPs: a pirate-ridden solar systems warning tool & Witchspace Blockades [http://www.aegidian.org/bb/viewtopic.php?f=4&t=17731 BB Thread (2015)]
 *[[OXP_tutorial|OXP Tutorial]] creating a new spaceship - and then tweaking it in different ways (2007-13)
 *[[OXP howto dockable stations|Creating a dockable station]] (2009-10)

@@ Line 100: / Line 100: @@
 Oolite models need to be in an Oolite specific format using the the '''.dat''' file extension. There are utilities available that convert models made in Wings 3D (.obj) and Meshwork (.mesh) into this. A .dat file can be opened in a plain text editor to view the object's assigned texture names and see that they correspond with the actual file names in the Textures folder. The .dat file must be named exactly as it is referenced in the shipdata ''model'' entry - case sensitive!!!
-* [[OXP howto model|Making Oolite models]]
+* [[OXP howto model|Making Oolite models]] - tutorials for Wings3D & Blender, notes on sub-entities, links ''etc''.
-* http://aegidian.org/bb/viewtopic.php?f=4&t=12165
+* [http://aegidian.org/bb/viewtopic.php?f=4&t=12165 Model Converter utilities] (2012-17)
-* Video: [http://aegidian.org/bb/viewtopic.php?f=4&t=16123 From scratch to Mamba in under an hour]
+* Video: [http://aegidian.org/bb/viewtopic.php?f=4&t=16123 From scratch to Mamba in under an hour] ([[Dertien]], 2013)
 ===Scripts===

@@ Line 166: / Line 166: @@
 *It is often helpful to dip one's toes (claws?) in the water by experimenting with tweaking oxp's first: see [[How to tweak OXZ's]]
 *[[:Category:Oolite scripting]]
 *[[:Category:Oolite Development]]
 *[[User:Montana05|Montana05]] recommends https://www.w3schools.com/js/js_array_sort.asp for better knowledge of the js on Oolite.

@@ Line 155: / Line 155: @@
 ==Scripting with JavaScript==
-Older OXPs (from [[User:Aegidian|Aegidian]]'s day were written in Legacy Script: see [[Methods]]. Modern OXPs are written in JavaScript. Specifically oolite.jsVersion 185, an Oolite specific variant of '''ECMAv5'''. It is the same Spidermonkey version that Firefox 4 shipped with many years ago, but it is a special build for Oolite. This is the version that we have almost always had and it has not changed between versions of the game. It is unlikely to change in the future.
+Older OXPs (from [[User:Aegidian|Aegidian]]'s day were written in Legacy Script: see [[Methods]]. Modern OXPs are written in JavaScript. Specifically oolite.jsVersion 185, an Oolite specific variant of '''ECMAv5'''. It is the same Spidermonkey version that Firefox 4 shipped with many years ago, but it is a special build for Oolite. This is the version that we have almost always had and it has not changed between versions of the game. [http://aegidian.org/bb/viewtopic.php?p=256623#p256623 It is unlikely to change] in the future.
 JavaScript is the preferred scripting interface for worldScripts and shipScripts. The legacy scripting interface (see [[script.plist]]) still works, but is not supported. See [[Scripting Oolite with JavaScript]] for more information.

@@ Line 143: / Line 143: @@
 === BB thread ===
 *[http://www.aegidian.org/bb/viewtopic.php?f=8&t=13400 plist Editor Pro for Windows] (2013 - full of relevant Red Herrings)
 ==Unique names==

@@ Line 126: / Line 126: @@
 ==OXP Verifier==
-Oolite has what amounts to a spell checker for shipdata.plist and other some plists, called the OXP verifier. The verifier detects unknown keys or wrong use of keys etc. It can currently only be invoked from the command line.
+Oolite has what amounts to a spell checker for shipdata.plist and some other plists, called the OXP verifier. The verifier detects unknown keys or wrong use of keys etc. It can currently only be invoked from the command line.
 On Windows or Linux:

← Older revision		Revision as of 13:40, 12 September 2021
Line 136:		Line 136:
	'''Oolite.app/Contents/MacOS/Oolite --verify-oxp <path to OXP>'''		'''Oolite.app/Contents/MacOS/Oolite --verify-oxp <path to OXP>'''

−	Most mac users will not be familiar to using the command line. Look inside your application folder for a utilities folder. Inside that you will find a program called terminal. Run it to open a terminal window. Now drop the oolite application on that window. That will generate the path to oolite on the command line. Delete the trailing space and paste the following text - including the trailing space- behind it: "/Contents/MacOS/Oolite --verify-oxp ". Now drop the oxp you want to verify on the window. That will again create the path to the oxp behind the last entry. When you select the window and hit the <return> key, the verification will start. It should now open the console program, showing the results.
		+	Most Mac users will not be familiar with using the command line. Look inside your application folder for a '''utilities folder'''. Inside that you will find a program called [https://en.wikipedia.org/wiki/Terminal_(macOS) Terminal]. <br>
		+	Run it to open a terminal window. Now drop the oolite application on that window. That will generate the path to oolite on the command line. Delete the trailing space and paste the following text - including the trailing space- behind it: "/Contents/MacOS/Oolite --verify-oxp ". Now drop the oxp you want to verify on the window. That will again create the path to the oxp behind the last entry. <br>
		+	When you select the window and hit the <return> key, the verification will start. It should now open the Console program, showing the results. <br>
		+	'''Console''' is a log viewer developed by Apple Inc. and included with macOS, also in the utilities folder. It allows users to search through all of the system's logged messages, and can alert the user when certain types of messages are logged. The Console is generally used for troubleshooting when there is a problem with the computer. MacOS itself, as well as any applications that are used, send a constant stream of messages to the system in the form of log files. The console allows you to read the system logs, help find certain ones, monitor them, and filter their contents.

	=== BB thread ===		=== BB thread ===

← Older revision		Revision as of 13:30, 12 September 2021
Line 137:		Line 137:

	Most mac users will not be familiar to using the command line. Look inside your application folder for a utilities folder. Inside that you will find a program called terminal. Run it to open a terminal window. Now drop the oolite application on that window. That will generate the path to oolite on the command line. Delete the trailing space and paste the following text - including the trailing space- behind it: "/Contents/MacOS/Oolite --verify-oxp ". Now drop the oxp you want to verify on the window. That will again create the path to the oxp behind the last entry. When you select the window and hit the <return> key, the verification will start. It should now open the console program, showing the results.		Most mac users will not be familiar to using the command line. Look inside your application folder for a utilities folder. Inside that you will find a program called terminal. Run it to open a terminal window. Now drop the oolite application on that window. That will generate the path to oolite on the command line. Delete the trailing space and paste the following text - including the trailing space- behind it: "/Contents/MacOS/Oolite --verify-oxp ". Now drop the oxp you want to verify on the window. That will again create the path to the oxp behind the last entry. When you select the window and hit the <return> key, the verification will start. It should now open the console program, showing the results.
		+
		+	=== BB thread ===
		+	*[http://www.aegidian.org/bb/viewtopic.php?f=8&t=13400 plist Editor Pro for Windows] (2013 - full of relevant Red Herrings)

	==Unique names==		==Unique names==

← Older revision		Revision as of 12:15, 12 September 2021
Line 5:		Line 5:

	To learn starting with a non-compressed version have a look at [[OXP_tutorial]].		To learn starting with a non-compressed version have a look at [[OXP_tutorial]].
		+
		+	{{QuoteText\|Text=It's worth saying I think that compared with a lot of game addon architectures, the OXP architecture as designed by Giles is already very good at avoiding conflicts compared with a lot of other games
		+	- you can save your game, add, remove and upgrade lots of OXPs, load your game, and have it work
		+	- you can do this repeatedly, while incrementally upgrading the core game, for years
		+	- as a player you basically never have to care about load order; as an OXP developer, rarely
		+
		+	It's also worth noting that a lot of types of OXP conflicts are inevitable due to resource conflicts - a planet can only have one diffuse map, a ship can only have one AI - or due to conceptual conflicts - OXP A removes all stations from a system; OXP B expects the player to dock there.\|Source=([http://aegidian.org/bb/viewtopic.php?p=241733#p241733 Cim (3rd Lead Developer)])}}

	==OXZ==		==OXZ==