Tutorial:Localisation - Revision history

Snouz: /* Colors */

2026-08-06T13:46:04Z

Colors

← Older revision		Revision as of 13:46, 6 August 2026
Line 216:		Line 216:
	* <code>__PLANET__name__</code> - The localised name of the [https://lua-api.factorio.com/latest/prototypes/SpaceLocationPrototype.html SpaceLocationPrototype] or subclass.		* <code>__PLANET__name__</code> - The localised name of the [https://lua-api.factorio.com/latest/prototypes/SpaceLocationPrototype.html SpaceLocationPrototype] or subclass.
	* <code>__TILE__name__</code> - The localised name of the [https://lua-api.factorio.com/latest/prototypes/TilePrototype.html TilePrototype].		* <code>__TILE__name__</code> - The localised name of the [https://lua-api.factorio.com/latest/prototypes/TilePrototype.html TilePrototype].

	~~=== Colors ===~~
	~~A string can have colors~~
	* This <code>[color=0,255,0]text[/color]</code> will be displayed as green
	* This <code>[color=red]text[/color]</code> will be displayed as red
	* This <code>[color=#0000ff]text[/color]</code> will be displayed as blue

	=== Plurals ===		=== Plurals ===

Snouz: added colors

2026-08-06T13:32:56Z

added colors

← Older revision		Revision as of 13:32, 6 August 2026
Line 216:		Line 216:
	* <code>__PLANET__name__</code> - The localised name of the [https://lua-api.factorio.com/latest/prototypes/SpaceLocationPrototype.html SpaceLocationPrototype] or subclass.		* <code>__PLANET__name__</code> - The localised name of the [https://lua-api.factorio.com/latest/prototypes/SpaceLocationPrototype.html SpaceLocationPrototype] or subclass.
	* <code>__TILE__name__</code> - The localised name of the [https://lua-api.factorio.com/latest/prototypes/TilePrototype.html TilePrototype].		* <code>__TILE__name__</code> - The localised name of the [https://lua-api.factorio.com/latest/prototypes/TilePrototype.html TilePrototype].

			=== Colors ===
			A string can have colors
			* This <code>[color=0,255,0]text[/color]</code> will be displayed as green
			* This <code>[color=red]text[/color]</code> will be displayed as red
			* This <code>[color=#0000ff]text[/color]</code> will be displayed as blue

	=== Plurals ===		=== Plurals ===

Rasendubi: add missing after plural_for_parameter__

2026-07-24T06:30:30Z

add missing __ after __plural_for_parameter__

← Older revision		Revision as of 06:30, 24 July 2026
Line 245:		Line 245:
	The parameter used for pluralisation does not need to be present in the string. For example, a parameter could represent the number of list items present in another parameter:		The parameter used for pluralisation does not need to be present in the string. For example, a parameter could represent the number of list items present in another parameter:
	<pre>		<pre>
	I like __plural_for_parameter__1__{1=only one thing:\|rest=these things:} __2__		I like __plural_for_parameter__1__{1=only one thing:\|rest=these things:}__ __2__
	</pre>		</pre>
	Can result in "I like only one thing: trains", or in "I like these things: trains and turtles".		Can result in "I like only one thing: trains", or in "I like these things: trains and turtles".

KiRiK: /* File format */

2026-06-13T20:55:39Z

File format

← Older revision		Revision as of 20:55, 13 June 2026
Line 14:		Line 14:

	These files are located within the language code of the language in the locale folder of the mod, so as an English example <code>__mod__/locale/en/any_name_here.cfg</code>. There can be more than 1 file per language, all of them will be read.		These files are located within the language code of the language in the locale folder of the mod, so as an English example <code>__mod__/locale/en/any_name_here.cfg</code>. There can be more than 1 file per language, all of them will be read.

			== List of supported language codes ==

			Factorio supports a wide range of language localizations. When creating a mod, locale files must be placed in a subfolder named after the specific language code (e.g., <code>__mod__/locale/en/</code> for English, <code>__mod__/locale/ru/</code> for Russian and etc.).

			The following language codes are supported in the latest stable version of Factorio (<code>2.0.76</code>):

			<div style="column-count:4; -moz-column-count:4; -webkit-column-count:4;">
			* <code>af</code> — Afrikaans
			* <code>ar</code> — Arabic
			* <code>be</code> — Belarusian
			* <code>bg</code> — Bulgarian
			* <code>ca</code> — Catalan
			* <code>cs</code> — Czech
			* <code>da</code> — Danish
			* <code>de</code> — German
			* <code>el</code> — Greek
			* <code>en</code> — English
			* <code>eo</code> — Esperanto
			* <code>es-ES</code> — Spanish (Spain)
			* <code>et</code> — Estonian
			* <code>eu</code> — Basque
			* <code>fa</code> — Persian
			* <code>fi</code> — Finnish
			* <code>fil</code> — Filipino
			* <code>fr</code> — French
			* <code>fy-NL</code> — West Frisian
			* <code>ga-IE</code> — Irish
			* <code>he</code> — Hebrew
			* <code>hr</code> — Croatian
			* <code>hu</code> — Hungarian
			* <code>id</code> — Indonesian
			* <code>is</code> — Icelandic
			* <code>it</code> — Italian
			* <code>ja</code> — Japanese
			* <code>ka</code> — Georgian
			* <code>kk</code> — Kazakh
			* <code>ko</code> — Korean
			* <code>lt</code> — Lithuanian
			* <code>lv</code> — Latvian
			* <code>nl</code> — Dutch
			* <code>no</code> — Norwegian
			* <code>pl</code> — Polish
			* <code>pt-BR</code> — Portuguese (Brazil)
			* <code>pt-PT</code> — Portuguese (Portugal)
			* <code>ro</code> — Romanian
			* <code>ru</code> — Russian
			* <code>sk</code> — Slovak
			* <code>sl</code> — Slovenian
			* <code>sq</code> — Albanian
			* <code>sr</code> — Serbian
			* <code>sv-SE</code> — Swedish (Sweden)
			* <code>th</code> — Thai
			* <code>tr</code> — Turkish
			* <code>uk</code> — Ukrainian
			* <code>vi</code> — Vietnamese
			* <code>zh-CN</code> — Chinese (Simplified)
			* <code>zh-TW</code> — Chinese (Traditional)
			</div>

			You can also find the complete list of currently supported languages by checking the subfolder names in the game's installation directory: <code>data/base/locale/</code>.

			Mods should always provide at least the <code>en</code> (English) locale, as it serves as the fallback language if a translation for the user's selected language is missing.

	== Localising simple strings ==		== Localising simple strings ==

Osmo: /* Default Behavior(s) for finding an Unspecified Localised String */ Improve this whole section, add rules for recipes and technologies. Remove "and is not an empty table" because empty tables are not valid localised strings (at least anymore).

2026-06-10T11:37:49Z

Default Behavior(s) for finding an Unspecified Localised String: Improve this whole section, add rules for recipes and technologies. Remove "and is not an empty table" because empty tables are not valid localised strings (at least anymore).

← Older revision		Revision as of 11:37, 10 June 2026
Line 305:		Line 305:

	== Default Behavior(s) for finding an Unspecified Localised String ==		== Default Behavior(s) for finding an Unspecified Localised String ==
	If a ~~localised_string~~ is not defined in the prototype ~~for certain prototype classes, e.g. entity, item~~, Factorio may have a default search behavior.		If a localised_name or localised_description is not defined in the prototype, Factorio may have a default search behavior.

	~~Determining an item's localised name:~~		Note: the angle brackets are meant to mean a generic term, they are not part of the actual string.
	Note: the angle brackets are meant to mean a generic term, they are not part of the actual string~~. Also, place_result and placed_as_equipment_result are strings, and Factorio fetches the matching prototype to examine~~.

	# if localised_name is provided in the item prototype ~~and it is not empty {}~~, use the provided value		For most types, the name defaults to {"<base type>-name.<prototype name>"}, for example {"entity-name.underground-belt"}
	# else if there is place_result and it has localised_name ~~that is not an empty table: {}~~, use the localised_name of place_result
	# else if there is place_result ~~with an empty localised_name~~, use {"entity-name.<~~entity prototype~~ name>"}		Similarly, the description defaults to {"<base type>-description.<prototype name>"}, for example {"entity-description.underground-belt"}
	# else if there is placed_as_equipment_result and it has a localised_name ~~that is not an empty table: {}~~, use the localised_name of placed_as_equipment_result
	# else if there is placed_as_equipment_result ~~with empty localised_name~~, use {"equipment-name.<~~equipment~~ name>"}		Base types are represented by [https://lua-api.factorio.com/latest/concepts/IDType.html IDType].
	# else use ~~default~~ {"item-name.<item name>"}
			=== Items ===
			For items, the process is more complicated.

			Note: place_result and placed_as_equipment_result are strings, and and Factorio fetches the matching prototype to examine.

			# if localised_name is provided in the item prototype, use the provided value
			# else if there is a place_result and it has a localised_name, use the localised_name of place_result
			# else if there is a place_result, use {"entity-name.<place_result name>"}
			# else if there is placed_as_equipment_result and it has a localised_name, use the localised_name of placed_as_equipment_result
			# else if there is placed_as_equipment_result, use {"equipment-name.<place_as_equipment_result name>"}
			# else use {"item-name.<item name>"}

			Descriptions of items are found in the same way, except localised_description is used instead of localised_name and <base type>-description is used instead of <base type>-name.

			Example: The transport-belt item does not have a localised_name, so 1->2.
			There is a place result, but the entity prototype does not have localised_name set, 2->3.
			There is a place result, so use the localised string {"entity-name.transport-belt"}.

	Reference: [https://forums.factorio.com/viewtopic.php?p=494243#p494243]		Reference: [https://forums.factorio.com/viewtopic.php?p=494243#p494243]

	~~Example~~: ~~The transport~~-~~belt~~ item ~~does not have a localised_name~~, ~~so 1~~->2. ~~There~~ is ~~a place result, but not localised_name~~ in the ~~entity~~ prototype. 2->3. ~~The place result lacks a localised_name~~. ~~Use~~ the localised ~~string~~ {"~~entity~~-name.~~transport~~-~~belt~~"}		=== Recipes ===
			# if localised_name is provided in the recipe prototype, use the provided value
			# else if main_product is set to an empty string: "", use {"recipe-name.<recipe name>"}
			# else if main_product is set or recipe only has a single product:
			#:# if the main product or only product has the same name as the recipe, use the localised name of the product. For item products, this uses the rules described in [[#Items]].
			#:# else use {"recipe-name.<recipe name>"}
			# else use {"recipe-name.<recipe name>"}
			Descriptions of recipes have no special rules.

			Reference: [https://lua-api.factorio.com/latest/prototypes/RecipePrototype.html#main_product]

			=== Technologies ===
			If localised_name is provided in the technology prototype, the provided value is used.
			Otherwise, if the name of a technology ends with -<number>, that number is ignored for localisation purposes.
			E.g. if the name is technology-3, the localised name defaults to {"technology-name.technology"} and the localised description defaults to {"technology-description.technology"}.

	Such defaults often include a "leading key" using [<group>-name] or [<group>-description] (such as [recipe-name], [mod-setting-description]). However, each prototype may have a distinct search behavior before using those, based on presence/absence of values in the prototype. [https://lua-api.factorio.com/latest/prototypes/~~RecipePrototype~~.html ~~RecipePrototype] for example may use the first product's localised_name, or the main_product's localised_name, or the localised string found in {"recipe-name.<recipe~~ name>"]~~, depending on values provided (and lacking) in the prototype.~~		Reference: [https://lua-api.factorio.com/latest/prototypes/TechnologyPrototype.html#name]

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

KiRiK: /* Concatenating localised strings */

2026-06-09T10:34:59Z

Concatenating localised strings

@@ Line 187: / Line 187: @@
 === Concatenating localised strings ===
-The special locale key: <code>&quot;&quot;</code> is used to concatenate, as the table format does not support concatenation:
+The special locale key: <code>""</code> is used to concatenate, as the table format does not support concatenation:
 <syntaxhighlight lang="lua">game.print({"", {"item-name.iron-plate"}, ": ", 60})</syntaxhighlight>
 Will result in: ''Iron plate: 60''
 === Localising alternate input names ===

Osmo: Undo revision 218718 by Osmo (talk) since it was prematurely saved

2026-06-08T12:35:37Z

Undo revision 218718 by Osmo (talk) since it was prematurely saved

← Older revision		Revision as of 12:35, 8 June 2026
Line 214:		Line 214:

	== Default Behavior(s) for finding an Unspecified Localised String ==		== Default Behavior(s) for finding an Unspecified Localised String ==
	If a ~~localised_name or localised_description~~ is not defined in the prototype ~~or is an empty table: {}~~, Factorio may have a default search behavior.		If a localised_string is not defined in the prototype for certain prototype classes, e.g. entity, item, Factorio may have a default search behavior.

	~~For most types~~, the ~~name defaults to {"<base type>-name~~.<prototype ~~name>"}, for example {"entity-name~~.~~underground-belt"}~~		Determining an item's localised name:
			Note: the angle brackets are meant to mean a generic term, they are not part of the actual string. Also, place_result and placed_as_equipment_result are strings, and Factorio fetches the matching prototype to examine.

	~~Similarly, the description defaults to {"<base type>-description.<prototype name>"}, for example {"entity-description.underground-belt"}~~

	~~Note: the angle brackets are meant to mean a generic term, they are not part of the actual string.~~

	~~For items, the process is more complicated:~~
	# if localised_name is provided in the item prototype and it is not empty {}, use the provided value		# if localised_name is provided in the item prototype and it is not empty {}, use the provided value
	# else if ~~the item prototype has a place_result:~~		# else if there is place_result and it has localised_name that is not an empty table: {}, use the localised_name of place_result
	~~#:# if~~ place_result has localised_name that is not an empty table: {}, use the localised_name of place_result		# else if there is place_result with an empty localised_name, use {"entity-name.<entity prototype name>"}
	#:# else if ~~{"entity-name.<~~place_result ~~name>"} has a translation~~, ~~use it~~		# else if there is placed_as_equipment_result and it has a localised_name that is not an empty table: {}, use the localised_name of placed_as_equipment_result
	~~#:# else~~ use {"~~item~~-name.<~~item~~ name>"}		# else if there is placed_as_equipment_result with empty localised_name, use {"equipment-name.<equipment name>"}
	# else if ~~the item prototype has a~~ placed_as_equipment_result:		# else use default {"item-name.<item name>"}
	~~#:# if place_result~~ has a localised_name that is not an empty table: {}, use the localised_name of placed_as_equipment_result
	~~#:# else if {"equipment-name.<place_as_equipment_result name>"} has a translation, use it~~
	~~#:# else use {"item-name.<item name>"}~~
	# else if ~~the item prototype has a placed_as_tile:~~
	~~#:# if place_as_tile result has a localised_name that~~ is ~~not an~~ empty ~~table: {}, use the~~ localised_name ~~of placed_as_tile result~~
	~~#:# else if {"tile-name.<place_as_tile result name>"} has a translation~~, ~~use it~~
	~~#:# else~~ use {"~~item~~-name.<~~item~~ name>"}
	# else use {"item-name.<item name>"}
	~~Descriptions of items are found in the same way, except localised_description is used instead of localised_name and <base type>-description is used instead of <base type>-name.~~

	Reference: [https://forums.factorio.com/viewtopic.php?p=494243#p494243] ~~<!-- TODO: Keep it? -->~~		Reference: [https://forums.factorio.com/viewtopic.php?p=494243#p494243]

	Example: The transport-belt item does not have a localised_name, so 1->2. There is a place result, but not localised_name in the entity prototype. 2->3. The place result lacks a localised_name. Use the localised string {"entity-name.transport-belt"}		Example: The transport-belt item does not have a localised_name, so 1->2. There is a place result, but not localised_name in the entity prototype. 2->3. The place result lacks a localised_name. Use the localised string {"entity-name.transport-belt"}

Osmo: /* Default Behavior(s) for finding an Unspecified Localised String */

2026-06-08T12:34:08Z

Default Behavior(s) for finding an Unspecified Localised String

← Older revision		Revision as of 12:34, 8 June 2026
Line 214:		Line 214:

	== Default Behavior(s) for finding an Unspecified Localised String ==		== Default Behavior(s) for finding an Unspecified Localised String ==
	If a ~~localised_string~~ is not defined in the prototype ~~for certain prototype classes, e.g. entity, item~~, Factorio may have a default search behavior.		If a localised_name or localised_description is not defined in the prototype or is an empty table: {}, Factorio may have a default search behavior.

	~~Determining an item's localised~~ name:		For most types, the name defaults to {"<base type>-name.<prototype name>"}, for example {"entity-name.underground-belt"}
	~~Note: the angle brackets are meant~~ to ~~mean a generic term, they are not part of the actual string~~. ~~Also~~, ~~place_result and placed_as_equipment_result are strings, and Factorio fetches the matching prototype to examine~~.

			Similarly, the description defaults to {"<base type>-description.<prototype name>"}, for example {"entity-description.underground-belt"}

			Note: the angle brackets are meant to mean a generic term, they are not part of the actual string.

			For items, the process is more complicated:
	# if localised_name is provided in the item prototype and it is not empty {}, use the provided value		# if localised_name is provided in the item prototype and it is not empty {}, use the provided value
	# else if ~~there is~~ place_result ~~and it~~ has localised_name that is not an empty table: {}, use the localised_name of place_result		# else if the item prototype has a place_result:
	# else if ~~there is~~ place_result ~~with an empty localised_name~~, use {"~~entity~~-name.<~~entity prototype~~ name>"}		#:# if place_result has localised_name that is not an empty table: {}, use the localised_name of place_result
	# else if ~~there is~~ placed_as_equipment_result ~~and it~~ has a localised_name that is not an empty table: {}, use the localised_name of placed_as_equipment_result		#:# else if {"entity-name.<place_result name>"} has a translation, use it
	# else if ~~there~~ is ~~placed_as_equipment_result with~~ empty localised_name, use {"~~equipment~~-name.<~~equipment~~ name>"}		#:# else use {"item-name.<item name>"}
	# else use ~~default~~ {"item-name.<item name>"}		# else if the item prototype has a placed_as_equipment_result:
			#:# if place_result has a localised_name that is not an empty table: {}, use the localised_name of placed_as_equipment_result
			#:# else if {"equipment-name.<place_as_equipment_result name>"} has a translation, use it
			#:# else use {"item-name.<item name>"}
			# else if the item prototype has a placed_as_tile:
			#:# if place_as_tile result has a localised_name that is not an empty table: {}, use the localised_name of placed_as_tile result
			#:# else if {"tile-name.<place_as_tile result name>"} has a translation, use it
			#:# else use {"item-name.<item name>"}
			# else use {"item-name.<item name>"}
			Descriptions of items are found in the same way, except localised_description is used instead of localised_name and <base type>-description is used instead of <base type>-name.

	Reference: [https://forums.factorio.com/viewtopic.php?p=494243#p494243]		Reference: [https://forums.factorio.com/viewtopic.php?p=494243#p494243] <!-- TODO: Keep it? -->

	Example: The transport-belt item does not have a localised_name, so 1->2. There is a place result, but not localised_name in the entity prototype. 2->3. The place result lacks a localised_name. Use the localised string {"entity-name.transport-belt"}		Example: The transport-belt item does not have a localised_name, so 1->2. There is a place result, but not localised_name in the entity prototype. 2->3. The place result lacks a localised_name. Use the localised string {"entity-name.transport-belt"}

Natha at 14:22, 21 April 2026

2026-04-21T14:22:31Z

← Older revision		Revision as of 14:22, 21 April 2026
Line 84:		Line 84:
	\|<code>[recipe-name]</code>		\|<code>[recipe-name]</code>
	\|-		\|-
	\|<code>[shortcut]</code>		\|<code>[shortcut-name]</code>
	\|-		\|-
	\|<code>[story]</code>		\|<code>[story]</code>

Bilka: /* List of built-in parameters */ Updated to 2.0.66

2025-09-20T14:37:57Z

List of built-in parameters: Updated to 2.0.66

← Older revision		Revision as of 14:37, 20 September 2025
Line 144:		Line 144:
	* <code>__ALT_CONTROL_LEFT_CLICK__n__</code> is replaced with <code>control-keys.mouse-button-1-alt-n</code> or <code>control-keys.controller-button-alt-n</code> (with parameter <code>control-keys.controller-b</code>)		* <code>__ALT_CONTROL_LEFT_CLICK__n__</code> is replaced with <code>control-keys.mouse-button-1-alt-n</code> or <code>control-keys.controller-button-alt-n</code> (with parameter <code>control-keys.controller-b</code>)
	* <code>__ALT_CONTROL_RIGHT_CLICK__n__</code> is replaced with <code>control-keys.mouse-button-2-alt-n</code> or <code>control-keys.controller-button-alt-n</code> (with parameter <code>control-keys.controller-x</code>)		* <code>__ALT_CONTROL_RIGHT_CLICK__n__</code> is replaced with <code>control-keys.mouse-button-2-alt-n</code> or <code>control-keys.controller-button-alt-n</code> (with parameter <code>control-keys.controller-x</code>)
			* <code>__ALT_CONTROL__n__name__</code>
			* <code>__CONTROL_MOVE__</code> - The Movement keys, squished together. Example: "WASD", from a conventional QWERTY English keyboard.
	* <code>__REMARK_COLOR_BEGIN__</code>		* <code>__REMARK_COLOR_BEGIN__</code>
	* <code>__REMARK_COLOR_END__</code>		* <code>__REMARK_COLOR_END__</code>
	* <code>__ALT_CONTROL__n__name__</code>
	* <code>__CONTROL_MOVE__</code> - The Movement keys, squished together. Example: "WASD", from a conventional QWERTY English keyboard.
	* <code>__ENTITY__name__</code> - The localised name of the [https://lua-api.factorio.com/latest/prototypes/EntityPrototype.html EntityPrototype] subclass.		* <code>__ENTITY__name__</code> - The localised name of the [https://lua-api.factorio.com/latest/prototypes/EntityPrototype.html EntityPrototype] subclass.
			* <code>__FLUID__name__</code> - The localised name of the [https://lua-api.factorio.com/latest/prototypes/FluidPrototype.html FluidPrototype].
	* <code>__ITEM__name__</code> - The localised name of the [https://lua-api.factorio.com/latest/prototypes/ItemPrototype.html ItemPrototype] or subclass.		* <code>__ITEM__name__</code> - The localised name of the [https://lua-api.factorio.com/latest/prototypes/ItemPrototype.html ItemPrototype] or subclass.
			* <code>__PLANET__name__</code> - The localised name of the [https://lua-api.factorio.com/latest/prototypes/SpaceLocationPrototype.html SpaceLocationPrototype] or subclass.
	* <code>__TILE__name__</code> - The localised name of the [https://lua-api.factorio.com/latest/prototypes/TilePrototype.html TilePrototype].		* <code>__TILE__name__</code> - The localised name of the [https://lua-api.factorio.com/latest/prototypes/TilePrototype.html TilePrototype].
	* <code>__FLUID__name__</code> - The localised name of the [https://lua-api.factorio.com/latest/prototypes/FluidPrototype.html FluidPrototype].

	=== Plurals ===		=== Plurals ===