Requires.plist

From Elite Wiki
Revision as of 20:35, 27 July 2023 by Hiran (talk | contribs) (Structure)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Structure

The file is organized as a dictionary with pairs of key and value.

PList example:

{
  version = "1.76.1";
  max_version = "1.76.99";
}

XML example:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
	<key>version</key>
	<string>1.76.1</string>
	<key>max_version</key>
	<string>1.76.99</string>
</dict>
</plist>

Use

Every OXP should contain a Property lists with the name requires.plist that is placed at the main level of the oxp folder.

version
is the lowest Oolite version the code can run on. This ensures that older Oolite versions don't behave bad or crash because they load an OXP that does contain unknown stuff.
max_version
is only needed when you want an OXP to not run with newer Oolite versions. Very useful for adding in test versions to ensure this test version is not used forever.

Links