Map exchange string format - Revision history

Ickputzdirwech: Removed {{Languages}}

2023-11-12T09:06:32Z

Removed {{Languages}}

← Older revision		Revision as of 09:06, 12 November 2023
Line 1:		Line 1:
	~~{{Languages}} [[Category:Technical]]~~
	This is a technical description of the map exchange string format, used to share map generating configurations with other users. This format is also used to store these settings inside save files for future chunk generation.		This is a technical description of the map exchange string format, used to share map generating configurations with other users. This format is also used to store these settings inside save files for future chunk generation.

Line 344:		Line 343:

	Each of the values in a triplet (such as "low", "small", and "poor") are synonymous.		Each of the values in a triplet (such as "low", "small", and "poor") are synonymous.

			[[Category:Technical]]

Bilka: 1.1.49: fwd2bwd_ratio changed

2021-12-10T12:45:49Z

1.1.49: fwd2bwd_ratio changed

← Older revision		Revision as of 12:45, 10 December 2021
Line 219:		Line 219:
	! * !! !! path_finder !! Path Finder		! * !! !! path_finder !! Path Finder
	\|-		\|-
	\| [[Data types#~~int~~\|~~int~~]] \|\| \|\| fwd2bwd_ratio \|\| ~~Defines whether we prefer forward (>1) or~~ backward ~~(<-1) or symmetrical (1)~~ search.		\| [[Data types#uint\|uint]] \|\| \|\| fwd2bwd_ratio \|\| The pathfinder performs a step of the backward search every fwd2bwd_ratio'th step. The minimum allowed value is 2, which means symmetric search.
	\|-		\|-
	\| [[Data types#double\|double]] \|\| \|\| goal_pressure_ratio \|\| When comparing nodes in open which one to check next, heuristic value is multiplied by this ratio. The higher the number the more is the search directed directly towards the goal.		\| [[Data types#double\|double]] \|\| \|\| goal_pressure_ratio \|\| When comparing nodes in open which one to check next, heuristic value is multiplied by this ratio. The higher the number the more is the search directed directly towards the goal.

Bilka: Changed link going to World generator redirect to go to map generator directly

2020-05-06T10:14:21Z

Changed link going to World generator redirect to go to map generator directly

← Older revision		Revision as of 10:14, 6 May 2020
Line 68:		Line 68:
	\| seed		\| seed
	\| ≤0.14		\| ≤0.14
	\| [[~~World~~ generator#~~Map Seed~~\|Map seed]]. This field is never [[Data_types#Space_Optimized\|space optimized]].		\| [[Map generator#Manual_configuration\|Map seed]]. This field is never [[Data_types#Space_Optimized\|space optimized]].
	\|-		\|-
	\| ''none''		\| ''none''
	\| shift		\| shift
	\| ≤0.14		\| ≤0.14
	\| This field isn't present in the binary format! But it is part of the ~~LUA~~ structure - by default it's derived from the map seed. I'll slap the algorithm here soon(tm).		\| This field isn't present in the binary format! But it is part of the Lua structure - by default it's derived from the map seed. I'll slap the algorithm here soon(tm).
	\|-		\|-
	\| [[Data types#int\|uint]]		\| [[Data types#int\|uint]]
	\| width		\| width
	\| ≤0.14		\| ≤0.14
	\| [[~~World~~ generator#~~Map-width and -height~~\|Map width]]. This field is never [[Data_types#Space_Optimized\|space optimized]].		\| [[Map generator#Advanced\|Map width]]. This field is never [[Data_types#Space_Optimized\|space optimized]].
	\|-		\|-
	\| [[Data types#int\|uint]]		\| [[Data types#int\|uint]]
	\| height		\| height
	\| ≤0.14		\| ≤0.14
	\| [[~~World~~ generator#~~Map-width and -height~~\|Map height]]. This field is never [[Data_types#Space_Optimized\|space optimized]].		\| [[Map generator#Advanced\|Map height]]. This field is never [[Data_types#Space_Optimized\|space optimized]].
	\|-		\|-
	\| [[Data types#byte\|byte]]		\| [[Data types#byte\|byte]]
	\| starting_area		\| starting_area
	\| ≤0.14		\| ≤0.14
	\| [[~~World~~ generator#~~Starting area~~\|Starting area]] [[#Map_Gen_Size\|size]].		\| [[Map generator#Enemy\|Starting area]] [[#Map_Gen_Size\|size]].
	\|-		\|-
	\| [[Data types#bool\|boolean]]		\| [[Data types#bool\|boolean]]
	\| peaceful_mode		\| peaceful_mode
	\| ≤0.14		\| ≤0.14
	\| [[~~World~~ generator#~~Peaceful mode~~\|Peaceful mode]]. Enabled if set to 1, disabled otherwise.		\| [[Map generator#Enemy\|Peaceful mode]]. Enabled if set to 1, disabled otherwise.
	\|}		\|}

Line 102:		Line 102:
	In the LUA structure, this information is stored in the "[http://lua-api.factorio.com/latest/LuaGameScript.html#LuaGameScript.map_settings game.map_settings]" table, which is created by the "[http://lua-api.factorio.com/latest/Concepts.html#MapSettings MapSettings]" prototype. Each section in the table below represents a nested sub-table in "map-settings", where the LUA key listed is the key of the table, and all subsequent fields are part of the sub-table. See data/base/prototypes/map-settings.lua for a description of all attributes (some of that information has now been copied to this page).		In the LUA structure, this information is stored in the "[http://lua-api.factorio.com/latest/LuaGameScript.html#LuaGameScript.map_settings game.map_settings]" table, which is created by the "[http://lua-api.factorio.com/latest/Concepts.html#MapSettings MapSettings]" prototype. Each section in the table below represents a nested sub-table in "map-settings", where the LUA key listed is the key of the table, and all subsequent fields are part of the sub-table. See data/base/prototypes/map-settings.lua for a description of all attributes (some of that information has now been copied to this page).

	Fields marked with a check (✓) in the "GUI" column are configurable in the [[~~World_generator~~#~~How_it_works~~\|new game map generator GUI]].		Fields marked with a check (✓) in the "GUI" column are configurable in the [[Map generator#Manual configuration\|new game map generator GUI]].

	{\| class="wikitable mw-collapsible mw-collapsed"		{\| class="wikitable mw-collapsible mw-collapsed"
Line 304:		Line 304:

	== Autoplace Control ==		== Autoplace Control ==
	See the page on [[~~World~~ generator#~~Settings on the top row~~\|~~world~~ generation]] for more information on frequency, size, and richness.		See the page on [[Map generator#Resources\|map generation]] for more information on frequency, size, and richness.
	{\| class="wikitable"		{\| class="wikitable"
	! Type !! LUA key !! Description		! Type !! LUA key !! Description

Jon8RFC: /* Factorio 0.14 and Beyond */ fix redirect

2020-04-29T04:07:47Z

Factorio 0.14 and Beyond: fix redirect

← Older revision		Revision as of 04:07, 29 April 2020
Line 23:		Line 23:
	\|-		\|-
	\| [[Data types#short\|short]][4]		\| [[Data types#short\|short]][4]
	\| The [[~~Version_String_Format~~\|version string]] of Factorio that generated this string, used to determine encoding format. This field is never [[Data_types#Space_Optimized\|space optimized]].		\| The [[Version_string_format\|version string]] of Factorio that generated this string, used to determine encoding format. This field is never [[Data_types#Space_Optimized\|space optimized]].
	\|-		\|-
	\| byte[*]		\| byte[*]

Lexxy Fox: /* Factorio 0.14 and Beyond */

2018-04-29T21:24:33Z

Factorio 0.14 and Beyond

← Older revision		Revision as of 21:24, 29 April 2018
Line 31:		Line 31:
	\| [[#0.15 Map Settings\|0.15.x Map Settings]]. If present, this chunk consists of the remainder of the data (minus the checksum).		\| [[#0.15 Map Settings\|0.15.x Map Settings]]. If present, this chunk consists of the remainder of the data (minus the checksum).
	\|-		\|-
	\| [[Data types#~~int~~\|~~int~~]]		\| [[Data types#uint\|uint]]
	\| [https://en.wikipedia.org/wiki/Cyclic_redundancy_check CRC32 checksum] of all preceding data, as defined by ANSI X3.66 / FIPS 71 / ITU-T V.42 (the same one used by [https://en.wikipedia.org/wiki/Zlib zlib], ethernet, etc.)		\| [https://en.wikipedia.org/wiki/Cyclic_redundancy_check CRC32 checksum] of all preceding data, as defined by ANSI X3.66 / FIPS 71 / ITU-T V.42 (the same one used by [https://en.wikipedia.org/wiki/Zlib zlib], ethernet, etc.)
	\|}		\|}

Lexxy Fox: /* Map Gen Settings */

2018-04-16T00:28:39Z

Map Gen Settings

← Older revision		Revision as of 00:28, 16 April 2018
Line 78:		Line 78:
	\| width		\| width
	\| ≤0.14		\| ≤0.14
	\| [[World generator#Map-width and -height\|Map width]].		\| [[World generator#Map-width and -height\|Map width]]. This field is never [[Data_types#Space_Optimized\|space optimized]].
	\|-		\|-
	\| [[Data types#int\|uint]]		\| [[Data types#int\|uint]]
	\| height		\| height
	\| ≤0.14		\| ≤0.14
	\| [[World generator#Map-width and -height\|Map height]].		\| [[World generator#Map-width and -height\|Map height]]. This field is never [[Data_types#Space_Optimized\|space optimized]].
	\|-		\|-
	\| [[Data types#byte\|byte]]		\| [[Data types#byte\|byte]]
Line 89:		Line 89:
	\| ≤0.14		\| ≤0.14
	\| [[World generator#Starting area\|Starting area]] [[#Map_Gen_Size\|size]].		\| [[World generator#Starting area\|Starting area]] [[#Map_Gen_Size\|size]].
	\|-
	~~\| TODO~~
	~~\| starting_points~~
	~~\| 0.16.16~~
	~~\| TODO...~~
	\|-		\|-
	\| [[Data types#bool\|boolean]]		\| [[Data types#bool\|boolean]]

Lexxy Fox: /* Map Gen Settings */

2018-04-16T00:23:16Z

Map Gen Settings

← Older revision		Revision as of 00:23, 16 April 2018
Line 61:		Line 61:
	\|-		\|-
	\| [[Data types#byte\|byte]][2]		\| [[Data types#byte\|byte]][2]
	\|- TODO		\| TODO
	\| 0.16.0		\| 0.16.0
	\| TODO...		\| TODO...

Lexxy Fox: /* Map Gen Settings */

2018-04-16T00:22:45Z

Map Gen Settings

← Older revision		Revision as of 00:22, 16 April 2018
Line 59:		Line 59:
	\| An dictionary of [[#Autoplace_Control\|Autoplace Controls]], with string keys, where the key represents the resource name. Factorio doesn’t care what order this dictionary is in, but it always alphabetizes during export. Vanilla has seven resources: [[Coal\|coal]], [[Copper ore\|copper-ore]], [[Crude oil\|crude-oil]], [[Enemies\|enemy-base]], [[Iron ore\|iron-ore]], [[Stone\|stone]], and [[Uranium ore\|uranium-ore]]. Unknown ores are ignored and missing ores are set to their defaults.		\| An dictionary of [[#Autoplace_Control\|Autoplace Controls]], with string keys, where the key represents the resource name. Factorio doesn’t care what order this dictionary is in, but it always alphabetizes during export. Vanilla has seven resources: [[Coal\|coal]], [[Copper ore\|copper-ore]], [[Crude oil\|crude-oil]], [[Enemies\|enemy-base]], [[Iron ore\|iron-ore]], [[Stone\|stone]], and [[Uranium ore\|uranium-ore]]. Unknown ores are ignored and missing ores are set to their defaults.
	Factorio 0.16.x adds addition terrain related autoplace features: desert, dirt, grass, sand, trees. With the exception of trees, these resources ignore their richness and as such are not configuration using the map gen GUI, and always have a richness value of 3 ("Regular").		Factorio 0.16.x adds addition terrain related autoplace features: desert, dirt, grass, sand, trees. With the exception of trees, these resources ignore their richness and as such are not configuration using the map gen GUI, and always have a richness value of 3 ("Regular").
			\|-
			\| [[Data types#byte\|byte]][2]
			\|- TODO
			\| 0.16.0
			\| TODO...
	\|-		\|-
	\| [[Data types#int\|uint]]		\| [[Data types#int\|uint]]

Lexxy Fox: /* Map Gen Settings */

2018-04-16T00:15:01Z

Map Gen Settings

← Older revision		Revision as of 00:15, 16 April 2018
Line 60:		Line 60:
	Factorio 0.16.x adds addition terrain related autoplace features: desert, dirt, grass, sand, trees. With the exception of trees, these resources ignore their richness and as such are not configuration using the map gen GUI, and always have a richness value of 3 ("Regular").		Factorio 0.16.x adds addition terrain related autoplace features: desert, dirt, grass, sand, trees. With the exception of trees, these resources ignore their richness and as such are not configuration using the map gen GUI, and always have a richness value of 3 ("Regular").
	\|-		\|-
	~~\| [[Data types#bool\|boolean]]~~		\| [[Data types#int\|uint]]
	~~\| default_enable_all_autoplace_controls~~
	~~\| 0.16.0~~
	~~\| TODO...~~
	\|-
	~~\| [[Data types#dict\|dict]]<TODO, TODO>~~
	~~\| autoplace_settings~~
	~~\| 0.16.0~~
	~~\| TODO...~~
	\|-
	~~\| TODO~~
	~~\| cliff_settings~~
	~~\| 0.16.16~~
	~~\| TODO...~~
	\|-
	\| [[Data types#int\|~~int~~]]
	\| seed		\| seed
	\| ≤0.14		\| ≤0.14
	\| [[World generator#Map Seed\|Map seed]].		\| [[World generator#Map Seed\|Map seed]]. This field is never [[Data_types#Space_Optimized\|space optimized]].
	\|-		\|-
	\| ''none''		\| ''none''
Line 85:		Line 70:
	\| This field isn't present in the binary format! But it is part of the LUA structure - by default it's derived from the map seed. I'll slap the algorithm here soon(tm).		\| This field isn't present in the binary format! But it is part of the LUA structure - by default it's derived from the map seed. I'll slap the algorithm here soon(tm).
	\|-		\|-
	\| [[Data types#int\|~~int~~]]		\| [[Data types#int\|uint]]
	\| width		\| width
	\| ≤0.14		\| ≤0.14
	\| [[World generator#Map-width and -height\|Map width]].		\| [[World generator#Map-width and -height\|Map width]].
	\|-		\|-
	\| [[Data types#int\|~~int~~]]		\| [[Data types#int\|uint]]
	\| height		\| height
	\| ≤0.14		\| ≤0.14

Lexxy Fox: /* Map Gen Settings */

2018-04-15T23:46:42Z

Map Gen Settings

← Older revision		Revision as of 23:46, 15 April 2018
Line 58:		Line 58:
	\| ≤0.14		\| ≤0.14
	\| An dictionary of [[#Autoplace_Control\|Autoplace Controls]], with string keys, where the key represents the resource name. Factorio doesn’t care what order this dictionary is in, but it always alphabetizes during export. Vanilla has seven resources: [[Coal\|coal]], [[Copper ore\|copper-ore]], [[Crude oil\|crude-oil]], [[Enemies\|enemy-base]], [[Iron ore\|iron-ore]], [[Stone\|stone]], and [[Uranium ore\|uranium-ore]]. Unknown ores are ignored and missing ores are set to their defaults.		\| An dictionary of [[#Autoplace_Control\|Autoplace Controls]], with string keys, where the key represents the resource name. Factorio doesn’t care what order this dictionary is in, but it always alphabetizes during export. Vanilla has seven resources: [[Coal\|coal]], [[Copper ore\|copper-ore]], [[Crude oil\|crude-oil]], [[Enemies\|enemy-base]], [[Iron ore\|iron-ore]], [[Stone\|stone]], and [[Uranium ore\|uranium-ore]]. Unknown ores are ignored and missing ores are set to their defaults.
	Factorio 0.16.x adds addition terrain related autoplace features: desert, dirt, grass, sand, trees. With the exception of trees, these resources ignore their richness and as such are not configuration using the map gen GUI, and always have a richness value of 3.		Factorio 0.16.x adds addition terrain related autoplace features: desert, dirt, grass, sand, trees. With the exception of trees, these resources ignore their richness and as such are not configuration using the map gen GUI, and always have a richness value of 3 ("Regular").
	\|-		\|-
	\| [[Data types#bool\|boolean]]		\| [[Data types#bool\|boolean]]