Difference between revisions of "How to tweak OXZ's"

From Elite Wiki
(Reference Pages: Added Massively Locked's introduction to Javascript)
m (updated link)
 
Line 59: Line 59:
 
=== Reference Pages ===
 
=== Reference Pages ===
 
*[[:Category:Oolite scripting]]
 
*[[:Category:Oolite scripting]]
*[[Testxyz js basics wip]] This is a very helpful layman's introduction to what Javascript is - and how it interfaces with Oolite
+
*[[Oolite Javascript basics]] This is a very helpful layman's introduction to what Javascript is - and how it interfaces with Oolite
  
 
=== Other advice pages ===
 
=== Other advice pages ===

Latest revision as of 19:44, 5 October 2022

Tweaking OXZs

OXZ's usually live in your ManagedAddOns folder (but still work if lurking in your AddOns folder!).

  • To tweak an OXZ, you expand it, rewrite part of the code (following the instructions), and then repackage it as an OXP.
  • You then put the tweaked OXP in your AddOns folder.
  • You then restart the game holding down the shift button.

When you next dive into the entrails of the in-game Expansions Manager you will notice that that Expansion is now listed in red!

  • Note that you can directly download the OXZ in expanded state into your AddOns folder by pressing x when the Expansion is highlighted. The expanded expansion will have an .off extension superadded to the folder.
  • Note that the old OXZ if you have already downloaded one remains in your Managed Expansions folder.
  • Note also that the OXPs in your AddOns folder trump the OXZs in your Managed Expansions folder.
  • Note also that an OXZ is just a zipped OXP - there is essentially no difference between the two... Reval recommends adding a simple step to the tweaking process: create a folder in AddOns with an .oxp extension, and unzip the contents of the oxz to it (after renaming it .zip). Presto! - an OXP.
  • An OXZ, to be accepted, must also contain a manifest.plist, (it is basically a zipped version of the entire OXP with an added manifest.plist) whereas a pure OXP needs only a requires.plist. Reval's belt'n'braces approach is to include both.

Tweaking OXPs

OXP's live in your AddOns folder.

  • These are easier - they do not need unzipping/rezipping.
  • Just edit the file name to replace the .oxp ending with .txt - it will transmogrify into a folder. Do your deeds of derring do (see the rest of this page). To return your folder to being an .oxp, just edit the folder name and put .oxp at the end! Pop it into your AddOns folder, and restart the game with the shift button held down.

Warning!

Some text editors (eg Windows) add extra lines of invisible text, turning your finely hand-crafted .oxp into gibberish! See Links below for other text editors.

And if you are copying code from the BB, you might find you've included somebody else's invisible text!

When copying code from the BB it's always better to hit the "quote" button and copy from the typing window. (Just don't press the "Submit" button after you're finished!) See the discussion here.

Links

  • OXP for details on finding the ManagedAddOns & AddOns Folders for AppleMac, Windows & Linux.
  • BB Thread with more detail and a lo-o-ong list of tweaks.
  • Suggestions for change to the system of doing this.
  • Aegidian's views on tweaking (and on OXZ's generally!): here. Tweaking an OXP is easier than doing the same to an OXZ.

Assorted tweaks

Tweaking OXPs

Tweaking game code

Reference Pages

Other advice pages

  • How do I ... dock / succeed in trading / win a fight / configure my controller/joystick etc