In other languages:

Blueprint string format: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 11: Line 11:


{| 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
|-
|-
| blueprints
| 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.
| 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, 0-based.
| Index of the currently selected blueprint, 0-based.
| Integer
|-
|-
| version
| version
| The map version of the map the blueprint was created in.
| The map version of the map the blueprint was created in.
| 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
|-
|-
| 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
| tiles
| The tiles included in the blueprint, array of [[#Tile object]]s.
| 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
|-
|-
| version
| version
| The map version of the map the blueprint was created in.
| The map version of the map the blueprint was created in.
| Integer (long)
|}
|}


Line 55: Line 66:


{| class="wikitable"
{| class="wikitable"
! Key !! Description
! Key !! Description !! Data type
|-
|-
| index
| index
| Index of the icon, 1-based.
| Index of the icon, 1-based.
| Integer
|-
|-
| signal
| signal
| The icon that is displayed, [[#SignalID object]].
| The icon that is displayed, [[#SignalID object]].
| Object
|}
|}


=== SignalID object ===
=== SignalID object ===
{| class="wikitable"
{| class="wikitable"
! Key !! Description
! Key !! Description !! Data type
|-
|-
| name
| name
| Name of the signal prototype this signal is set to.
| Name of the signal prototype this signal is set to.
| String
|-
|-
| type
| type
| Type of the signal. Either "item", "fluid" or "virtual".
| Type of the signal. Either "item", "fluid" or "virtual".
| String
|}
|}


Line 78: Line 93:


{| class="wikitable"
{| class="wikitable"
! Key !! Description
! Key !! Description !! Data type
|-
|-
| entity_number
| entity_number
| Index of the entity, 1-based.
| 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 object]], position of the entity within the blueprint.
| [[#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
|-
|-
| 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
| control_behaviour
|
|
| 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]]
| 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.
| Name of the recipe prototype this assembling machine is set to, optional, string.
|String
|-
|-
| bar
| 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]].
| 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
|-
|-
| infinity_settings
| infinity_settings
| Used by [[Prototype/InfinityContainer]], optional. [[#Infinity settings object]]
| Used by [[Prototype/InfinityContainer]], optional. [[#Infinity settings object]]
| Object
|-
|-
| type
| type
| Type of the underground belt or loader, optional. Either "input" or "output".
| Type of the underground belt or loader, optional. Either "input" or "output".
| String
|-
|-
| input_priority
| input_priority
| Input priority of the splitter, optional. Either "right" or "left", "none" is omitted.
| Input priority of the splitter, optional. Either "right" or "left", "none" is omitted.
| String
|-
|-
| output_priority
| output_priority
| Output priority of the splitter, optional. Either "right" or "left", "none" is omitted.
| Output priority of the splitter, optional. Either "right" or "left", "none" is omitted.
| String
|-
|-
| filter
| filter
| Filter of the splitter, optional. Name of the item prototype the filter is set to, string.
| Filter of the splitter, optional. Name of the item prototype the filter is set to, string.
| String
|-
|-
| filters
| filters
| Filters of the filter inserter or loader, optional. Array of [[#Item filter object]]s.
| Filters of the filter inserter or loader, optional. Array of [[#Item filter object]]s.
| Array
|-
|-
| override_stack_size
| override_stack_size
| The stack size the inserter is set to, optional. [[Types/uint8]].
| The stack size the inserter is set to, optional. [[Types/uint8]].
| Integer
|-
|-
| drop_position
| drop_position
| The drop position the inserter is set to, optional. [[#Position object]].
| The drop position the inserter is set to, optional. [[#Position object]].
| Object
|-
|-
| pickup_position
| pickup_position
| The pickup position the inserter is set to, optional. [[#Position object]].
| The pickup position the inserter is set to, optional. [[#Position object]].
| Object
|-
|-
| request_filters
| request_filters
| Used by [[Prototype/LogisticContainer]], optional. [[#Logistic filter object]].
| Used by [[Prototype/LogisticContainer]], optional. [[#Logistic filter object]].
| Array
|-
|-
| request_from_buffers
| request_from_buffers
| Boolean. Whether this requester chest can request from buffer chests.
| Boolean. Whether this requester chest can request from buffer chests.
| Boolean
|-
|-
| parameters
| parameters
| Used by [[Programmable speaker]], optional. [[#Speaker parameter object]].
| Used by [[Programmable speaker]], optional. [[#Speaker parameter object]].
| Object
|-
|-
| alert_parameters
| alert_parameters
| Used by [[Programmable speaker]], optional. [[#Speaker alert parameter object]]
| Used by [[Programmable speaker]], optional. [[#Speaker alert parameter object]]
| Object
|-
|-
| auto_launch
| auto_launch
| Used by the rocket silo, optional. Boolean, whether auto launch is enabled.
| Used by the rocket silo, optional. Boolean, whether auto launch is enabled.
| Boolean
|-
|-
| variation
| variation
| Used by [[Prototype/SimpleEntityWithForce]] or [[Prototype/SimpleEntityWithOwner]], optional. [[Types/GraphicsVariation]]
| Used by [[Prototype/SimpleEntityWithForce]] or [[Prototype/SimpleEntityWithOwner]], optional. [[Types/GraphicsVariation]]
|
|-
|-
| color
| color
| Color of the [[Prototype/SimpleEntityWithForce]], [[Prototype/SimpleEntityWithOwner]], or train station, optional. [[#Color object]].
| Color of the [[Prototype/SimpleEntityWithForce]], [[Prototype/SimpleEntityWithOwner]], or train station, optional. [[#Color object]].
| Object
|-
|-
| station
| station
| The name of the train station, optional.
| The name of the train station, optional.
| String
|}
|}


Line 162: Line 203:


{| class="wikitable"
{| class="wikitable"
! Key !! Description
! Key !! Description !! Data type
|-
|-
| name
| name
| Prototype name of the tile (e.g. "concrete")
| Prototype name of the tile (e.g. "concrete")
| String
|-
|-
| position
| position
| [[#Position object]], position of the entity within the blueprint.
| [[#Position object]], position of the entity within the blueprint.
| Object
|}
|}


Line 174: Line 217:


{| class="wikitable"
{| class="wikitable"
! Key !! Description
! Key !! Description !! Data type
|-
|-
| x
| x
| X position within the blueprint, 0 is the center.
| X position within the blueprint, 0 is the center.
| Floating point
|-
|-
| y
| y
| Y position within the blueprint, 0 is the center.
| Y position within the blueprint, 0 is the center.
| Floating point
|}
|}


=== Connection object ===
=== 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 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
| ID of the circuit this connection is connected with.
| Integer
|}


=== Item request object ===
=== Item request object ===
Line 193: Line 281:


{| class="wikitable"
{| class="wikitable"
! Key !! Description
! Key !! Description !! Data type
|-
|-
| name
| name
| Name of the item prototype this filter is set to.
| Name of the item prototype this filter is set to.
| String
|-
|-
| index
| index
| Index of the filter, 1-based.  
| Index of the filter, 1-based.  
| Integer
|}
|}


Line 208: Line 298:
| remove_unfiltered_items
| remove_unfiltered_items
| Boolean. Whether the "remove unfiltered items" checkbox is checked.
| Boolean. Whether the "remove unfiltered items" checkbox is checked.
| Boolean
|-
|-
| filters
| filters
| Filters of the infinity container, optional. Array of [[#Infinity filter object]]s.
| Filters of the infinity container, optional. Array of [[#Infinity filter object]]s.
| Array
|}
|}


Line 219: Line 311:
| name
| name
| Name of the item prototype the filter is set to, string.
| Name of the item prototype the filter is set to, string.
| String
|-
|-
| count
| count
| Number the filter is set to, [[Types/ItemCountType]].
| Number the filter is set to, [[Types/ItemCountType]].
| Integer
|-
|-
| mode
| mode
| Mode of the filter. Either "at-least", "at-most", or "exactly".
| Mode of the filter. Either "at-least", "at-most", or "exactly".
| String
|-
|-
| index
| index
| Index of the filter, 1-based.  
| Index of the filter, 1-based.
| Integer
|}
|}


=== Logistic filter object ===
=== Logistic filter object ===
{| class="wikitable"
{| class="wikitable"
! Key !! Description
! Key !! Description !! Data type
|-
|-
| name
| name
| Name of the item prototype this filter is set to.
| Name of the item prototype this filter is set to.
| String
|-
|-
| index
| index
| Index of the filter, 1-based.
| Index of the filter, 1-based.
| Integer
|-
|-
| count
| count
| Number the filter is set to, [[Types/ItemCountType]]. Is 0 for storage chests.
| Number the filter is set to, [[Types/ItemCountType]]. Is 0 for storage chests.
| Integer
|}
|}


=== Speaker parameter object ===
=== Speaker parameter object ===
{| class="wikitable"
{| class="wikitable"
! Key !! Description
! Key !! Description !! Data type
|-
|-
| playback_volume
| playback_volume
| [[Types/double]]. Volume of the speaker.
| [[Types/double]]. Volume of the speaker.
| Floating point
|-
|-
| playback_globally
| playback_globally
| Boolean, whether global playback is enabled.
| Boolean, whether global playback is enabled.
| Boolean
|-
|-
| allow_polyphony
| allow_polyphony
| Boolean, whether polyphony is allowed.
| Boolean, whether polyphony is allowed.
| Boolean
|}
|}


=== Speaker alert parameter object ===
=== Speaker alert parameter object ===
{| class="wikitable"
{| class="wikitable"
! Key !! Description
! Key !! Description !! Data type
|-
|-
| show_alert
| show_alert
| Boolean, whether an alert is shown.
| Boolean, whether an alert is shown.
| Boolean
|-
|-
| show_on_map
| show_on_map
| Boolean, whether an alert icon is shown on the map.
| Boolean, whether an alert icon is shown on the map.
| Boolean
|-
|-
| icon_signal_id
| icon_signal_id
| The icon that is displayed with the alert, [[#SignalID object]].
| The icon that is displayed with the alert, [[#SignalID object]].
| Object
|-
|-
| alert_message
| alert_message
| String, message of the alert.
| String, message of the alert.
| String
|}
|}


Revision as of 18:41, 30 April 2018

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

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
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. 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
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
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
connections Circuit connection, object with keys starting from 1, values are #Connection objects (optional). Object
control_behaviour 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
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
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

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 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 ID of the circuit this connection is connected with. 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
r red
g green
b blue
a transparency
Retrieved from "https://wiki.factorio.com/index.php?title=Blueprint_string_format&oldid=158766"