In other languages:

Blueprint string format: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(WIP)
 
m (typo)
 
(25 intermediate revisions by 9 users not shown)
Line 1: Line 1:
{{Languages}} [[Category:Technical]]
{{Languages}} [[Category:Technical]]
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, encoded using base 64 with the version byte in front (0 in vanilla 0.15) and then compressed with zlib deflate. 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 deflate.  
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).
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.  


== 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, named 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 ===


{| class="wikitable"
{| class="wikitable"
! Key !! Description
! Key !! Description !! Data type
|-
|-
| 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).
| String
|-
|-
| label
| label
| String, the name of the blueprint set by the user
| String, the name of the blueprint set by the user.
| String
|-
| label_color
| The color of the label of this blueprint. Optional. [[#Color object]].
| Object
|-
|-
| blueprints
| blueprints
| The actual content of the blueprint book, array of objects containing an "index" key and value (starts with 0) and a "blueprint" key with a [[#Blueprint object]] as the value
| The actual content of the blueprint book, array of objects containing an "index" key and 0-based value and a "blueprint" key with a [[#Blueprint object]] as the value.
| Array
|-
|-
| active_index
| active_index
| Index of the currently selected blueprint (starts with 0)
| Index of the currently selected blueprint, 0-based.
| Integer
|-
|-
| version
| version
| The map version of the map the blueprint was created in (but converted to an uint, not sure how)
| The map version of the map the blueprint was created in, see [[Version string format]].
| Integer (long)
|}
|}


=== Blueprint object ===
=== Blueprint object ===
{| class="wikitable"
{| class="wikitable"
! Key !! Description
! Key !! Description !! Data type
|-
|-
| item
| item
| String, the name of the item that was saved ("blueprint" in vanilla)
| String, the name of the item that was saved ("blueprint" in vanilla).
| String
|-
|-
| label
| label
| String, the name of the blueprint set by the user
| String, the name of the blueprint set by the user.
| String
|-
| label_color
| The color of the label of this blueprint. Optional. [[#Color object]].
| Object
|-
|-
| entities
| entities
| The actual content of the blueprint, array of [[#Entity object]]s
| The actual content of the blueprint, array of [[#Entity object]]s.
| Array
|-
| tiles
| The tiles included in the blueprint, array of [[#Tile object]]s.
| Array
|-
|-
| icons
| icons
| The icons of the blueprint set by the user, array of [[#Icon object]]s
| The icons of the blueprint set by the user, array of [[#Icon object]]s.
| Array
|-
| schedules
| The schedules for trains in this blueprint, array of [[#Schedule object]]s.
| Array
|-
|-
| version
| version
| The map version of the map the blueprint was created in (but converted to an uint, not sure how)
| The map version of the map the blueprint was created in.
| Integer (long)
|}
|}


Line 52: Line 79:


{| class="wikitable"
{| class="wikitable"
! Key !! Description
! Key !! Description !! Data type
|-
|-
| index
| index
| Index of the icon (starts with 1)
| Index of the icon, 1-based.
| Integer
|-
|-
| signal
| signal
| Object with a type key/value pair and a name key/value pair.
| The icon that is displayed, [[#SignalID object]].
| Object
|}
 
=== SignalID object ===
{| class="wikitable"
! Key !! Description !! Data type
|-
| name
| Name of the signal prototype this signal is set to.
| String
|-
| type
| Type of the signal. Either "item", "fluid" or "virtual".
| String
|}
|}


Line 64: Line 106:


{| class="wikitable"
{| class="wikitable"
! Key !! Description
! Key !! Description !! Data type
|-
|-
| entity_number
| entity_number
| Index of the entity (starts with 1)
| Index of the entity, 1-based.
| Integer
|-
|-
| name
| name
| Prototype name of the entity (e.g. "offshore-pump")
| Prototype name of the entity (e.g. "offshore-pump").
| String
|-
|-
| position
| position
| Position of the entity within the blueprint. Object with a x key/value pair and a y key/value pair
| [[#Position object]], position of the entity within the blueprint.
| Object
|-
|-
| direction
| direction
| Direction of the entity, uint (optional)
| Direction of the entity, uint (optional).
| Integer
|-
| orientation
| Orientation of cargo wagon or locomotive, value 0 to 1 (optional).
| Floating Point
|-
|-
| connections
| connections
| Circuit connection, object with keys starting from 1, values are [[#Connection object]]s (optional)
| Circuit connection, object with keys starting from 1, values are [[#Connection object]]s (optional).
| Object
|-
|-
| control_behaviour
| neighbours
| Copper wire connections, array of entity_numbers (optional).
| Array
|-
| control_behavior
|
|
| Object
|-
|-
| items
| items
|
| Item requests by this entity, this is what defines the item-request-proxy when the blueprint is placed, optional. [[#Item request object]]
| Object
|-
|-
| recipe
| recipe
| Name of the recipe prototype this assembling machine is set to, optional, string.
| String
|-
| bar
| 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
|-
| inventory
| Cargo wagon inventory configuration, optional. [[#Inventory object]]
| Object
|-
| infinity_settings
| Used by [[Prototype/InfinityContainer]], optional. [[#Infinity settings object]]
| Object
|-
| type
| Type of the underground belt or loader, optional. Either "input" or "output".
| String
|-
| input_priority
| Input priority of the splitter, optional. Either "right" or "left", "none" is omitted.
| String
|-
| output_priority
| Output priority of the splitter, optional. Either "right" or "left", "none" is omitted.
| String
|-
| filter
| Filter of the splitter, optional. Name of the item prototype the filter is set to, string.
| String
|-
| filters
| Filters of the filter inserter or loader, optional. Array of [[#Item filter object]]s.
| Array
|-
| filter_mode
| Filter mode of the filter inserter, optional. Either "whitelist" or "blacklist".
| String
|-
| override_stack_size
| The stack size the inserter is set to, optional. [[Types/uint8]].
| Integer
|-
| drop_position
| The drop position the inserter is set to, optional. [[#Position object]].
| Object
|-
| pickup_position
| The pickup position the inserter is set to, optional. [[#Position object]].
| Object
|-
| request_filters
| Used by [[Prototype/LogisticContainer]], optional. [[#Logistic filter object]].
| Array
|-
| request_from_buffers
| Boolean. Whether this requester chest can request from buffer chests.
| Boolean
|-
| parameters
| Used by [[Programmable speaker]], optional. [[#Speaker parameter object]].
| Object
|-
| alert_parameters
| Used by [[Programmable speaker]], optional. [[#Speaker alert parameter object]]
| Object
|-
| auto_launch
| Used by the rocket silo, optional. Boolean, whether auto launch is enabled.
| Boolean
|-
| variation
| Used by [[Prototype/SimpleEntityWithForce]] or [[Prototype/SimpleEntityWithOwner]], optional. [[Types/GraphicsVariation]]
|
|
|-
| color
| Color of the [[Prototype/SimpleEntityWithForce]], [[Prototype/SimpleEntityWithOwner]], or train station, optional. [[#Color object]].
| Object
|-
| station
| The name of the train station, optional.
| String
|}
=== Inventory object ===
{| class="wikitable"
! Key !! Description !! Data type
|-
| filters
| Array of [[#Item filter object]]s.
| Array
|-
| bar
| The index of the first inaccessible item slot due to limiting with the red "bar". 0-based, optional.  [[Types/ItemStackIndex]].
| Integer
|}
=== Schedule object ===
{| class="wikitable"
! Key !! Description !! Data type
|-
| schedule
| Array of [[#Schedule Record object]]s.
| Array
|-
| locomotives
| Array of entity numbers of locomotives using this schedule.
| Array
|}
=== Schedule Record object ===
{| class="wikitable"
! Key !! Description !! Data type
|-
| station
| The name of the stop for this schedule record.
| String
|-
| wait_conditions
| Array of [[#Wait Condition object]]s.
| Array
|}
=== Wait Condition object ===
{| class="wikitable"
! Key !! Description !! Data type
|-
| type
| One of "time", "inactivity", "full", "empty", "item_count", "circuit", "robots_inactive", "fluid_count", "passenger_present", "passenger_not_present".
| String
|-
| compare_type
| Either "and", or "or". Tells how this condition is to be compared with the preceding conditions in the corresponding wait_conditions array.
| String
|-
| ticks
| Number of ticks to wait or of inactivity. Only present when type is "time" or "inactivity". Optional.
| uint
|-
| condition
| CircuitCondition Object, only present when type is "item_count", "circuit" or "fluid_count".
| Object
|}
=== Tile object ===
{| class="wikitable"
! Key !! Description !! Data type
|-
| name
| Prototype name of the tile (e.g. "concrete")
| String
|-
| position
| [[#Position object]], position of the entity within the blueprint.
| Object
|}
=== Position object ===
{| class="wikitable"
! Key !! Description !! Data type
|-
| x
| X position within the blueprint, 0 is the center.
| Floating point
|-
| y
| Y position within the blueprint, 0 is the center.
| Floating point
|}
=== Connection object ===
Object containing information about the connections to other entities formed by red or green wires.
{| class="wikitable"
! Key !! Description !! Data type
|-
| 1
| First connection point. The default for everything that doesn't have multiple connection points.[[#Connection point object]]
| Object
|-
| 2
| Second connection point. For example, the "output" part of an arithmetic combinator.[[#Connection point object]]
| Object
|}
=== Connection point object ===
The actual point where a wire is connected to. Contains information about where it is connected to.
{| class="wikitable"
! Key !! Description !! Data type
|-
| red
| An array of [[#Connection data object]] containing all the connections from this point created by red wire.
| Array
|-
| green
| An array of [[#Connection data object]] containing all the connections from this point created by green wire.
| Array
|}
=== Connection data object ===
Information about a single connection between two connection points.
{| class="wikitable"
! Key !! Description !! Data type
|-
| entity_id
| ID of the entity this connection is connected with.
| Integer
|-
| circuit_id
| The circuit connector id of the entity this connection is connected to, see [https://lua-api.factorio.com/latest/defines.html#defines.circuit_connector_id defines.circuit_connector_id].
| Integer
|}
=== Item request object ===
1 or more instances of key/value pairs.
Key is the name of the item, string.
Value is the amount of items to be requested, [[Types/ItemCountType]].
=== Item filter object ===
{| class="wikitable"
! Key !! Description !! Data type
|-
| name
| Name of the item prototype this filter is set to.
| String
|-
| index
| Index of the filter, 1-based.
| Integer
|}
=== Infinity settings object ===
{| class="wikitable"
! Key !! Description
|-
| remove_unfiltered_items
| Boolean. Whether the "remove unfiltered items" checkbox is checked.
| Boolean
|-
| filters
| Filters of the infinity container, optional. Array of [[#Infinity filter object]]s.
| Array
|}
=== Infinity filter object ===
{| class="wikitable"
! Key !! Description
|-
| name
| Name of the item prototype the filter is set to, string.
| String
|-
| count
| Number the filter is set to, [[Types/ItemCountType]].
| Integer
|-
| mode
| Mode of the filter. Either "at-least", "at-most", or "exactly".
| String
|-
| index
| Index of the filter, 1-based.
| Integer
|}
=== Logistic filter object ===
{| class="wikitable"
! Key !! Description !! Data type
|-
| name
| Name of the item prototype this filter is set to.
| String
|-
| index
| Index of the filter, 1-based.
| Integer
|-
| count
| Number the filter is set to, [[Types/ItemCountType]]. Is 0 for storage chests.
| Integer
|}
=== Speaker parameter object ===
{| class="wikitable"
! Key !! Description !! Data type
|-
| playback_volume
| [[Types/double]]. Volume of the speaker.
| Floating point
|-
| playback_globally
| Boolean, whether global playback is enabled.
| Boolean
|-
| allow_polyphony
| Boolean, whether polyphony is allowed.
| Boolean
|}
=== Speaker alert parameter object ===
{| class="wikitable"
! Key !! Description !! Data type
|-
| show_alert
| Boolean, whether an alert is shown.
| Boolean
|-
| show_on_map
| Boolean, whether an alert icon is shown on the map.
| Boolean
|-
| icon_signal_id
| The icon that is displayed with the alert, [[#SignalID object]].
| Object
|-
| alert_message
| String, message of the alert.
| String
|}
=== Color object ===
{| class="wikitable"
! Key !! Description !! Data type
|-
| r
| red, number from 0 to 1.
| Floating point
|-
| g
| green, number from 0 to 1.
| Floating point
|-
| b
| blue, number from 0 to 1.
| Floating point
|-
| a
| transparency, number from 0 to 1.
| Floating point
|}
|}

Latest revision as of 08:50, 16 January 2023

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). 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.

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.

Blueprint book object

Key Description Data type
item String, the name of the item that was saved ("blueprint-book" in vanilla). String
label String, the name of the blueprint set by the user. String
label_color The color of the label of this blueprint. Optional. #Color object. Object
blueprints The actual content of the blueprint book, array of objects containing an "index" key and 0-based value and a "blueprint" key with a #Blueprint object as the value. Array
active_index Index of the currently selected blueprint, 0-based. Integer
version The map version of the map the blueprint was created in, see Version string format. Integer (long)

Blueprint object

Key Description Data type
item String, the name of the item that was saved ("blueprint" in vanilla). String
label String, the name of the blueprint set by the user. String
label_color The color of the label of this blueprint. Optional. #Color object. Object
entities The actual content of the blueprint, array of #Entity objects. Array
tiles The tiles included in the blueprint, array of #Tile objects. Array
icons The icons of the blueprint set by the user, array of #Icon objects. Array
schedules The schedules for trains in this blueprint, array of #Schedule objects. Array
version The map version of the map the blueprint was created in. Integer (long)

Icon object

Key Description Data type
index Index of the icon, 1-based. Integer
signal The icon that is displayed, #SignalID object. Object

SignalID object

Key Description Data type
name Name of the signal prototype this signal is set to. String
type Type of the signal. Either "item", "fluid" or "virtual". String

Entity object

Key Description Data type
entity_number Index of the entity, 1-based. Integer
name Prototype name of the entity (e.g. "offshore-pump"). String
position #Position object, position of the entity within the blueprint. Object
direction Direction of the entity, uint (optional). Integer
orientation Orientation of cargo wagon or locomotive, value 0 to 1 (optional). Floating Point
connections Circuit connection, object with keys starting from 1, values are #Connection objects (optional). Object
neighbours Copper wire connections, array of entity_numbers (optional). Array
control_behavior Object
items Item requests by this entity, this is what defines the item-request-proxy when the blueprint is placed, optional. #Item request object Object
recipe Name of the recipe prototype this assembling machine is set to, optional, string. String
bar 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
inventory Cargo wagon inventory configuration, optional. #Inventory object Object
infinity_settings Used by Prototype/InfinityContainer, optional. #Infinity settings object Object
type Type of the underground belt or loader, optional. Either "input" or "output". String
input_priority Input priority of the splitter, optional. Either "right" or "left", "none" is omitted. String
output_priority Output priority of the splitter, optional. Either "right" or "left", "none" is omitted. String
filter Filter of the splitter, optional. Name of the item prototype the filter is set to, string. String
filters Filters of the filter inserter or loader, optional. Array of #Item filter objects. Array
filter_mode Filter mode of the filter inserter, optional. Either "whitelist" or "blacklist". String
override_stack_size The stack size the inserter is set to, optional. Types/uint8. Integer
drop_position The drop position the inserter is set to, optional. #Position object. Object
pickup_position The pickup position the inserter is set to, optional. #Position object. Object
request_filters Used by Prototype/LogisticContainer, optional. #Logistic filter object. Array
request_from_buffers Boolean. Whether this requester chest can request from buffer chests. Boolean
parameters Used by Programmable speaker, optional. #Speaker parameter object. Object
alert_parameters Used by Programmable speaker, optional. #Speaker alert parameter object Object
auto_launch Used by the rocket silo, optional. Boolean, whether auto launch is enabled. Boolean
variation Used by Prototype/SimpleEntityWithForce or Prototype/SimpleEntityWithOwner, optional. Types/GraphicsVariation
color Color of the Prototype/SimpleEntityWithForce, Prototype/SimpleEntityWithOwner, or train station, optional. #Color object. Object
station The name of the train station, optional. String

Inventory object

Key Description Data type
filters Array of #Item filter objects. Array
bar The index of the first inaccessible item slot due to limiting with the red "bar". 0-based, optional. Types/ItemStackIndex. Integer

Schedule object

Key Description Data type
schedule Array of #Schedule Record objects. Array
locomotives Array of entity numbers of locomotives using this schedule. Array

Schedule Record object

Key Description Data type
station The name of the stop for this schedule record. String
wait_conditions Array of #Wait Condition objects. Array

Wait Condition object

Key Description Data type
type One of "time", "inactivity", "full", "empty", "item_count", "circuit", "robots_inactive", "fluid_count", "passenger_present", "passenger_not_present". String
compare_type Either "and", or "or". Tells how this condition is to be compared with the preceding conditions in the corresponding wait_conditions array. String
ticks Number of ticks to wait or of inactivity. Only present when type is "time" or "inactivity". Optional. uint
condition CircuitCondition Object, only present when type is "item_count", "circuit" or "fluid_count". Object


Tile object

Key Description Data type
name Prototype name of the tile (e.g. "concrete") String
position #Position object, position of the entity within the blueprint. Object

Position object

Key Description Data type
x X position within the blueprint, 0 is the center. Floating point
y Y position within the blueprint, 0 is the center. Floating point

Connection object

Object containing information about the connections to other entities formed by red or green wires.

Key Description Data type
1 First connection point. The default for everything that doesn't have multiple connection points.#Connection point object Object
2 Second connection point. For example, the "output" part of an arithmetic combinator.#Connection point object Object

Connection point object

The actual point where a wire is connected to. Contains information about where it is connected to.

Key Description Data type
red An array of #Connection data object containing all the connections from this point created by red wire. Array
green An array of #Connection data object containing all the connections from this point created by green wire. Array

Connection data object

Information about a single connection between two connection points.

Key Description Data type
entity_id ID of the entity this connection is connected with. Integer
circuit_id The circuit connector id of the entity this connection is connected to, see defines.circuit_connector_id. Integer

Item request object

1 or more instances of key/value pairs. Key is the name of the item, string. Value is the amount of items to be requested, Types/ItemCountType.

Item filter object

Key Description Data type
name Name of the item prototype this filter is set to. String
index Index of the filter, 1-based. Integer

Infinity settings object

Key Description
remove_unfiltered_items Boolean. Whether the "remove unfiltered items" checkbox is checked. Boolean
filters Filters of the infinity container, optional. Array of #Infinity filter objects. Array

Infinity filter object

Key Description
name Name of the item prototype the filter is set to, string. String
count Number the filter is set to, Types/ItemCountType. Integer
mode Mode of the filter. Either "at-least", "at-most", or "exactly". String
index Index of the filter, 1-based. Integer

Logistic filter object

Key Description Data type
name Name of the item prototype this filter is set to. String
index Index of the filter, 1-based. Integer
count Number the filter is set to, Types/ItemCountType. Is 0 for storage chests. Integer

Speaker parameter object

Key Description Data type
playback_volume Types/double. Volume of the speaker. Floating point
playback_globally Boolean, whether global playback is enabled. Boolean
allow_polyphony Boolean, whether polyphony is allowed. Boolean

Speaker alert parameter object

Key Description Data type
show_alert Boolean, whether an alert is shown. Boolean
show_on_map Boolean, whether an alert icon is shown on the map. Boolean
icon_signal_id The icon that is displayed with the alert, #SignalID object. Object
alert_message String, message of the alert. String

Color object

Key Description Data type
r red, number from 0 to 1. Floating point
g green, number from 0 to 1. Floating point
b blue, number from 0 to 1. Floating point
a transparency, number from 0 to 1. Floating point
Retrieved from "https://testing-wiki.factorio.com/index.php?title=Blueprint_string_format&oldid=190672"