Official Factorio Wiki - User contributions [en]

Blueprint string format

2018-07-13T18:25:04Z

SuperSandro2000: Fixed intro text

{{Languages}} [[Category:Technical]]
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 and then encoded using base64 with a version byte in front. The version byte is currently 0 for vanilla 0.15 and 0.16.
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 ===

{| class="wikitable"
! 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 ===
{| class="wikitable"
! 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 object]]s.
| Array
|-
| tiles
| The tiles included in the blueprint, array of [[#Tile object]]s.
| Array
|-
| icons
| The icons of the blueprint set by the user, array of [[#Icon object]]s.
| Array
|-
| version
| The map version of the map the blueprint was created in.
| Integer (long)
|}

=== Icon object ===

{| class="wikitable"
! Key !! Description !! Data type
|-
| index
| Index of the icon, 1-based.
| Integer
|-
| signal
| 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
|}

=== Entity object ===

{| class="wikitable"
! 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 object]]s (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 object]]s.
| 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 ===

{| 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
| 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 ===

{| 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
|-
| r
| red
|-
| g
| green
|-
| b
| blue
|-
| a
| transparency
|}

Mods

2015-01-11T09:54:25Z

SuperSandro2000:

{{Languages}}
'''Since v0.10.7 the filenames for mods changed. [http://www.factorioforums.com/forum/viewtopic.php?f=14&t=5364 See how this works]!

== How to use mods ==

''' See [[Installing Mods]]

== List of user made mods ==

This is only the tip of the iceberg! '''A more or less complete list of mods is in the [http://www.factorioforums.com/forum/viewforum.php?f=14 Mods forum].'''
You are invited to add other mods to this list! See down how.

{| class="wikitable sortable"
!colspan="6"| Big Mods
|-
!style="width: 15%"| Mod
!style="width: 10%"| Author
!style="width: 10%"| Latest Release
!style="width: 10%"| Factorio Version
!style="width: 15%"| Dependencies
!style="width: 40%"| Brief Description
|-

| {{subpage|DyTech}} ([http://www.factorioforums.com/forum/viewforum.php?f=43 Forum])
| Dysoch || Multiple || Multiple || Multiple
| A modular set of mods that add something to pretty much every aspect of gameplay, depending on the modules you choose.
|-

| {{subpage|Treefarm}} ([http://www.factorioforums.com/forum/viewforum.php?f=44 Forum])
| drs9999 || 1.2.7 || 0.11.6 || base >= 0.11.0
| Adds treefarms, coal-processing and a production-chain for organic plastic.
|-

| {{subpage|F-mod}} ([http://www.factorioforums.com/forum/viewforum.php?f=45 Forum])
| ficolas || 1.10.5 || 0.10.x || ??
| Adds underground mining drills, extra machines and processing, planets and trading.
|-

| {{subpage|Test Mode}} ([http://www.factorioforums.com/forum/viewforum.php?f=46 Forum])
| rk84 || Multiple || Multiple || ??
| Provides various tools and scripts for testing purposes while in a game.
|-

| {{subpage|Bob's Mods}} ([http://www.factorioforums.com/forum/viewforum.php?f=51 Forum])
| bobingabout || Multiple || Multiple || Multiple
| A set of modular mods to add something to pretty much every aspect of gameplay, works well in combination with DyTech.
|-

|}

{| class="wikitable sortable"
!colspan="6"| Large Gameplay Changes and Overhaul Mods
|-
!style="width: 15%"| Mod
!style="width: 10%"| Author
!style="width: 10%"| Latest Release
!style="width: 10%"| Factorio Version
!style="width: 15%"| Dependencies
!style="width: 40%"| Brief Description
|-

| {{subpage|Replicator}} ([http://www.factorioforums.com/forum/viewtopic.php?f=14&t=6769 Forum])
| jamuspsi || 0.2.1 || 0.11.3+ || ??
| Big change in gameplay, create resources from energy. Lots of energy.
|-

| {{subpage|Hardcorio}} ([http://www.factorioforums.com/forum/viewtopic.php?f=14&t=6634 Forum])
| Styx3 || 0.3.5 || 0.11.6+ || base
| A large revamp of warfare elements in Factorio.
|-

| {{subpage|Cursed Exp}} ([http://www.factorioforums.com/forum/viewtopic.php?f=14&t=7189 Forum])
| L0771 || 0.1.1 || 0.11.6+ || base >= 0.11.5, Treefarm-Mod >= 1.2.6
| Adds experience elements and upgradeable mines/turrets. You really just need to check out the post for more info, it's quite different.

|}

{| class="wikitable sortable"
!colspan="6"| Modpacks/Large variety of Changes and New Items
|-
!style="width: 15%"| Mod
!style="width: 10%"| Author
!style="width: 10%"| Latest Release
!style="width: 10%"| Factorio Version
!style="width: 15%"| Dependencies
!style="width: 40%"| Brief Description
|-

| {{subpage|MoMods}} ([http://www.factorioforums.com/forum/viewtopic.php?f=14&t=2778 Forum])
| ludsoe || Multiple || 0.11.x+ || ??
| A variety of mods changing various gameplay elements.

|}

{| class="wikitable sortable"
!colspan="6"| Map and Spawning Changes
|-
!style="width: 15%"| Mod
!style="width: 10%"| Author
!style="width: 10%"| Latest Release
!style="width: 10%"| Factorio Version
!style="width: 15%"| Dependencies
!style="width: 40%"| Brief Description
|-

| {{subpage|Resource Spawner Overhaul}} ([http://www.factorioforums.com/forum/viewtopic.php?f=14&t=4761 Forum])
| Dark || 1.0.2 || 0.10.2+ || ??
| Edits resource and biter spawning behavior, encourages longer-distance transportation with more spread out resources.
|-

| {{subpage|Straight World}} ([http://www.factorioforums.com/forum/viewtopic.php?f=14&t=7191 Forum])
| Xecutor || 1.0.1 || 0.10.x+ || ??
| Makes the world straight and rectangular.
|-

|}

{| class="wikitable sortable"
!colspan="6"| Energy/Logistics/Fluid Handling
|-
!style="width: 15%"| Mod
!style="width: 10%"| Author
!style="width: 10%"| Latest Release
!style="width: 10%"| Factorio Version
!style="width: 15%"| Dependencies
!style="width: 40%"| Brief Description
|-

| {{subpage|Boxing}} ([http://www.factorioforums.com/forum/viewtopic.php?f=14&t=7481 Forum])
| Xecutor || 0.5.0 || 0.10.x || base >= 0.10.0
| Adds a way to box up/condense some basic goods, such as plates and plastic.
|-

| {{subpage|Uranium Power}} ([http://www.factorioforums.com/forum/viewtopic.php?f=14&t=6740 Forum])
| Liquius || 0.3.0 || 0.11.x || ??
| Adds nuclear fission reactors along with a fairly realistic industrial process for gathering and processing uranium.
|-

| {{subpage|Rail Tanker - Liquid Transportation}} ([http://www.factorioforums.com/forum/viewtopic.php?f=14&t=6847 Forum])
| JamesOFarrell || 0.0.7 || 0.11.x || ??
| Add a new tanker, holds liquids without having to barrel them first.
|-

| {{subpage|Belt Switchers}} ([http://www.factorioforums.com/forum/viewtopic.php?f=14&t=4743 Forum])
| ThaPear || 0.0.1 || 0.11.5+ || ??
| Add belt switches, which swap the lane items are traveling on.
|-

| {{subpage|Belt Blocker}} ([http://www.factorioforums.com/forum/viewtopic.php?f=14&t=6227 Forum])
| JamesOFarell || 1.0.0 || 0.11.x || ??
| Adds an object that blocks a single lane on a belt.
|-

| {{subpage|Offshore Dump}} ([http://www.factorioforums.com/forum/viewtopic.php?f=14&t=6826 Forum])
| Kirk || 0.0.1 || 0.11.x || ??
| Adds a pump to dump liquids into water, causing pollution but removing liquids.
|-

| {{subpage|Liquid Void}} ([http://www.factorioforums.com/forum/viewtopic.php?f=14&t=5412 Forum])
| Rseding91 || 1.0.0 || 0.11.x || ??
| Adds a pipe that erases fluids in it.
|-

|}

{| class="wikitable sortable"
!colspan="6"| Uncategorized
|-
!style="width: 15%"| Mod
!style="width: 10%"| Author
!style="width: 10%"| Latest Release
!style="width: 10%"| Factorio Version
!style="width: 15%"| Dependencies
!style="width: 40%"| Brief Description
|-
| {{subpage|Start Out Planning}} ([http://www.factorioforums.com/forum/viewtopic.php?f=14&t=7561 Forum])
| AlyxDeLunar || 2.0.0 || 0.11.x || base, ?hardcorio
| Starts player with a blueprint, deconstruction planner, and automated construction enabled at map creation.
|-

| {{subpage|Record Your Stuff!}} ([http://www.factorioforums.com/forum/viewtopic.php?f=14&t=7691 Forum])
| AlyxDeLunar || 1.0.0 || 0.11.x || base
| Provides a numerical count of pollution.
|-

|}

== Dependencies? ==
Dependencies are used to tell the game what order mods should be loaded. A mod that has dependency gets loaded after the mod it depends. The mod will not be active if it has dependency to a mod that is missing, disabled (by user) or invalid (by dependency of depended mod)

If a dependency is preceded by a question mark (as in: ?Example-Mod >= 1.0.0), then it is an optional dependency. The dependency will not be required to run the mod, but if it does exist, will be loaded before the mod. This usually means the mod will modify something about its dependency if it exists.

*'''base''' is the default game data that comes with Factorio.
[[Modding_overview#Mod_meta_information]]

== How to add my/another mod into this page? ==

Two possibilities:
# become user of the wiki (get an account) and add it. You can use the {{subpage|ExampleMod}}, to see, how you can structure the information about your own mod!
# ask in the forum, if someone would add it

== Subpages ==

{{Special:PrefixIndex/{{FULLPAGENAME}}/}}