Scenarios.plist - Revision history

Cholmondely: Added examples

2021-10-08T10:08:35Z

Added examples

Cim: /* OXP restrictions */ Core plist cancellation

2014-12-06T15:14:43Z

‎OXP restrictions: Core plist cancellation

Cim: /* Scenario-only OXPs */ clarify

2014-09-05T19:50:07Z

‎Scenario-only OXPs: clarify

Cim: /* OXP restrictions */ Scenario-only feature

2014-09-01T21:42:52Z

‎OXP restrictions: Scenario-only feature

Cim: Adjust page, add scenario restrictions from 1.81

2014-08-10T21:00:38Z

Adjust page, add scenario restrictions from 1.81

Makarius: category

2014-03-31T06:52:14Z

Cim: scenarios.plist documentation

2014-03-29T21:10:18Z

scenarios.plist documentation

New page

The <code>scenarios.plist</code> file, from Oolite 1.79 onwards, lists the initial starting scenario files available to the player when starting a new commander.

It is a list of dictionaries with the following format:
{
"file" = "oolite-tutorial.oolite-save";
"name" = "[oolite-scenario-tutorial-name]";
"description" = "[oolite-scenario-tutorial-description]";
"model" = "coriolis-station";
"scenario" = "oolite-tutorial";
}

==description==
A text description, which will be expanded with the usual description expansion rules, summarising the scenario in a few hundred characters. Optional but strongly recommended.

==file==
The filename of the scenario file, which should be placed in the <code>Scenarios</code> folder of the OXP. A scenario file is simply an Oolite save game: you will probably find the debug console extremely useful for setting up the scenario. In general when creating scenarios you should not have any OXPs installed other than those absolutely necessary for the OXP containing the scenario, to prevent unwanted mission variables and similar items from appearing in the scenario file.

==model==
The data key of the model in <code>shipdata.plist</code> to be used for this scenario on the selection screen. This key must either:
* exist in the core [[shipdata.plist]]
* exist in your OXP's shipdata.plist
* exist in the shipdata.plist of an OXP you explicitly require to be installed through the [[manifest.plist]]
It is optional - if omitted, no model will be shown.

==name==
The name of the scenario, expanded with the usual description expansion rules. This is the name which will be shown in the selection list.

==scenario==
This key sets up the name of the scenario. If you intend the scenario to be a completely self-contained event, with a definite ending, rather than simply an alternative start position or set up for the player, then you will probably want to call [[Oolite_JavaScript_Reference:_Player#endScenario|player.endScenario]] at that point to end the game. The key here must exactly match the one used in the call to <code>player.endScenario()</code>.

This key is optional; if it is omitted, it will be impossible to end the game using that script function.

← Older revision		Revision as of 10:08, 8 October 2021
Line 65:		Line 65:
	Note that the "start new game" screen itself operates in 'default' mode, so the OXP which defines the scenario cannot have the "oolite-scenario-only" tag, or require an OXP which does, or the scenario will never actually be visible. A small "loader" OXP which contains only the scenarios must be used. (The main scenario OXP probably should require the loader OXP to make sure that it gets installed)		Note that the "start new game" screen itself operates in 'default' mode, so the OXP which defines the scenario cannot have the "oolite-scenario-only" tag, or require an OXP which does, or the scenario will never actually be visible. A small "loader" OXP which contains only the scenarios must be used. (The main scenario OXP probably should require the loader OXP to make sure that it gets installed)

−
		+	== Examples ==
		+	Currently (2021) the only examples are [[SOTL Exploration]] & [[SOTL Altmap]], both by [[User:Cim]]. They each require his Loader OXZ.

	[[Category:Oolite]]		[[Category:Oolite]]

@@ Line 50: / Line 50: @@
 * "'''id:'''identifier". Single OXP. The OXP with that identifier in its [[manifest.plist]], and any OXPs in its <code>requires_oxps</code> list (but ''not'' ones only in <code>optional_oxps</code>) will be loaded. No others will be.
 * "'''tag:'''tagname". OXP groups. Any OXPs with that tag in the tag list in their [[manifest.plist]]s, and any OXPs in their <code>requires_oxps</code> list (but ''not'' ones only in <code>optional_oxps</code>) will be loaded. No others will be.
 (If A requires B, which itself requires C, then both B and C will be loaded if A is allowed)

@@ Line 56: / Line 56: @@
 ====Scenario-only OXPs====
-Normally an OXP will always be loaded unless excluded by the scenario. For OXPs which make major changes, it may only be appropriate to load them in particular scenarios and not in normal play. This can be achieved by adding the tag "oolite-scenario-only" to the tag list, as well as the tag or identifier required by the scenario.
+Normally an OXP will always be loaded unless excluded by the scenario. For OXPs which make major changes, it may only be appropriate to load them in particular scenarios and not in normal play. This can be achieved by adding the tag "oolite-scenario-only" to the tag list in its [[manifest.plist]], as well as the tag or identifier required by the scenario.
 Note that the "start new game" screen itself operates in 'default' mode, so the OXP which defines the scenario cannot have the "oolite-scenario-only" tag, or require an OXP which does, or the scenario will never actually be visible. A small "loader" OXP which contains only the scenarios must be used. (The main scenario OXP probably should require the loader OXP to make sure that it gets installed)

@@ Line 46: / Line 46: @@
 The following restriction types are available:
-* "" ('''Empty string'''). The default - all OXPs are available
+* "" ('''Empty string'''). The default - all OXPs are available except those with the tag "oolite-scenario-only" in their tag list
 * "'''strict'''". Strict mode - no OXPs are available
 * "'''id:'''identifier". Single OXP. The OXP with that identifier in its [[manifest.plist]], and any OXPs in its <code>requires_oxps</code> list (but ''not'' ones only in <code>optional_oxps</code>) will be loaded. No others will be.
@@ Line 54: / Line 54: @@
 The Oolite Tutorial has the restriction "tag:oolite-tutorial-compatible"
 [[Category:Oolite]]

← Older revision		Revision as of 06:52, 31 March 2014
Line 30:		Line 30:

	This key is optional; if it is omitted, it will be impossible to end the game using that script function.		This key is optional; if it is omitted, it will be impossible to end the game using that script function.
		+
		+	[[Category:Oolite]]
		+	[[Category:Oolite scripting]]

@@ Line 10: / Line 10: @@
+ 	}
-==description==
+==Plist keys==
 A text description, which will be expanded with the usual description expansion rules, summarising the scenario in a few hundred characters. Optional but strongly recommended.
-==file==
+===file===
 The filename of the scenario file, which should be placed in the <code>Scenarios</code> folder of the OXP. A scenario file is simply an Oolite save game: you will probably find the debug console extremely useful for setting up the scenario. In general when creating scenarios you should not have any OXPs installed other than those absolutely necessary for the OXP containing the scenario, to prevent unwanted mission variables and similar items from appearing in the scenario file.
-==model==
+===model===
 The data key of the model in <code>shipdata.plist</code> to be used for this scenario on the selection screen. This key must either:
 * exist in the core [[shipdata.plist]]
@@ Line 23: / Line 23: @@
 It is optional - if omitted, no model will be shown.
-==name==
+===name===
 The name of the scenario, expanded with the usual description expansion rules. This is the name which will be shown in the selection list.
-==scenario==
+===scenario===
 This key sets up the name of the scenario. If you intend the scenario to be a completely self-contained event, with a definite ending, rather than simply an alternative start position or set up for the player, then you will probably want to call [[Oolite_JavaScript_Reference:_Player#endScenario|player.endScenario]] at that point to end the game. The key here must exactly match the one used in the call to <code>player.endScenario()</code>.
 This key is optional; if it is omitted, it will be impossible to end the game using that script function.
 [[Category:Oolite]]