Scenario system - Revision history

Bilka: Mod structure page moved to lua-api.factorio.com

2025-09-18T11:16:57Z

Mod structure page moved to lua-api.factorio.com

← Older revision		Revision as of 11:16, 18 September 2025
Line 42:		Line 42:
	Scenarios must be packaged into a mod to be distributed on the mod portal.		Scenarios must be packaged into a mod to be distributed on the mod portal.

	Inside a [~~[Tutorial~~:~~Mod_structure\|~~mod]] add a "scenarios" folder, and copy your scenario into that folder. If you created a scenario with the map editor, you can find it in the scenarios folder in your [[application directory#User_data_directory\|user data directory]].		Inside a [https://lua-api.factorio.com/latest/auxiliary/mod-structure.html mod] add a "scenarios" folder, and copy your scenario into that folder. If you created a scenario with the map editor, you can find it in the scenarios folder in your [[application directory#User_data_directory\|user data directory]].

	=== description.json ===		=== description.json ===

Bilka: /* description.json */ fixed type links

2025-06-20T15:44:35Z

description.json: fixed type links

← Older revision		Revision as of 15:44, 20 June 2025
Line 46:		Line 46:
	=== description.json ===		=== description.json ===
	A json file in the scenario folder that can have the following fields:		A json file in the scenario folder that can have the following fields:
	* multiplayer-compatible - [~~[Types~~/~~bool\|bool]~~] - Default: false		* multiplayer-compatible - [https://lua-api.factorio.com/latest/types/boolean.html boolean] - Default: false
	* is-main-game - [~~[Types~~/~~bool\|bool]~~] - Default: false		* is-main-game - [https://lua-api.factorio.com/latest/types/boolean.html boolean] - Default: false
	* order - [~~[Types~~/Order\|Order]]		* order - [https://lua-api.factorio.com/latest/types/Order.html Order]

	==== Example ====		==== Example ====

Cardinal: /* Scenario file structure */ Fixed link.

2025-04-18T12:28:45Z

Scenario file structure: Fixed link.

← Older revision		Revision as of 12:28, 18 April 2025
Line 37:		Line 37:
	== Scenario file structure ==		== Scenario file structure ==

	Scenarios do not have access to the settings stage and data stage parts of the [https://lua-api.factorio.com/latest/~~Data~~-~~Lifecycle~~.html Data Lifecycle]. This means they rely entirely on runtime scripting via the control.lua file. Scenarios can contain a [[#description.json\|description.json]] file to mark them as multiplayer compatible.		Scenarios do not have access to the settings stage and data stage parts of the [https://lua-api.factorio.com/latest/auxiliary/data-lifecycle.html Data Lifecycle]. This means they rely entirely on runtime scripting via the control.lua file. Scenarios can contain a [[#description.json\|description.json]] file to mark them as multiplayer compatible.

	=== Packaging a scenario in a mod ===		=== Packaging a scenario in a mod ===

Bilka: Categorize into modding

2023-11-13T20:36:02Z

Categorize into modding

← Older revision		Revision as of 20:36, 13 November 2023
Line 70:		Line 70:
	* [[Map generator]]		* [[Map generator]]

	{{C\|~~Main~~}}		{{C\|Modding}}

Ickputzdirwech: category main instead of technical, since this page has several translations

2023-11-12T09:09:29Z

category main instead of technical, since this page has several translations

← Older revision		Revision as of 09:09, 12 November 2023
Line 70:		Line 70:
	* [[Map generator]]		* [[Map generator]]

	{{C\|~~Technical~~}}		{{C\|Main}}

Ickputzdirwech: category

2023-09-24T19:06:45Z

Bilka: /* description.json */ typo

2023-03-01T13:41:59Z

description.json: typo

← Older revision		Revision as of 13:41, 1 March 2023
Line 45:		Line 45:

	=== description.json ===		=== description.json ===
	A json file in the scenario folder ~~than~~ can have the following fields:		A json file in the scenario folder that can have the following fields:
	* multiplayer-compatible - [[Types/bool\|bool]] - Default: false		* multiplayer-compatible - [[Types/bool\|bool]] - Default: false
	* is-main-game - [[Types/bool\|bool]] - Default: false		* is-main-game - [[Types/bool\|bool]] - Default: false

Bilka: Created scenario file structure section, moved limitations into the section

2023-02-24T16:31:02Z

Created scenario file structure section, moved limitations into the section

← Older revision		Revision as of 16:31, 24 February 2023
Line 1:		Line 1:
	{{Languages}}		{{Languages}}
	The scenario system allows save-based mods to be created, so that installing mods separately is not necessary. This allows for server side scripting, or to provide a separate objective than the vanilla freeplay (which is actually a scenario, just like the [[tutorial\|tutorial campaign]]).		The scenario system allows save-based mods to be created, so that installing mods separately is not necessary. This allows for server side scripting, or to provide a separate objective than the vanilla freeplay (which is actually a scenario, just like the [[tutorial\|tutorial campaign]]).

			Scenarios count as mods for the purpose of isolating [[achievements]].

	== Creation ==		== Creation ==
Line 15:		Line 17:
	There are a few differences between a scenario, a save, and a mod. In a way, a scenario takes parts from both.		There are a few differences between a scenario, a save, and a mod. In a way, a scenario takes parts from both.

	* Scenarios, unlike mods, cannot add ~~anything~~ to the game. The only type of scripting allowed in a scenario is scripting that would occur in control.lua.		* Scenarios, unlike mods, cannot add any prototypes to the game. The only type of scripting allowed in a scenario is scripting that would occur in control.lua.
	* Scenarios can have premade maps, such as the supply scenario, or can have maps made with the map generator, such as freeplay.		* Scenarios can have premade maps, such as the supply scenario, or can have maps made with the map generator, such as freeplay.
	* Scenarios do not need to be installed client side, unlike mods. This allows servers to implement small changes to gameplay on their end, such as displaying a MOTD to joining players.		* Scenarios do not need to be installed client side, unlike mods. This allows servers to implement small changes to gameplay on their end, such as displaying a MOTD to joining players.
	* Scenarios, unlike normal saves, are stored in a different folder.		* Scenarios, unlike normal saves, are stored in a different folder.
	* Scenarios can be used to create a bit of a story, as the campaign does.		* Scenarios can be used to create a bit of a story, as the campaign does.

	~~== Limitations of Scenarios ==~~

	* Scenarios must be packaged into a mod to be distributed on the mod portal.
	* Scenarios cannot add anything to the game (Namely, they may not make calls to data:extend()).
	* Scenarios count as mods for the purpose of isolating [[achievements]].
	* Scenarios can be packaged without an <code>info.json</code> and <code>description.json</code>, but then it won't be possible to host a new multiplayer game using this scenario.

	== Playing a scenario ==		== Playing a scenario ==
Line 40:		Line 35:
	Scenarios added by mods are also shown in the Scenarios menu.		Scenarios added by mods are also shown in the Scenarios menu.

	== Packaging a scenario as a mod ==		== Scenario file structure ==
	~~Create an empty~~ mod~~, as described in~~ [[Tutorial:Mod_structure]]~~. Then, simply~~ add a "scenarios" folder, and copy your scenario into that folder. If you created a scenario with the map editor, you can find it in the scenarios folder in your [[application directory#User_data_directory\|user data directory]].
			Scenarios do not have access to the settings stage and data stage parts of the [https://lua-api.factorio.com/latest/Data-Lifecycle.html Data Lifecycle]. This means they rely entirely on runtime scripting via the control.lua file. Scenarios can contain a [[#description.json\|description.json]] file to mark them as multiplayer compatible.

			=== Packaging a scenario in a mod ===
			Scenarios must be packaged into a mod to be distributed on the mod portal.

			Inside a [[Tutorial:Mod_structure\|mod]] add a "scenarios" folder, and copy your scenario into that folder. If you created a scenario with the map editor, you can find it in the scenarios folder in your [[application directory#User_data_directory\|user data directory]].

			=== description.json ===
			A json file in the scenario folder than can have the following fields:
			* multiplayer-compatible - [[Types/bool\|bool]] - Default: false
			* is-main-game - [[Types/bool\|bool]] - Default: false
			* order - [[Types/Order\|Order]]

			==== Example ====
			<syntaxhighlight lang="json">
			{
			"multiplayer-compatible": true,
			"order": "d"
			}
			</syntaxhighlight>

	== Localization of scenario name and description ==		=== Localization of scenario name and description ===
	Scenario name and description, which are seen in the "Start a new game" scenario selector are localised using [[Tutorial:Localisation#File_format\|locale files]] inside the scenario. The keys are <code>scenario-name</code> and <code>description</code>, both without a [category]. Example from freeplay/locale/en/freeplay.cfg:		Scenario name and description, which are seen in the "Start a new game" scenario selector are localised using [[Tutorial:Localisation#File_format\|locale files]] inside the scenario. The keys are <code>scenario-name</code> and <code>description</code>, both without a [category]. Example from freeplay/locale/en/freeplay.cfg:

Bilka: moved scenario section from Tutorial:Localisation

2023-01-18T16:15:39Z

moved scenario section from Tutorial:Localisation

← Older revision		Revision as of 16:15, 18 January 2023
Line 42:		Line 42:
	== Packaging a scenario as a mod ==		== Packaging a scenario as a mod ==
	Create an empty mod, as described in [[Tutorial:Mod_structure]]. Then, simply add a "scenarios" folder, and copy your scenario into that folder. If you created a scenario with the map editor, you can find it in the scenarios folder in your [[application directory#User_data_directory\|user data directory]].		Create an empty mod, as described in [[Tutorial:Mod_structure]]. Then, simply add a "scenarios" folder, and copy your scenario into that folder. If you created a scenario with the map editor, you can find it in the scenarios folder in your [[application directory#User_data_directory\|user data directory]].

			== Localization of scenario name and description ==
			Scenario name and description, which are seen in the "Start a new game" scenario selector are localised using [[Tutorial:Localisation#File_format\|locale files]] inside the scenario. The keys are <code>scenario-name</code> and <code>description</code>, both without a [category]. Example from freeplay/locale/en/freeplay.cfg:

			<pre>scenario-name=Freeplay
			description=Your task is to launch a rocket into space. Start from nothing, work your way up with automation, and don't forget to protect yourself from the natives.\n[font=default-bold]This is the intended way of playing Factorio.[/font]</pre>

	== See also ==		== See also ==

Stringweasel: Scenarios need a info.json to be used to host a new multiplayer game.

2022-10-22T09:05:08Z

Scenarios need a info.json to be used to host a new multiplayer game.

← Older revision		Revision as of 09:05, 22 October 2022
Line 26:		Line 26:
	* Scenarios cannot add anything to the game (Namely, they may not make calls to data:extend()).		* Scenarios cannot add anything to the game (Namely, they may not make calls to data:extend()).
	* Scenarios count as mods for the purpose of isolating [[achievements]].		* Scenarios count as mods for the purpose of isolating [[achievements]].
			* Scenarios can be packaged without an <code>info.json</code> and <code>description.json</code>, but then it won't be possible to host a new multiplayer game using this scenario.

	== Playing a scenario ==		== Playing a scenario ==

← Older revision		Revision as of 19:06, 24 September 2023
Line 69:		Line 69:
	* [[Map editor]]		* [[Map editor]]
	* [[Map generator]]		* [[Map generator]]

			{{C\|Technical}}