Blueprint string format - Revision history

Bilka: Can import json directly

2025-09-20T13:19:16Z

Can import json directly

← Older revision		Revision as of 13:19, 20 September 2025
Line 2:		Line 2:
	[[File:blueprint_string_preview.png\|thumb\|340px\|right\|Preview of a blueprint string.]]This is a technical description of the blueprint string format, used to share blueprints with other users.		[[File:blueprint_string_preview.png\|thumb\|340px\|right\|Preview of a blueprint string.]]This is a technical description of the blueprint string format, used to share blueprints with other users.

	A blueprint string is a JSON representation of the blueprint, compressed with zlib deflate using compression level 9 and then encoded using base64 with a version byte in front of the encoded string. The version byte is currently 0 (for all Factorio versions through 1.1).		A blueprint string is a JSON representation of the blueprint, compressed with zlib deflate using compression level 9 and then encoded using base64 with a version byte in front of the encoded string. The version byte is currently 0 (for all Factorio versions through 2.0).
	So to get the JSON representation of a blueprint from a blueprint string, skip the first byte, base64 decode the string, and finally decompress using zlib inflate.		So to get the JSON representation of a blueprint from a blueprint string, skip the first byte, base64 decode the string, and finally decompress using zlib inflate.

			As of 2.0 the game can also import the uncompressed JSON blueprint string directly.

	== Json representation of a blueprint/blueprint book ==		== Json representation of a blueprint/blueprint book ==

Metaflame: Fix: the blueprint_book object key uses an underscore, unlike the item, blueprint-book

2025-05-26T14:53:36Z

Fix: the blueprint_book object key uses an underscore, unlike the item, blueprint-book

← Older revision		Revision as of 14:53, 26 May 2025
Line 7:		Line 7:
	== Json representation of a blueprint/blueprint book ==		== Json representation of a blueprint/blueprint book ==

	The json representation of a blueprint or blueprint book is one large object inside another "wrapping" object, its key inside that object is either blueprint or ~~blueprint-book~~.		The json representation of a blueprint or blueprint book is one large object inside another "wrapping" object, its key inside that object is either blueprint or blueprint_book.

	=== Blueprint book object ===		=== Blueprint book object ===
Line 15:		Line 15:
	\|-		\|-
	\| item		\| item
	\| String, the name of the item that was saved ("blueprint-book" in vanilla).		\| String, the name of the item that was saved ("blueprint-book" in vanilla). Note that the key within the wrapping object is "blueprint_book" (with an underscore).
	\| String		\| String
	\|-		\|-

Meifraye: /* Example code */ It now use helper functions :>

2025-02-25T15:55:04Z

Example code: It now use helper functions :>

← Older revision		Revision as of 15:55, 25 February 2025
Line 738:		Line 738:
	local body=string.sub(instr,2);		local body=string.sub(instr,2);
	--[[then decode it]]		--[[then decode it]]
	local json_str=~~game~~.decode_string(body);		local json_str=helpers.decode_string(body);
	--[[then turn it into table]]		--[[then turn it into table]]
	local output=~~game~~.json_to_table(json_str);		local output=helpers.json_to_table(json_str);

	return output;		return output;

PennyJim: Quick pass to fix invalid concept links

2024-11-14T23:26:30Z

Quick pass to fix invalid concept links

← Older revision		Revision as of 23:26, 14 November 2024
Line 1:		Line 1:
			{{Cleanup\|Needs to be updated for 2.0}}
	[[File:blueprint_string_preview.png\|thumb\|340px\|right\|Preview of a blueprint string.]]This is a technical description of the blueprint string format, used to share blueprints with other users.		[[File:blueprint_string_preview.png\|thumb\|340px\|right\|Preview of a blueprint string.]]This is a technical description of the blueprint string format, used to share blueprints with other users.

Line 268:		Line 269:
	\|-		\|-
	\| tags		\| tags
	\| Dictionary of arbitrary data, optional. [https://lua-api.factorio.com/latest/concepts.html~~#Tags~~ Tags].		\| Dictionary of arbitrary data, optional. [https://lua-api.factorio.com/latest/concepts/Tags.html Tags].
	\| Object		\| Object
	\|}		\|}
Line 336:		Line 337:
	\|-		\|-
	\| condition		\| condition
	\| [https://lua-api.factorio.com/latest/concepts.html~~#CircuitCondition~~ CircuitCondition object], only present when type is "item_count", "circuit" or "fluid_count".		\| [https://lua-api.factorio.com/latest/concepts/CircuitCondition.html CircuitCondition object], only present when type is "item_count", "circuit" or "fluid_count".
	\| Object		\| Object
	\|}		\|}
Line 552:		Line 553:
	\|-		\|-
	\| logistic_condition		\| logistic_condition
	\| [https://lua-api.factorio.com/latest/concepts.html~~#CircuitCondition~~ CircuitCondition]		\| [https://lua-api.factorio.com/latest/concepts/CircuitCondition.html CircuitCondition]
	\| Object		\| Object
	\|-		\|-
Line 584:		Line 585:
	\|-		\|-
	\| circuit_condition		\| circuit_condition
	\| [https://lua-api.factorio.com/latest/concepts.html~~#CircuitCondition~~ CircuitCondition]		\| [https://lua-api.factorio.com/latest/concepts/CircuitCondition.html CircuitCondition]
	\| Object		\| Object
	\|-		\|-
Line 696:		Line 697:
	\|-		\|-
	\| filters		\| filters
	\| Array of [https://lua-api.factorio.com/latest/concepts.html~~#ConstantCombinatorParameters~~ ConstantCombinatorParameters].		\| Array of <s>[https://lua-api.factorio.com/latest/concepts/BlueprintLogisticFilter.html ConstantCombinatorParameters].</s> It's now a kind of [https://lua-api.factorio.com/latest/concepts/LogisticSections.html LogisticSections] instead.
			''We might be missing a type for it specifically.''
	\| Array		\| Array
	\|-		\|-
	\| arithmetic_conditions		\| arithmetic_conditions
	\| [https://lua-api.factorio.com/latest/concepts.html~~#ArithmeticCombinatorParameters~~ ArithmeticCombinatorParameters]		\| [https://lua-api.factorio.com/latest/concepts/ArithmeticCombinatorParameters.html ArithmeticCombinatorParameters]
	\| Object		\| Object
	\|-		\|-
	\| decider_conditions		\| decider_conditions
	\| [https://lua-api.factorio.com/latest/concepts.html~~#DeciderCombinatorParameters~~ DeciderCombinatorParameters]		\| [https://lua-api.factorio.com/latest/concepts/DeciderCombinatorParameters.html DeciderCombinatorParameters]
	\| Object		\| Object
	\|-		\|-
	\| circuit_parameters		\| circuit_parameters
	\| [https://lua-api.factorio.com/latest/concepts.html~~#ProgrammableSpeakerCircuitParameters~~ ProgrammableSpeakerCircuitParameters]		\| [https://lua-api.factorio.com/latest/concepts/ProgrammableSpeakerCircuitParameters.html ProgrammableSpeakerCircuitParameters]
	\| Object		\| Object
	\|-		\|-

Fgardt: refer to SignalIDType docs

2024-11-13T15:08:05Z

refer to SignalIDType docs

← Older revision		Revision as of 15:08, 13 November 2024
Line 122:		Line 122:
	\|-		\|-
	\| type		\| type
	\| Type of the signal. ~~Either "item", "fluid" or "virtual"~~. <br> '''Note for 2.x:''' property ~~appears~~ to ~~be optional~~		\| Type of the signal. See [https://lua-api.factorio.com/stable/concepts/SignalIDType.html SignalIDType] for possible values. <br> '''Note for 2.x:''' property is optional and defaults to "item".
	\| String		\| String
	\|}		\|}

Vadcx: /* Example code */ Provide alternative to pigz

2024-10-29T12:55:26Z

Example code: Provide alternative to pigz

← Older revision		Revision as of 12:55, 29 October 2024
Line 724:		Line 724:
	<syntaxhighlight lang="bash">echo "$blueprint_string" \| cut -c2- \| base64 -d \| pigz -d</syntaxhighlight>		<syntaxhighlight lang="bash">echo "$blueprint_string" \| cut -c2- \| base64 -d \| pigz -d</syntaxhighlight>

	How to decode a string to ~~lua~~ table:		If you don't have <code>pigz</code> installed, you can use <code>zlib-flate -uncompress</code> instead (part of "qpdf").

			How to decode a string to Lua table:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local str="$blueprint_string";		local str="$blueprint_string";

Vadcx: /* Entity object */ Add ammo_inventory and trunk_inventory

2024-10-29T00:52:28Z

Entity object: Add ammo_inventory and trunk_inventory

← Older revision		Revision as of 00:52, 29 October 2024
Line 174:		Line 174:
	\| Used by [[Prototype/Container]], optional. The index of the first inaccessible item slot due to limiting with the red "bar". 0-based [[Types/ItemStackIndex]].		\| Used by [[Prototype/Container]], optional. The index of the first inaccessible item slot due to limiting with the red "bar". 0-based [[Types/ItemStackIndex]].
	\| Integer		\| Integer
			\|-
			\| ammo_inventory
			\| Ammo inventory of an entity (e.g. [[Spidertron]]), optional. [[#Inventory object]]
			\| Object
			\|-
			\| trunk_inventory
			\| Boot/Luggage inventory of an entity (e.g. storage inventory of a Spidertron), optional. [[#Inventory object]]
			\| Object
	\|-		\|-
	\| inventory		\| inventory

Thoxo: /* Entity object */ Added note about direction changing with 2.0 blueprints

2024-10-29T00:09:59Z

Entity object: Added note about direction changing with 2.0 blueprints

← Older revision		Revision as of 00:09, 29 October 2024
Line 144:		Line 144:
	\|-		\|-
	\| direction		\| direction
	\| Direction of the entity, uint (optional).		\| Direction of the entity, uint (optional).<br> '''Note for 2.x:''' Direction appears to be double the previous values
	\| Integer		\| Integer
	\|-		\|-

Joelverhagen at 14:55, 26 October 2024

2024-10-26T14:55:34Z

← Older revision		Revision as of 14:55, 26 October 2024
Line 122:		Line 122:
	\|-		\|-
	\| type		\| type
	\| Type of the signal. Either "item", "fluid" or "virtual".		\| Type of the signal. Either "item", "fluid" or "virtual". <br> '''Note for 2.x:''' property appears to be optional
	\| String		\| String
	\|}		\|}

Fgardt: add temporary schedule records

2024-08-03T01:05:41Z

add temporary schedule records

← Older revision		Revision as of 01:05, 3 August 2024
Line 304:		Line 304:
	\| Array of [[#Wait Condition object]]s.		\| Array of [[#Wait Condition object]]s.
	\| Array		\| Array
			\|-
			\| temporary
			\| Whether this is a temporary schedule record. Optional.
			\| Boolean
	\|}		\|}