Tutorial:Mod structure - Revision history

Bilka: Protected "Tutorial:Mod structure": Moved to lua-api.factorio.com ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2025-09-18T11:09:16Z

Protected "Tutorial:Mod structure": Moved to lua-api.factorio.com ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

← Older revision		Revision as of 11:09, 18 September 2025
(No difference)

Bilka: Moved to lua-api.factorio.com

2025-09-18T11:08:44Z

Moved to lua-api.factorio.com

Show changes

Meifraye: Add missing DLC feature flag

2025-02-25T15:06:00Z

Add missing DLC feature flag

@@ Line 122: / Line 122: @@
 :* <code>~</code> for a dependency that does not affect load order
 :* no prefix for a hard requirement for the other mod.
 == See also ==

Bilka: typo

2024-01-09T21:54:47Z

typo

← Older revision		Revision as of 21:54, 9 January 2024
Line 22:		Line 22:
	* scenarios — Custom [[scenario system\|scenarios]] can be placed in subfolders of this folder.		* scenarios — Custom [[scenario system\|scenarios]] can be placed in subfolders of this folder.
	* campaigns — Custom campaigns can be placed in subfolders of this folder.		* campaigns — Custom campaigns can be placed in subfolders of this folder.
	* tutorials — Custom [https://lua-api.factorio.com/latest/prototypes/TutorialDefinition.html ~~tutorials~~] scenarios can be placed in subfolders of this folder.		* tutorials — Custom [https://lua-api.factorio.com/latest/prototypes/TutorialDefinition.html tutorial] scenarios can be placed in subfolders of this folder.
	* migrations — [https://lua-api.factorio.com/latest/auxiliary/migrations.html Migration files] are placed in this folder. They are a way to handle prototype changes and mod data structure changes between mod versions or game versions.		* migrations — [https://lua-api.factorio.com/latest/auxiliary/migrations.html Migration files] are placed in this folder. They are a way to handle prototype changes and mod data structure changes between mod versions or game versions.

Bilka: Link to new prototype docs

2024-01-09T21:45:23Z

Link to new prototype docs

← Older revision		Revision as of 21:45, 9 January 2024
Line 22:		Line 22:
	* scenarios — Custom [[scenario system\|scenarios]] can be placed in subfolders of this folder.		* scenarios — Custom [[scenario system\|scenarios]] can be placed in subfolders of this folder.
	* campaigns — Custom campaigns can be placed in subfolders of this folder.		* campaigns — Custom campaigns can be placed in subfolders of this folder.
	* tutorials — Custom [~~[Prototype~~/~~Tutorial\|~~tutorials]] scenarios can be placed in subfolders of this folder.		* tutorials — Custom [https://lua-api.factorio.com/latest/prototypes/TutorialDefinition.html tutorials] scenarios can be placed in subfolders of this folder.
	* migrations — [https://lua-api.factorio.com/latest/auxiliary/migrations.html Migration files] are placed in this folder. They are a way to handle prototype changes and mod data structure changes between mod versions or game versions.		* migrations — [https://lua-api.factorio.com/latest/auxiliary/migrations.html Migration files] are placed in this folder. They are a way to handle prototype changes and mod data structure changes between mod versions or game versions.

Bilka: make clear that tutorials are scenarios

2024-01-09T21:44:45Z

make clear that tutorials are scenarios

← Older revision		Revision as of 21:44, 9 January 2024
Line 22:		Line 22:
	* scenarios — Custom [[scenario system\|scenarios]] can be placed in subfolders of this folder.		* scenarios — Custom [[scenario system\|scenarios]] can be placed in subfolders of this folder.
	* campaigns — Custom campaigns can be placed in subfolders of this folder.		* campaigns — Custom campaigns can be placed in subfolders of this folder.
	* tutorials — Custom [[Prototype/Tutorial\|tutorials]] can be placed in subfolders of this folder.		* tutorials — Custom [[Prototype/Tutorial\|tutorials]] scenarios can be placed in subfolders of this folder.
	* migrations — [https://lua-api.factorio.com/latest/auxiliary/migrations.html Migration files] are placed in this folder. They are a way to handle prototype changes and mod data structure changes between mod versions or game versions.		* migrations — [https://lua-api.factorio.com/latest/auxiliary/migrations.html Migration files] are placed in this folder. They are a way to handle prototype changes and mod data structure changes between mod versions or game versions.

Bilka: Translations of the modding tutorials are allowed

2023-11-13T20:43:14Z

Translations of the modding tutorials are allowed

← Older revision		Revision as of 20:43, 13 November 2023
Line 1:		Line 1:
	Mods are expected to have a certain structure in order to be loaded by the game. This page aims to explain that file structure and what each file is used for.		{{Languages}}Mods are expected to have a certain structure in order to be loaded by the game. This page aims to explain that file structure and what each file is used for.

	== Mod folder and file structure ==		== Mod folder and file structure ==

Ickputzdirwech: Removed {{Languages}}. added category modding

2023-11-12T09:34:36Z

Removed {{Languages}}. added category modding

← Older revision		Revision as of 09:34, 12 November 2023
Line 1:		Line 1:
	~~{{Languages}}~~Mods are expected to have a certain structure in order to be loaded by the game. This page aims to explain that file structure and what each file is used for.		Mods are expected to have a certain structure in order to be loaded by the game. This page aims to explain that file structure and what each file is used for.

	== Mod folder and file structure ==		== Mod folder and file structure ==

	The mod must either be in a folder, or in a folder inside a zip file. The mod folder (no zip file) must either be named in the pattern of <code>{mod-name}_{version-number}</code> or just <code>{mod-name}</code>, for example <code>test-mod-thing</code>. The mod zip must be named in the pattern of <code>{mod-name}_{version-number}</code>, for example <code>test-mod-thing_0.0.1</code>. When using a zip file for the mod, the folder inside the zip file does not have any naming restrictions; only the zip file itself must be named with the <code>{mod-name}_{version-number}</code> pattern. The mod name and its version number are defined in the [[#info.json\|info.json]] file.		The mod must either be in a folder, or in a folder inside a zip file. The mod folder (no zip file) must either be named in the pattern of <code>{mod-name}_{version-number}</code> or just <code>{mod-name}</code>, for example <code>test-mod-thing</code>. The mod zip must be named in the pattern of <code>{mod-name}_{version-number}</code>, for example <code>test-mod-thing_0.0.1</code>. When using a zip file for the mod, the folder inside the zip file does not have any naming restrictions; only the zip file itself must be named with the <code>{mod-name}_{version-number}</code> pattern. The mod name and its version number are defined in the [[#info.json\|info.json]] file.

Line 128:		Line 127:
	* [https://lua-api.factorio.com/latest/index-prototype.html Prototype documentation]		* [https://lua-api.factorio.com/latest/index-prototype.html Prototype documentation]
	* [https://lua-api.factorio.com/latest/index-runtime.html Runtime API documentation]		* [https://lua-api.factorio.com/latest/index-runtime.html Runtime API documentation]

			[[Category:Modding]]

Bilka: moved optional dependency version explanation to paragraph with incompatibility version explanation

2023-11-07T17:29:47Z

moved optional dependency version explanation to paragraph with incompatibility version explanation

← Older revision		Revision as of 17:29, 7 November 2023
Line 115:		Line 115:
	: Each dependency is a string that consists of up to three parts: <code>"<prefix> internal-mod-name <equality-operator version>"</code>, for example <code>"? some-mod-everyone-loves >= 4.2.0"</code>.		: Each dependency is a string that consists of up to three parts: <code>"<prefix> internal-mod-name <equality-operator version>"</code>, for example <code>"? some-mod-everyone-loves >= 4.2.0"</code>.

	:The equality operator (<code><, <=, =, >= or ></code>) combined with the version allows to define dependencies that require certain mod versions, but it is not required. Incompatibility does not support versions; if incompatibility is used, version is ignored.		:The equality operator (<code><, <=, =, >= or ></code>) combined with the version allows to define dependencies that require certain mod versions, but it is not required. Incompatibility does not support versions; if incompatibility is used, version is ignored. If a version is used for an optional dependency, the mod is considered incompatible (and disabled) if the dependency is present but does not fulfill the version requirement.

	:The possible prefixes are:		:The possible prefixes are:
	:* <code>!</code> for incompatibility		:* <code>!</code> for incompatibility
	:* <code>?</code> for an optional dependency. ~~A false match on version marks the mod as having unsatisfied requirements. (A red label)~~		:* <code>?</code> for an optional dependency.
	:* <code>(?)</code> for a hidden optional dependency		:* <code>(?)</code> for a hidden optional dependency
	:* <code>~</code> for a dependency that does not affect load order		:* <code>~</code> for a dependency that does not affect load order

Honktown: /* dependencies */

2023-11-06T06:58:25Z

dependencies

← Older revision		Revision as of 06:58, 6 November 2023
Line 119:		Line 119:
	:The possible prefixes are:		:The possible prefixes are:
	:* <code>!</code> for incompatibility		:* <code>!</code> for incompatibility
	:* <code>?</code> for an optional dependency. A false match on version ~~disables~~ the mod ~~with the optional and version dependency~~. (~~incompatibility~~)		:* <code>?</code> for an optional dependency. A false match on version marks the mod as having unsatisfied requirements. (A red label)
	:* <code>(?)</code> for a hidden optional dependency		:* <code>(?)</code> for a hidden optional dependency
	:* <code>~</code> for a dependency that does not affect load order		:* <code>~</code> for a dependency that does not affect load order