Difference between revisions of "Requires.plist"
From Elite Wiki
(Created page with "==Structure== The file is organized as a dictionary with pairs of key and value. { version = "1.76.1"; max_version = "1.76.99"; } ==Use== Every OXP should contain a ...") |
Cholmondely (talk | contribs) (Noted that this is deprecated and added why the manifest.plist is superior) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
| + | This .plist is deprecated and the [[Manifest.plist]] should be used instead. | ||
| + | |||
==Structure== | ==Structure== | ||
The file is organized as a dictionary with pairs of key and value. | The file is organized as a dictionary with pairs of key and value. | ||
| + | |||
| + | PList example: | ||
{ | { | ||
| Line 6: | Line 10: | ||
max_version = "1.76.99"; | 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== | ==Use== | ||
| Line 12: | Line 29: | ||
:;''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. | :;''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. | :;''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. | ||
| + | |||
| + | === Deprecation === | ||
| + | This still works. But the [[Manifest.plist]] does all this and much, much more (and, crucially, it is what the in-game [[Expansions Manager]] relies on). | ||
==Links== | ==Links== | ||
Latest revision as of 08:49, 27 July 2025
This .plist is deprecated and the Manifest.plist should be used instead.
Contents
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.
Deprecation
This still works. But the Manifest.plist does all this and much, much more (and, crucially, it is what the in-game Expansions Manager relies on).
