Official Factorio Wiki - User contributions [en]

Mod settings file format

2018-04-25T19:05:37Z

Rseding91:

{{Languages}}mod-settings.dat is a binary stream file format. The data is read from start of file until there is no more data. If there is no data and you are at a point where there should be data then the file is malformed. If you're at a point when you expect no more data but there is data then the file is malformed.

A C# example on how to parse the file format can be found here: https://forums.factorio.com/59851

== The file format ==

The first 8 bytes are the [[Version_string_format|version]] of the game the file was created in.

Next is a single [[Property tree]]

== Sections ==

The loaded [[Property tree]] is expected to be of the [[Property_tree#Dictionary|Dictionary]] type with the following 3 sections:

=== Startup ===

This section is a [[Property tree]] with a key value of "startup" and a [[Property_tree#Dictionary|Dictionary]] value of mod settings.

=== Runtime Global ===

This section is a [[Property tree]] with a key value of "runtime-global" and a [[Property_tree#Dictionary|Dictionary]] value of mod settings.

=== Runtime Per User ===

This section is a [[Property tree]] with a key value of "runtime-per-user" and a [[Property_tree#Dictionary|Dictionary]] value of mod settings.

[[Category:Technical]]

Property tree

2018-03-20T20:40:59Z

Rseding91:

A PropertyTree (the Factorio class name) is a recursive variant format that holds a key <> value pair where the key may be empty and the value may be only one of the following types:

{| class="wikitable"
|+PropertyTreeType ([[Data_types#unsigned byte|unsigned byte]])
|-
! Value !! Name
|-
| 0 || [[Property_tree#None|none]]
|-
| 1 || [[Property_tree#Bool|bool]]
|-
| 2 || [[Property_tree#Number|number]]
|-
| 3 || [[Property_tree#String|string]]
|-
| 4 || [[Property_tree#List|list]]
|-
| 5 || [[Property_tree#Dictionary|dictionary]]
|}

== The file format ==

1 [[Data_types#unsigned byte|unsigned byte]] representing the PropertyTreeType.

1 [[Data_types#bool|bool]] the any-type flag (currently not important outside of Factorio internals; default value is false)

== Property Tree Type ==

=== None ===
Nothing

=== Bool ===
1 [[Data_types#bool|bool]]

=== Number ===
1 [[Data_types#double|double]]

=== String ===
1 [[Data_types#bool|bool]] if the string is empty - if not empty:

1 [[Data_types#Space optimized|Space optimized]] [[Data_types#unsigned int|unsigned int]] the size of the string

N [[Data_types#byte|byte]] the string contents

=== List ===
Identical to Dictionary

=== Dictionary ===
1 [[Data_types#unsigned int|unsigned int]] the number of PropertyTree elements

For each element:

1 [[Property_tree#String|string]] the dictionary element name or it can be empty if loading a list

1 [[Property_tree]]

Property tree

2018-03-20T20:39:11Z

Rseding91:

A PropertyTree (the Factorio class name) is a recursive variant format that holds a key <> value pair where the key may be empty and the value may be only one of the following types:

{| class="wikitable"
|+PropertyTreeType ([[Data_types#unsigned byte|unsigned byte]])
|-
! Value !! Name !! Data type
|-
| 0 || none || n/a
|-
| 1 || bool || [[Data_types#bool|bool]]
|-
| 2 || number || [[Data_types#double|double]]
|-
| 3 || string || [[Data_types#string|string]]
|-
| 4 || list || [[Data_types#array|array]]
|-
| 5 || dictionary || [[Data_types#dict|dict]]
|}

== The file format ==

1 [[Data_types#unsigned byte|unsigned byte]] representing the PropertyTreeType.

1 [[Data_types#bool|bool]] the any-type flag (currently not important outside of Factorio internals; default value is false)

== Property Tree Type ==

=== None ===
Nothing

=== Bool ===
1 [[Data_types#bool|bool]]

=== Number ===
1 [[Data_types#double|double]]

=== String ===
1 [[Data_types#bool|bool]] if the string is empty - if not empty:

1 [[Data_types#Space optimized|Space optimized]] [[Data_types#unsigned int|unsigned int]] the size of the string

N [[Data_types#byte|byte]] the string contents

=== List ===
Identical to Dictionary

=== Dictionary ===
1 [[Data_types#unsigned int|unsigned int]] the number of PropertyTree elements

For each element:

1 [[Property_tree#String|string]] the dictionary element name or it can be empty if loading a list

1 [[Property_tree]]

Mod settings file format

2018-03-20T20:36:04Z

Rseding91: Created page with "mod-settings.dat is a binary stream file format. The data is read from start of file until there is no more data. If there is no data and you are at a point where there should..."

mod-settings.dat is a binary stream file format. The data is read from start of file until there is no more data. If there is no data and you are at a point where there should be data then the file is malformed. If you're at a point when you expect no more data but there is data then the file is malformed.

== The file format ==

The first 8 bytes are the [[Version_string_format|version]] of the game the file was created in.

Next is a single [[Property_tree]]

== Sections ==

The loaded [[Property_tree]] is expected to be of the [[Property_tree#Dictionary|Dictionary]] type with the following 3 sections:

=== Startup ===

This section is a [[Property_tree]] with a key value of "startup" and a [[Property_tree#Dictionary|Dictionary]] value of mod settings.

=== Runtime Global ===

This section is a [[Property_tree]] with a key value of "runtime-global" and a [[Property_tree#Dictionary|Dictionary]] value of mod settings.

=== Runtime Per User ===

This section is a [[Property_tree]] with a key value of "runtime-per-user" and a [[Property_tree#Dictionary|Dictionary]] value of mod settings.

Property tree

2018-03-20T20:30:37Z

Rseding91: PropertyTree file format

A PropertyTree (the Factorio class name) is a recursive variant format that holds a key <> value pair where the key may be empty and the value may be only one of the following types:

{| class="wikitable"
|+PropertyTreeType ([[Data_types#unsigned byte|unsigned byte]])
|-
! Value !! Name !! Data type
|-
| 0 || none || n/a
|-
| 1 || bool || [[Data_types#bool|bool]]
|-
| 2 || number || [[Data_types#double|double]]
|-
| 3 || string || [[Data_types#string|string]]
|-
| 4 || list || [[Data_types#array|array]]
|-
| 5 || dictionary || [[Data_types#dict|dict]]
|-

== The file format ==

1 [[Data_types#unsigned byte|unsigned byte]] representing the PropertyTreeType.

1 [[Data_types#bool|bool]] the any-type flag (currently not important outside of Factorio internals; default value is false)

== Property Tree Type ==

=== None ===
Nothing

=== Bool ===
1 [[Data_types#bool|bool]]

=== Number ===
1 [[Data_types#double|double]]

=== String ===
1 [[Data_types#bool|bool]] if the string is empty - if not empty:

1 [[Data_types#Space optimized|Space optimized]] [[Data_types#unsigned int|unsigned int]] the size of the string

N [[Data_types#byte|byte]] the string contents

=== List ===
Identical to Dictionary

=== Dictionary ===
1 [[Data_types#unsigned int|unsigned int]] the number of PropertyTree elements

For each element:

1 [[Property_tree#String|string]] the dictionary element name or it can be empty if loading a list

1 [[Property_tree]]

Version string format

2018-03-20T20:26:21Z

Rseding91:

[[Category:Technical]]

Factorio uses a common encoding method to serialize the version string in binary data that's present in multiple places, such as the map exchange string and save game file format. It consists of four consecutive 2-byte unsigned [https://en.wikipedia.org/wiki/Endianness#Little-endian little-endian] values. We'll use version 0.14.21 as an example:

{| class="wikitable"
| [[Data_Types#unsigned short|unsigned short]]
| Factorio's major version number (e.g. 0)
|-
| [[Data_Types#unsigned short|unsigned short]]
| Factorio's minor version number (e.g. 14)
|-
| [[Data_Types#unsigned short|unsigned short]]
| Factorio's patch version number (e.g. 21)
|-
| [[Data_Types#unsigned short|unsigned short]]
| Factorio's developer version number
|}

Version string format

2018-03-20T20:06:48Z

Rseding91:

Data types

2018-03-20T20:04:34Z

Rseding91: Added space optimized info.

{{Languages}} [[Category:Technical]]

This page describes common binary data types used by Factorio, and most modern day computer applications, internally.

== Properties ==

=== Endianness ===

All data stored in computers are stored in single, small unit of data called a "byte". Larger units of data are split into multiple bytes. The order in which sequential bytes are assembled together to form a larger unit of data is referred to as it's "endianess". '''All data saved locally by Factorio is stored in "little"-endian format''' (because Intel favored little endian processors in the ancient times). All data transferred over the network by Factorio is done in "big"-endian format (the standard for network stuffs, so much so that it's often refered to as "network"-endian). (Please correct any of this if I'm wrong!!) For more information about endianness, please see the [https://en.wikipedia.org/wiki/Endianness Wikipedia entry].

=== Signedness ===

Another property of multi-byte data types is it's signedness. Please see the [https://en.wikipedia.org/wiki/Signedness wikipedia entry]. Data types without a u- prefix are signed, and '''those marked with a u- prefixed are unsigned'''. I'm not certain which type of signedness Factorio uses - perhaps it is machine dependant, but for me it always appears to be [https://en.wikipedia.org/wiki/Two%27s_complement two's complement].

=== Space Optimized ===

Some integer values are save using a "space optimized" system where instead of always writing out the full multi-byte integer Factorio will check if the integer size is < 255 and if so a single [[Data_types#unsigned byte|unsigned byte]] is written. If the integer size is >= 255 the value 255 as an [[Data_types#unsigned byte|unsigned byte]] is written and then the full data type is written. This is mainly used when saving strings, arrays, and dictionaries because their size is almost always < 255 bytes and in those cases it saves 3 bytes of space.

== Data Types ==

=== bool ===

A 1 byte value. Considered True iff value equals 1, otherwise it is considered False.

=== byte ===

1 byte long signed integer.

=== unsigned byte ===

1 byte long unsigned integer.

=== short ===

2 byte long signed integer.

=== unsigned short ===

2 byte long unsigned integer.

=== int ===

4 byte long signed integer.

=== unsigned int ===

4 byte long unsigned integer.

=== long ===

8 byte long signed integer.

=== unsigned long ===

8 byte long unsigned integer.

=== float ===

An 4 byte (32 bit) long [https://en.wikipedia.org/wiki/Floating-point_arithmetic floating point number] stored in a special format with two fields - the number's exponent, and it's [https://en.wikipedia.org/wiki/Significand mantissa]. This format is described by the [https://en.wikipedia.org/wiki/Single-precision_floating-point_format 32-bit data type in IEEE 754].

=== double ===

An 8 byte (64 bit) long [https://en.wikipedia.org/wiki/Floating-point_arithmetic floating point number] stored in a special format with two fields - the number's exponent, and it's [https://en.wikipedia.org/wiki/Significand mantissa]. This format is described by the [https://en.wikipedia.org/wiki/Double-precision_floating-point_format 64-bit data type in IEEE 754].

=== string ===

Strings in Factorio are stored [https://en.wikipedia.org/wiki/String_(computer_science)#Length-prefixed Pascal-style] - they're a variable length data type with two fields: an [[#unsigned int|unsigned int]] describing how many bytes long the string data is, and then the string data itself.

=== array ===

<code>array<element type></code>

Arrays are a container type. Like a [[#string|string]], they're prefixed with an [[#unsigned int|unsigned int]] describing how many elements are in the array, followed by that many elements of the specified element type back to back.

=== dict ===

<code>dict<key type, value type></code>

Dictionaries (or "dict"s for short) are like [[#array|arrays]], but their elements consist of (key, value) pairs that map their key (usually a string, or a number) to their value. Just like [[#array|arrays]], they're prefixed with an [[#unsigned int|unsigned int]] describing how many (key, value) pairs are in the dict, followed by that many (key, value) pairs.
Each key should be unique and only appear once. In a few esoteric languages, if a key is provided multiple times then only the last value is used - but in Factorio, assume any dict with multiple identical keys is malformed and error.

== See also ==
* [http://lua-api.factorio.com/latest/Builtin-Types.html Factorios Lua API documentation about its builtin types]

Data types

2018-03-20T19:49:55Z

Rseding91: Added signed vs unsigned

{{Languages}} [[Category:Technical]]

This page describes common binary data types used by Factorio, and most modern day computer applications, internally.

== Properties ==

=== Endianness ===

All data stored in computers are stored in single, small unit of data called a "byte". Larger units of data are split into multiple bytes. The order in which sequential bytes are assembled together to form a larger unit of data is referred to as it's "endianess". '''All data saved locally by Factorio is stored in "little"-endian format''' (because Intel favored little endian processors in the ancient times). All data transferred over the network by Factorio is done in "big"-endian format (the standard for network stuffs, so much so that it's often refered to as "network"-endian). (Please correct any of this if I'm wrong!!) For more information about endianness, please see the [https://en.wikipedia.org/wiki/Endianness Wikipedia entry].

=== Signedness ===

Another property of multi-byte data types is it's signedness. Please see the [https://en.wikipedia.org/wiki/Signedness wikipedia entry]. Data types without a u- prefix are signed, and '''those marked with a u- prefixed are unsigned'''. I'm not certain which type of signedness Factorio uses - perhaps it is machine dependant, but for me it always appears to be [https://en.wikipedia.org/wiki/Two%27s_complement two's complement].

== Data Types ==

=== bool ===

A 1 byte value. Considered True iff value equals 1, otherwise it is considered False.

=== byte ===

1 byte long signed integer.

=== unsigned byte ===

1 byte long unsigned integer.

=== short ===

2 byte long signed integer.

=== unsigned short ===

2 byte long unsigned integer.

=== int ===

4 byte long signed integer.

=== unsigned int ===

4 byte long unsigned integer.

=== long ===

8 byte long signed integer.

=== unsigned long ===

8 byte long unsigned integer.

=== float ===

An 4 byte (32 bit) long [https://en.wikipedia.org/wiki/Floating-point_arithmetic floating point number] stored in a special format with two fields - the number's exponent, and it's [https://en.wikipedia.org/wiki/Significand mantissa]. This format is described by the [https://en.wikipedia.org/wiki/Single-precision_floating-point_format 32-bit data type in IEEE 754].

=== double ===

An 8 byte (64 bit) long [https://en.wikipedia.org/wiki/Floating-point_arithmetic floating point number] stored in a special format with two fields - the number's exponent, and it's [https://en.wikipedia.org/wiki/Significand mantissa]. This format is described by the [https://en.wikipedia.org/wiki/Double-precision_floating-point_format 64-bit data type in IEEE 754].

=== string ===

Strings in Factorio are stored [https://en.wikipedia.org/wiki/String_(computer_science)#Length-prefixed Pascal-style] - they're a variable length data type with two fields: an [[#unsigned int|unsigned int]] describing how many bytes long the string data is, and then the string data itself.

=== array ===

<code>array<element type></code>

Arrays are a container type. Like a [[#string|string]], they're prefixed with an [[#unsigned int|unsigned int]] describing how many elements are in the array, followed by that many elements of the specified element type back to back.

=== dict ===

<code>dict<key type, value type></code>

Dictionaries (or "dict"s for short) are like [[#array|arrays]], but their elements consist of (key, value) pairs that map their key (usually a string, or a number) to their value. Just like [[#array|arrays]], they're prefixed with an [[#unsigned int|unsigned int]] describing how many (key, value) pairs are in the dict, followed by that many (key, value) pairs.
Each key should be unique and only appear once. In a few esoteric languages, if a key is provided multiple times then only the last value is used - but in Factorio, assume any dict with multiple identical keys is malformed and error.

== See also ==
* [http://lua-api.factorio.com/latest/Builtin-Types.html Factorios Lua API documentation about its builtin types]

Debug mode

2017-09-16T22:23:23Z

Rseding91:

{{Languages}}

''Debug mode'' is used mainly by developers and modders to analyze the running state of the game. It can be enabled to show detailed information about the game world, and its information varies based on which level is active. The keys to enable debug mode are f5 through f7.

For example, one can:
* See the path the [[Biter]]s are coming from and where they plan to target,
* See the position / coordinates of the cursor,
* See a grid-overlay for the [[Tile]]s and [[Chunk]]s,
* See the blocks in a railway network,
* See additional non-game related information, such as Updates Per Second and FPS.

== Activate the debug mode ==

You have 4 debug-levels:

* '''Always''' - This is the default mode, if no mode is active. Keep very few things active here.
* '''Basic''' - The first mode, accessed by pressing {{keybinding|F5}}. What power users often use.
* '''Detailed''' - The second mode, accessed by pressing {{keybinding|F6}}. The most commonly used for modders and developers.
* '''Full''' - The third mode, accessed by pressing {{keybinding|F7}}. Shows literally everything, tends to be unreadable.

To switch back to "always" you need to press the previous key again. Example: Press F5 to go to "basic", then press F6 to watch "detailed" and then press F6 again to switch back to "always".

== Configuring the debug mode ==

To configure the 4 modes, press {{keybinding|F4}}. This opens up a menu with many options. You can move this menu with the mouse, if it hides some interesting underlying thing. You can switch between 4 folders, which reflects the option for that debug-mode ("always", "basic", "detailed", "full"). The options are the same for each mode. Each mode can be configured to the user's liking, the different modes are only for convenience.

== List of debug-options and their function ==

* <code>show_fps</code>
** Will show the current frames-per-second, or FPS. Should be normally about 60.
* <code>show_detailed_info</code>
** Shows the cursor position in [[Tile]]s (and subdivisions of that), [[Chunk]]s and [[Region]]
** Current resolution and zoom
** How many objects are on the screen (painted by the graphic card)
** How many entities, chunks and paths are in the game and used.
* <code>show-time-usage</code>
** Many important internal statistics about the timing. [http://www.factorioforums.com/forum/viewtopic.php?f=49&t=7972 F5 debug info - how to read it?] - how to interpret...
* <code>show-sprite-counts</code>
** The counts of each sprite rendered on screen.
* <code>show-multiplayer-waiting-icon</code>
** When in a multiplayer game: if the game is currently waiting for the server to process.
* <code>show-multiplayer-statistics</code>
** The latency information when in multiplayer.
* <code>show_tile_grid</code>
** Quite useful to turn it on for the "always"-mode. It shows the borders of the [[Tile]]s and [[Chunk]]s.
* <code>show_collision_rectangles</code>
** Shows the collision boxes of each entity (red).
* <code>show_selection_rectangles</code>
** Shows the a blue box over each entity, if you hover over it, it will be selected.
* <code>show_paths</code>
** The calculated paths for the biters in different colors.
* <code>show_next_waypoint_bb</code>
** Shows waypoints for biters (in green), nearly the same info as the next.
* <code>show_target</code>
** Shows the current target of the biters (red).
* <code>show_unit_group_info</code>
** Biter groups, which belong together (circles and lines belonging together)
* <code>show-unit-behavior-info</code>
* <code>show_last_path_detail</code>
** The A*-algorithm at work, calculating new paths.
* <code>show_path_cache</code>
** The source-positions of a path and about the length (?)
* <code>show-path-cache-paths</code>
* <code>show_rail_paths</code>
** Which path a train will follow.
* <code>show_rolling_stock_count</code>
** Shows inserter positions
* <code>show_rail_connections</code>
** Shows rail connections.
* <code>show_rail_segments</code>
** Shows the segment borders and enables you to see the borders of the block.
* <code>show-rail-blocks</code>
* <code>show-rail-joints</code>
* <code>show_train_stop_point</code>
** When a train slows down it shows the calculated point where it should halt
* <code>show-train-braking-distance</code>
** The distance a train will take to stop at its current speed
* <code>show-train-signals</code>
* <code>show_network_connected_entities</code>
** Displays the network-id of the electric network that a pole is connected to
* <code>show_circuit_network_numbers</code>
** Shows the number (and color) of circuit networks
* <code>show_energy_sources_networks</code>
** Which network-id an entity is connected to.
* <code>show_active_state</code>
** Inserters, fish, turrets are turned to passive, if not used; Red = inactive, Purple = inactive until enemies aren't around (turrets etc), Green = inactive until player isn't around (fish). Passive entities consume less CPU power.
* <code>show-wakeup-lists</code>
** When an entity is sleeping in another entity it shows which entities it's sleeping in
* <code>show-pollution-values</code>
** Shows the numeric pollution amount on each chunk.
* <code>show_active_enemies_on_chunk_counts</code>
** Not 100% clear: displays in the map view, how much biter nests (blue) are targeting to which are (red for the number of biters?), green: unknown?
* <code>show_active_chunks</code>
** Shows in the map view, which chunks are "on", unmarked chunks are not calculated
* <code>show-polluted-chunks</code>
** Shows which chunks have pollution
* <code>show_enemy_expansion_candidate_chunks</code>
** Where is space left to spread the brood?
* <code>show-enemy-expansion-candidate-chunk-values</code>
** Which chunks the enemies will try to expand into
* <code>show-bad-attack-chunks</code>
* <code>show_tile_variations</code>
** Shows, which tile-variation (1, 2 or 4 tile sized) is painted for which area of the map quite confusing, zoom in to see the meaning.
* <code>show_raw_tile_transitions</code>
** Turns connected textures for land and water off, so the distinction can easily be made.
* <code>show-tile-correction-previews</code>
** When in the map editor it shows what tiles will be corrected to what variations when painting tiles.
* <code>show_fluid_box_fluid_info</code>
** How much fluid is in a pipe/storage tank, shows flow of liquid in pipes.
* <code>show_environment_sound_info</code>
** Displays which sound of which entity is played and how loud.* <code>show-logistic-robot-targets</code>
* <code>show-fire-info</code>
* <code>show-sticker-info</code>
* <code>show-map-generator-info</code>

== See also ==

* [http://www.factorioforums.com/forum/viewtopic.php?f=49&t=7972 F5 debug info - how to read it?] - how to interpret show_time_used_percent

Types/Order

2017-07-06T09:15:06Z

Rseding91: Created page with "The order property is a simple string. When the game compares 2 like prototypes if the order strings aren't equal they're lexicographical compared (https://en.wikipedia.org/wi..."

The order property is a simple string. When the game compares 2 like prototypes if the order strings aren't equal they're lexicographical compared (https://en.wikipedia.org/wiki/Lexicographical_order) to determine if a given prototype comes before or after another. When the order strings are equal the game then falls back to comparing the prototype names to determine order.

Types/CollisionMask

2017-07-05T18:57:16Z

Rseding91:

The collision mask is specified by list of [[Types/string]], every input is specification of one layer the object collides with.

Layers are:
* ground-tile
* water-tile
* resource-layer
* doodad-layer
* floor-layer
* item-layer
* ghost-layer
* object-layer
* player-layer
* train-layer
* layer-11
* layer-12
* layer-13
* layer-14
* layer-15

Additional input is "not-colliding-with-itself". Layer-11 through layer-15 are currently unused by the core game.

Example (Most common collision mask of buildings):
collision_mask = { "item-layer", "object-layer", "player-layer", "water-tile"}

Tutorial:Modding FAQ

2017-03-20T10:18:32Z

Rseding91: Correct reset recipes/technologies usage

== '''Modding FAQ''' ==
{{sublinks|Main Page}}

Welcome to the modding FAQ. (work in progress)
Here we have a list of questions that are common to get while writing a mod.
And the fix for the problem (if someone managed to find a fix)
feel free to edit this page and add more Q and A's.

{| style="width: 99%;"
|style="width:34%;background: #F9F9F9; border: 1px solid #AAAAAA; vertical-align: top; -moz-border-radius: 5px; -webkit-border-radius: 5px; padding: 7px;"|
<div style="background: #E4F0F7; padding: 5px; margin: 3px; font-weight: bold; text-align: center; color: #033251; font-size: 120%;">
'''Questions / Fix'''</div><div style="padding-left: 1em;">
* Q : Why do I get the error "C:\Factorio\mod doesn't match the expected mod_version# (case sensitive!)" error?
* Fix :
The folder name of your mod must include the version
number. So if your mod is titled "myMod" version 0.0.1, in order
for Factorio to read it, the folder must be titled "myMod_0.0.1".

* Q : my item / entity wont load the sprite I made.
* Fix :
Make sure your path is right : __mod-name__/map-name/2nd-map-name/sprite.png
Pay attention to case, the following file is not the same as previous:__Mod-name__/Map-name/2nd-map-name/sprite.PNG

* Q : The name of my item is displayed as "Unknown key: item-name.yourname"
* Fix :
Make sure you have valid locale mappings. Create a "locale" directory with an "en" subdirectory and create a "item-name.cfg" file.
It should contains something like:
[item-name]
itemx=Item X
itemy=Item Y

Do the same for your entities, but put them in an "entity-name" section/file.
*Q : What does ('=' character not found in line) mean?
* Fix :
If you get the error message '=' character not found in line , chances are you
created a new document as something other than a .txt file, adding in format text
to the document that is causing this error. Copy the contents of your .cfg file
and make a new .txt file, rename it to .cfg, and paste your configuration into it.

* Q : Error while loading prototype "entity-name": No such node (pictures).
* Fix :
Make sure your entity contains the right amount of lines for that type of entity,
for example a chest needs 1 picture for the entity to work but a wall needs 20.
Look in the factorio base/prototypes/entity/entity.lua.
And you can see that different entities need different amounts of pictures.

* Q : I've modified the recipe and/or technology prototypes and when I load my save game the changes aren't there even though it works in a new game.
* Fix : You need to run <pre style="display:inline-block">for i, force in pairs(game.forces) do force.reset_recipes() end</pre> and/or <pre style="display:inline-block">for i, force in pairs(game.forces) do force.reset_technologies() end</pre>
To make Factorio reload the prototypes, this can be done using the console (~) or via the script.on_init event in control.lua (which will run when the mod is first added to a game), or through [[Migration_scripts|migration]] files (if you've made a mod release and need to 'migrate' user's saves to a new version automatically). The first is the easiest while testing, the second when you're releasing a mod for the first time, and the third for when you've already made a mod release. The prototypes are saved in the save file so as to (eventually) allow making changes to them during runtime (control.lua), which is why they need to be 'reset' for saves.

* If you have anymore questions or just want to come socialize, we have an official and un-official irc channel:
<pre style="display:inline-block">Official Factorio Channel
IRC Server: irc.esper.net
Channel Name: #factorio

Un-Offical Modding Channel
IRC Server: irc.esper.net
Channel Name: #factorio-modding</pre>

|}

Tutorial:Modding FAQ

2017-03-20T10:17:25Z

Rseding91: Removed ipairs and fixed "game.oninit" -> "script.on_init".

== '''Modding FAQ''' ==
{{sublinks|Main Page}}

Welcome to the modding FAQ. (work in progress)
Here we have a list of questions that are common to get while writing a mod.
And the fix for the problem (if someone managed to find a fix)
feel free to edit this page and add more Q and A's.

{| style="width: 99%;"
|style="width:34%;background: #F9F9F9; border: 1px solid #AAAAAA; vertical-align: top; -moz-border-radius: 5px; -webkit-border-radius: 5px; padding: 7px;"|
<div style="background: #E4F0F7; padding: 5px; margin: 3px; font-weight: bold; text-align: center; color: #033251; font-size: 120%;">
'''Questions / Fix'''</div><div style="padding-left: 1em;">
* Q : Why do I get the error "C:\Factorio\mod doesn't match the expected mod_version# (case sensitive!)" error?
* Fix :
The folder name of your mod must include the version
number. So if your mod is titled "myMod" version 0.0.1, in order
for Factorio to read it, the folder must be titled "myMod_0.0.1".

* Q : my item / entity wont load the sprite I made.
* Fix :
Make sure your path is right : __mod-name__/map-name/2nd-map-name/sprite.png
Pay attention to case, the following file is not the same as previous:__Mod-name__/Map-name/2nd-map-name/sprite.PNG

* Q : The name of my item is displayed as "Unknown key: item-name.yourname"
* Fix :
Make sure you have valid locale mappings. Create a "locale" directory with an "en" subdirectory and create a "item-name.cfg" file.
It should contains something like:
[item-name]
itemx=Item X
itemy=Item Y

Do the same for your entities, but put them in an "entity-name" section/file.
*Q : What does ('=' character not found in line) mean?
* Fix :
If you get the error message '=' character not found in line , chances are you
created a new document as something other than a .txt file, adding in format text
to the document that is causing this error. Copy the contents of your .cfg file
and make a new .txt file, rename it to .cfg, and paste your configuration into it.

* Q : Error while loading prototype "entity-name": No such node (pictures).
* Fix :
Make sure your entity contains the right amount of lines for that type of entity,
for example a chest needs 1 picture for the entity to work but a wall needs 20.
Look in the factorio base/prototypes/entity/entity.lua.
And you can see that different entities need different amounts of pictures.

* Q : I've modified the recipe and/or technology prototypes and when I load my save game the changes aren't there even though it works in a new game.
* Fix : You need to run <pre style="display:inline-block">for i, player in pairs(game.players) do player.force.reset_recipes() end</pre> and/or <pre style="display:inline-block">for i, player in pairs(game.players) do player.force.reset_technologies() end</pre>
To make Factorio reload the prototypes, this can be done using the console (~) or via the script.on_init event in control.lua (which will run when the mod is first added to a game), or through [[Migration_scripts|migration]] files (if you've made a mod release and need to 'migrate' user's saves to a new version automatically). The first is the easiest while testing, the second when you're releasing a mod for the first time, and the third for when you've already made a mod release. The prototypes are saved in the save file so as to (eventually) allow making changes to them during runtime (control.lua), which is why they need to be 'reset' for saves.

* If you have anymore questions or just want to come socialize, we have an official and un-official irc channel:
<pre style="display:inline-block">Official Factorio Channel
IRC Server: irc.esper.net
Channel Name: #factorio

Un-Offical Modding Channel
IRC Server: irc.esper.net
Channel Name: #factorio-modding</pre>

|}

Prototype/ItemWithLabel

2016-07-12T10:21:00Z

Rseding91:

==Basics==
Inherits from [[prototype/item]]. Like a normal item but with the ability to have a colored label.
type = "item-with-label"

== Optional properties ==

=== default_label_color ===
The default label color the item will use or if not provided it uses the game default item text color.
default_label_color = {r=1, g=1, b=0, a=1}

=== draw_label_for_cursor_render ===
If true, the item will draw its label when held in the cursor in place of the item count. Defaults to false if not defined.
draw_label_for_cursor_render = true

Prototype/ItemWithInventory

2016-07-12T10:16:22Z

Rseding91: /* Basics */

==Basics==
Inherits from [[prototype/ItemWithLabel]] and is used in the base game by the blueprint book item.
type = "item-with-inventory"
The inventory allows setting player defined filters similar to the quickbar and cargo wagon inventories.

== Mandatory properties ==
=== inventory_size ===
The inventory size of the item.
inventory_size = 20 -- 20 slots

== Optional properties ==
=== item_filters ===
A list of explicit item names to be used as filters.
item_filters = {"iron-ore", "copper-ore", "coal", "stone"}

=== item_group_filters ===
A list of explicit item group names to be used as filters.
item_group_filters = {"storage", "belt"}

=== item_subgroup_filters ===
A list of explicit item subgroup names to be used as filters.
item_subgroup_filters = {"capsule", "tool"}

=== filter_mode ===
This determines how filters are applied. If no filters are defined this is automatically set to "none".
filter_mode = "blacklist" -- or "whitelist" if you want whitelisting

=== filter_message_key ===
The locale key used when the player attempts to put an item that doesn't match the filter rules into the item-with-inventory.
filter_message_key = "....."
If not defined this defaults to "item-limitation.item-not-allowed-in-this-container-item".

=== extends_inventory_by_default ===
When true, this item-with-inventory will extend the inventory it sits in by default. This is a runtime property on the result item that can be changed through the Lua interface and only determines the initial value.
extends_inventory_by_default = false -- the default is false if not defined

=== insertion_priority_mode ===
The insertion priority mode for this item. This determines if items are first attempted to be put into this items inventory if the item extends the inventory it sits in when items are put into the parent inventory.
insertion_priority_mode = "never"

Possible values are:
{| class="wikitable"
|-
! Flag !! meaning
|-
| default || Items are inserted into this item-with-inventory only if they match the whitelist defined in the prototype for the item and whitelist is used.
|-
| never || Items are never inserted into this item-with-inventory except explicitly by the player or script
|-
| always || All items first try to be inserted into this item-with-inventory
|-
| when_manually_filtered || When the inventory contains filters that match the item-to-be-inserted then try to put it into this item before the inventory this item resides in
|}

Prototype/ItemWithInventory

2016-07-12T10:15:21Z

Rseding91: Created page with "==Basics== Inherits from prototype/ItemWithLabel and is used in the base game by the blueprint book item. type = "item-with-inventory" == Mandatory properties == === in..."

==Basics==
Inherits from [[prototype/ItemWithLabel]] and is used in the base game by the blueprint book item.
type = "item-with-inventory"

== Mandatory properties ==
=== inventory_size ===
The inventory size of the item.
inventory_size = 20 -- 20 slots

== Optional properties ==
=== item_filters ===
A list of explicit item names to be used as filters.
item_filters = {"iron-ore", "copper-ore", "coal", "stone"}

=== item_group_filters ===
A list of explicit item group names to be used as filters.
item_group_filters = {"storage", "belt"}

=== item_subgroup_filters ===
A list of explicit item subgroup names to be used as filters.
item_subgroup_filters = {"capsule", "tool"}

=== filter_mode ===
This determines how filters are applied. If no filters are defined this is automatically set to "none".
filter_mode = "blacklist" -- or "whitelist" if you want whitelisting

=== filter_message_key ===
The locale key used when the player attempts to put an item that doesn't match the filter rules into the item-with-inventory.
filter_message_key = "....."
If not defined this defaults to "item-limitation.item-not-allowed-in-this-container-item".

=== extends_inventory_by_default ===
When true, this item-with-inventory will extend the inventory it sits in by default. This is a runtime property on the result item that can be changed through the Lua interface and only determines the initial value.
extends_inventory_by_default = false -- the default is false if not defined

=== insertion_priority_mode ===
The insertion priority mode for this item. This determines if items are first attempted to be put into this items inventory if the item extends the inventory it sits in when items are put into the parent inventory.
insertion_priority_mode = "never"

Possible values are:
{| class="wikitable"
|-
! Flag !! meaning
|-
| default || Items are inserted into this item-with-inventory only if they match the whitelist defined in the prototype for the item and whitelist is used.
|-
| never || Items are never inserted into this item-with-inventory except explicitly by the player or script
|-
| always || All items first try to be inserted into this item-with-inventory
|-
| when_manually_filtered || When the inventory contains filters that match the item-to-be-inserted then try to put it into this item before the inventory this item resides in
|}

Prototype/SelectionTool

2016-07-12T10:04:40Z

Rseding91:

==Basics==
Inherits from [[prototype/ItemWithLabel]] and is used in the base game for the blueprint item and the deconstruction item.
type = "selection-tool"

== Mandatory properties ==
=== selection_color ===
The color of the rectangle used when standard selection is done in-game.
selection_color = {r=1, g=0, b=0, a=1} -- red

=== alt_selection_color ===
The color of the rectangle used when alt-selection is done in-game.
alt_selection_color = {r=0, g=1, b=0, a=1} -- green

=== selection_mode ===
A list of selection mode flags that define how the selection tool selects things in-game.
selection_mode = {"blueprint"}

Possible values are:
{| class="wikitable"
|-
! Flag !! meaning
|-
| blueprint || The normal rules for acceptable entities in blueprints
|-
| deconstruct || The normal rules for acceptable entities for deconstruction
|-
| cancel-deconstruct || The normal rules for acceptable entities for cancel deconstruction
|-
| items || Item entities
|-
| trees || Trees
|-
| buildable-type || Buildable entities as defined by the game
|-
| tiles || Any tiles
|-
| items-to-place || The entity has an item that builds the entity
|-
| any-entity || Any entity
|-
| any-tile || Any tile
|-
| matches-force || The entity force matches that of the player doing the selection
|}

=== alt_selection_mode ===
A list of selection mode flags that define how the selection tool alt-selects things in-game.
alt_selection_mode = {"cancel-deconstruct"}
Possible values are identical to normal selection_mode.

=== selection_cursor_box_type ===
The type of cursor box used to render selection of entities/tiles when standard selecting.
selection_cursor_box_type = "entity"
Possible values are:
{| class="wikitable"
|-
! Flag !! meaning
|-
| entity || The normal entity selection box. Yellow by default.
|-
| electricity || The selection box used to specify electric poles an entity is connected to. Light blue by default.
|-
| copy || The selection box used when doing entity copy-paste. Green by default.
|-
| not-allowed || The selection box used when specifying colliding entities. Red by default.
|-
| pair ||
|-
| logistics ||
|}

== Optional properties ==
=== always_include_tiles ===
If tiles should be included in the selection regardless of entities also being in the selection. By default this is false. This is a visual only setting.
always_include_tiles = false

Prototype/SelectionTool

2016-07-12T10:04:28Z

Rseding91:

==Basics==
Inherits from [[prototype/ItemWithLabel]] and is used in the base game for the blueprint item and the deconstruction item.
type = "item-with-label"

== Mandatory properties ==
=== selection_color ===
The color of the rectangle used when standard selection is done in-game.
selection_color = {r=1, g=0, b=0, a=1} -- red

=== alt_selection_color ===
The color of the rectangle used when alt-selection is done in-game.
alt_selection_color = {r=0, g=1, b=0, a=1} -- green

=== selection_mode ===
A list of selection mode flags that define how the selection tool selects things in-game.
selection_mode = {"blueprint"}

Possible values are:
{| class="wikitable"
|-
! Flag !! meaning
|-
| blueprint || The normal rules for acceptable entities in blueprints
|-
| deconstruct || The normal rules for acceptable entities for deconstruction
|-
| cancel-deconstruct || The normal rules for acceptable entities for cancel deconstruction
|-
| items || Item entities
|-
| trees || Trees
|-
| buildable-type || Buildable entities as defined by the game
|-
| tiles || Any tiles
|-
| items-to-place || The entity has an item that builds the entity
|-
| any-entity || Any entity
|-
| any-tile || Any tile
|-
| matches-force || The entity force matches that of the player doing the selection
|}

=== alt_selection_mode ===
A list of selection mode flags that define how the selection tool alt-selects things in-game.
alt_selection_mode = {"cancel-deconstruct"}
Possible values are identical to normal selection_mode.

=== selection_cursor_box_type ===
The type of cursor box used to render selection of entities/tiles when standard selecting.
selection_cursor_box_type = "entity"
Possible values are:
{| class="wikitable"
|-
! Flag !! meaning
|-
| entity || The normal entity selection box. Yellow by default.
|-
| electricity || The selection box used to specify electric poles an entity is connected to. Light blue by default.
|-
| copy || The selection box used when doing entity copy-paste. Green by default.
|-
| not-allowed || The selection box used when specifying colliding entities. Red by default.
|-
| pair ||
|-
| logistics ||
|}

== Optional properties ==
=== always_include_tiles ===
If tiles should be included in the selection regardless of entities also being in the selection. By default this is false. This is a visual only setting.
always_include_tiles = false

Prototype/ItemWithLabel

2016-07-12T10:04:14Z

Rseding91: /* Basics */

==Basics==
Inherits from [[prototype/item]]. Like a normal item but with the ability to have a colored label.
type = "item-with-inventory"

== Optional properties ==

=== default_label_color ===
The default label color the item will use or if not provided it uses the game default item text color.
default_label_color = {r=1, g=1, b=0, a=1}

=== draw_label_for_cursor_render ===
If true, the item will draw its label when held in the cursor in place of the item count. Defaults to false if not defined.
draw_label_for_cursor_render = true

Prototype/ItemWithLabel

2016-07-12T10:02:19Z

Rseding91: /* Basics */

==Basics==
Like a normal item but with the ability to have a colored label. Inherits from [[prototype/item]].

== Optional properties ==

=== default_label_color ===
The default label color the item will use or if not provided it uses the game default item text color.
default_label_color = {r=1, g=1, b=0, a=1}

=== draw_label_for_cursor_render ===
If true, the item will draw its label when held in the cursor in place of the item count. Defaults to false if not defined.
draw_label_for_cursor_render = true

Prototype/SelectionTool

2016-07-12T10:02:01Z

Rseding91: Created page with "==Basics== Inherits from prototype/ItemWithLabel and is used in the base game for the blueprint item and the deconstruction item. == Mandatory properties == === selection..."

==Basics==
Inherits from [[prototype/ItemWithLabel]] and is used in the base game for the blueprint item and the deconstruction item.

== Mandatory properties ==
=== selection_color ===
The color of the rectangle used when standard selection is done in-game.
selection_color = {r=1, g=0, b=0, a=1} -- red

=== alt_selection_color ===
The color of the rectangle used when alt-selection is done in-game.
alt_selection_color = {r=0, g=1, b=0, a=1} -- green

=== selection_mode ===
A list of selection mode flags that define how the selection tool selects things in-game.
selection_mode = {"blueprint"}

Possible values are:
{| class="wikitable"
|-
! Flag !! meaning
|-
| blueprint || The normal rules for acceptable entities in blueprints
|-
| deconstruct || The normal rules for acceptable entities for deconstruction
|-
| cancel-deconstruct || The normal rules for acceptable entities for cancel deconstruction
|-
| items || Item entities
|-
| trees || Trees
|-
| buildable-type || Buildable entities as defined by the game
|-
| tiles || Any tiles
|-
| items-to-place || The entity has an item that builds the entity
|-
| any-entity || Any entity
|-
| any-tile || Any tile
|-
| matches-force || The entity force matches that of the player doing the selection
|}

=== alt_selection_mode ===
A list of selection mode flags that define how the selection tool alt-selects things in-game.
alt_selection_mode = {"cancel-deconstruct"}
Possible values are identical to normal selection_mode.

=== selection_cursor_box_type ===
The type of cursor box used to render selection of entities/tiles when standard selecting.
selection_cursor_box_type = "entity"
Possible values are:
{| class="wikitable"
|-
! Flag !! meaning
|-
| entity || The normal entity selection box. Yellow by default.
|-
| electricity || The selection box used to specify electric poles an entity is connected to. Light blue by default.
|-
| copy || The selection box used when doing entity copy-paste. Green by default.
|-
| not-allowed || The selection box used when specifying colliding entities. Red by default.
|-
| pair ||
|-
| logistics ||
|}

== Optional properties ==
=== always_include_tiles ===
If tiles should be included in the selection regardless of entities also being in the selection. By default this is false. This is a visual only setting.
always_include_tiles = false

Prototype/ItemWithLabel

2016-07-12T09:48:17Z

Rseding91:

==Basics==
Like a normal item but with the ability to have a colored label.

== Optional properties ==

=== default_label_color ===
The default label color the item will use or if not provided it uses the game default item text color.
default_label_color = {r=1, g=1, b=0, a=1}

=== draw_label_for_cursor_render ===
If true, the item will draw its label when held in the cursor in place of the item count. Defaults to false if not defined.
draw_label_for_cursor_render = true

Prototype/ItemWithLabel

2016-07-12T09:47:17Z

Rseding91: Created page with "== Optional properties == === default_label_color === The default label color the item will use or if not provided it uses the game default item text color. default_label_c..."

== Optional properties ==

=== default_label_color ===
The default label color the item will use or if not provided it uses the game default item text color.
default_label_color = {r=1, g=1, b=0, a=1}

=== draw_label_for_cursor_render ===
If true, the item will draw its label when held in the cursor in place of the item count. Defaults to false if not defined.
draw_label_for_cursor_render = true

Prototype/Item

2016-07-12T09:43:34Z

Rseding91: /* Extensions */

==Basics==
Possible configuration for all items
== Extensions ==
{| class="wikitable"
|-
! Item !! json identification type !! Description
|-
| [[prototype/item]] || item || Regular item with no special properties.
|-
| [[prototype/Ammo]] || ammo || Ammunition for guns
|-
| [[prototype/Gun]] || gun || Guns
|-
| [[prototype/Armor]] || armor || Used as player protection.
|-
| [[prototype/MiningTool]] || mining-tool || Used for mining resources and/or melee weapon.
|-
| [[prototype/ItemWithLabel]] || item-with-label || Similar to a standard item but with the ability to be labeled.
|-
| [[prototype/ItemWithInventory]] || item-with-inventory || An item type that itself has an inventory of other items.
|-
| [[prototype/SelectionTool]] || selection-tool || An item type used for selecting entities in the world. The base game blueprint and deconstruction item use this type.
|}

== Mandatory properties ==
=== type ===
Type of the item (extension)
type = "item"
=== name ===
Name of the item prototype (iron-gear-wheel/wooden-chest)
name = "wooden-chest"
=== stack_size ===
Count of items of the same name that can be stored in one inventory slot.
stack_size = 64

=== order ===
Is used to order items in inventory (when sorting is enabled) and to sort recipes in crafting screen.
order = "a-b-c"
=== flags ===
Specifies some properties of the item.
flags = { "goes-to-quickbar" }
Possible values are:
{| class="wikitable"
|-
! Item !! meaning
|-
| goes-to-quickbar || Item is moved to quick bar by default
|-
| goes-to-main-inventory || Item is moved to main inventory by default
|-
| hidden || Item will not appear in lists of all items such as those for logistics requests, filters, etc.
|}

== Optional properties ==
=== place_result ===
Name of [prototype/Entity] that can be built using this item
place_result = "wooden-chest"
=== fuel_value ===
Amount of energy it gives when used as fuel, reference value is 1 for coal.
Default value is 0 (it can't be used as fuel).
fuel_value = 0.8
=== healing_value ===
Amount of health restored when used.
Default value is 0 (So it can't be used this way)
healing_value = 20

Tutorial:Script interfaces

2015-09-07T09:51:49Z

Rseding91:

Script interfaces allow direct communication between simultaneously running scripts. This is done in form of defining a public interface with given functions. All the code regarding the interfaces communication is in the <code>remote</code> namespace.

=== Defining interfaces ===

The interface is defined as follows:

-- assuming name and table_of_functions are defined elsewhere
remote.addinterface(interface_name, table_of_functions)

-- It is possible to define the name and table inside the call
remote.addinterface("myinterface", {
mygetter = function()
-- you can return 1 or more variables from the script
return "foo"
end,

-- the values can be only primitive type or (nested) tables
mysetter = function(foo, bar)
glob.foo = foo
glob.bar = bar
end
})

The interface functions cannot take function pointers or function closures. Primitive types, LuaObjects and tables work just fine.

The interfaces are not serialised. Therefore it is a good idea to put them into the global scope of the script. In that way they are run everytime the script file is loaded (no matter whether it is the first run or game being loaded).

At the moment the interface is identified solely by its name. There is no vesion mechanism yet. It is a good idea to prefix the name of the interface with the name of the mod / map where it is defined.

=== Calling interface functions ===

The interface can be used for calling functions from a different script.

Example (in the different script than the one above):

-- calls the myinterface.mygetter from the script above and prints the returning value
print(remote.call("myinterface", "mygetter"))

This remote.call can be used in the global scope as well. However then the script in which it is called has to be invoked after the script which defined the interface. The ordering of the scripts is: first the map script and then the mod scripts in order defined by the mod ordering.

-- set values in the other script
-- remote call takes the name of the interface, name of the function and then variable amount of parameters
remote.call("myinterface', "mysetter", 5, {bar=baz})

=== Discovering interfaces ===

The script can check for expected interfaces and its functions via the <code>remote.interfaces</code> table. This is a table indexed by interface names where the values are set of functions for particular interfaces.

Example:

-- check whether there is the "myinterface" interface and whether it contains the "mygetter" function
if remote.interfaces.myinterface and remote.interfaces.myinterface.mygetter then
-- the remote call for the function is safe to use
end

Types/Direction

2015-08-10T22:00:37Z

Rseding91:

Direction is a [[Types/uint]] who's value can be any of the following:

*'''North''' - 0
*'''Northeast''' - 1
*'''East''' - 2
*'''Southeast''' - 3
*'''South''' - 4
*'''Southwest''' - 5
*'''West''' - 6
*'''Northwest''' - 7

Types/Direction

2015-08-10T22:00:18Z

Rseding91:

Direction is a [[Types/uint]] who's value can be any of the following:

*'''North''' - 0
*'''northeast''' - 1
*'''east''' - 2
*'''southeast''' - 3
*'''south''' - 4
*'''southwest''' - 5
*'''west''' - 6
*'''northwest''' - 7

Types/Direction

2015-08-10T22:00:08Z

Rseding91: Created page with "Direction is a Types/uint who's value can be any of the following: *'''North''' - 0 *'''northeast''' - 1 *'''east''' - 2 *'''southeast''' - 3 *'''south''' - 4 *'''southwe..."

Mods

2015-05-05T17:07:04Z

Rseding91:

{{Languages}}
'''As of 5/5/2015 this page is *extremely* outdated: A more or less complete list of mods is in the [http://www.factorioforums.com/forum/viewforum.php?f=14 Mods forum].'''

== How to use mods ==

''' See [[Installing Mods]]

== List of user made mods ==

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|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.
|-
| {{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|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|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.
|}

{| 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|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.
|-
| {{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|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.
|}

{| 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|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|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|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|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.
|-
| {{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|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|Slipstream Chests}} ([http://www.factorioforums.com/forum/viewtopic.php?f=14&t=7121 Forum])
| Degraine || 1.1.0 || 0.11.17 || None
| Adds chests that can pick up and put down items on belts.
|-
| {{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.
|}

{| 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|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.
|-
| {{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.
|}

== 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}}/}}

Game-day

2015-03-01T21:56:05Z

Rseding91:

{{Languages}}
A [[Game-day|day]] lasts 25000 [[Game-tick]]s or 416.66~ [[Game-second]]s.

The light varies throughout the day varies in a cycle consisting of 4 phases:
{| class="wikitable"
! Phase !! Behaviour !! Time of day at start !! Time of day at end !! Duration (in ticks) || Duration (in seconds)
|-
|day ||fully light ||0.75 ||0.25 ||12500 ||208.33~
|-
|dusk ||darkening ||0.25 ||0.42 ||5000 ||83.33~
|-
|night ||fully dark ||0.42 ||0.58 ||2500 ||41.66~
|-
|dawn ||lightening ||0.58 ||0.75 ||5000 ||83.33~
|}

------------- day -------><---- dusk ----><---- night ----><---- dawn ----><-------- day ------------

% 0 5 10 15 20 25 30 35 40 45 50 55 60 65 70 75 80 85 90 95 100
|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|

During dusk, the light level decreases linearly from fully light to fully dark. During dawn, it increases linearly from dark to light.

Note: The actual time between phases can vary +/- a tick due to rounding errors.

These values are accurate as of version 0.11.8.

== See also ==

* [[Time]]
* [[Lua/Game#tick]].
* [[Game-tick]]
* [[Game-second]]
* [[Units]]

Game-day

2015-03-01T21:17:46Z

Rseding91: Updated tick times using the source code as reference.

{{Languages}}
A [[Game-day|day]] lasts 24966 [[Game-tick]]s or 416.1 [[Game-second]]s.

The light varies throughout the day varies in a cycle consisting of 4 phases:
{| class="wikitable"
! Phase !! Behaviour !! Time of day at start !! Time of day at end !! Duration (in ticks) || Duration (in seconds)
|-
|day ||fully light ||0.75 ||0.25 ||12500 ||208.33~
|-
|dusk ||darkening ||0.25 ||0.42 ||5000 ||83.33~
|-
|night ||fully dark ||0.42 ||0.58 ||2500 ||41.66~
|-
|dawn ||lightening ||0.58 ||0.75 ||5000 ||83.33~
|}

------------- day -------><---- dusk ----><---- night ----><---- dawn ----><-------- day ------------

% 0 5 10 15 20 25 30 35 40 45 50 55 60 65 70 75 80 85 90 95 100
|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|

During dusk, the light level decreases linearly from fully light to fully dark. During dawn, it increases linearly from dark to light.

Note: The actual time between phases can vary +/- a tick due to rounding errors.

These values are accurate as of version 0.11.8.

== See also ==

* [[Time]]
* [[Lua/Game#tick]].
* [[Game-tick]]
* [[Game-second]]
* [[Units]]

Prototype/Character

2015-02-05T15:51:41Z

Rseding91: /* Added build/reach distance and ticks to keep gun prototype example */

==Basics==
Entity that you move around on the screen during the campaign and freeplay. Extends the Prototype/EntityWithHealth
== Properties ==
=== crafting_categories ===
'''Type''': [[Types/CraftingCategory]]

=== idle_animation ===
'''Type''': [[Types/RotatedAnimation]]

=== idle_with_gun_animation ===
'''Type''': [[Types/RotatedAnimation]]

=== running_animation ===
'''Type''': [[Types/RotatedAnimation]]

=== running_sound_animation_positions (Since 0.8) ===
'''Type''': List of [[Types/float]]

List of positions in the running animation when the walking sound is played.
running_sound_animation_positions = {14, 29}
=== running_mask_animation ===
'''Type''': [[Types/RotatedAnimation]]

Currently not used.

=== mining_with_hands_animation ===
'''Type''': [[Types/RotatedAnimation]]

=== mining_with_hands_particles_animation_positions ===
'''Type''': List of [[Types/float]]

List of positions in the mining with hand animation when the mining sound and mining particles are created.
mining_with_hands_particles_animation_positions = {29, 63}

=== mining_with_tool_animation ===
'''Type''': [[Types/RotatedAnimation]]

=== mining_with_tool_particles_animation_positions ===
'''Type''': List of [[Types/float]]

List of positions in the mining with tool animation when the mining sound and mining particles are created.

=== running_aim ===
'''Type''': [[Types/RotatedAnimation]]

=== mining_speed ===
'''Type''': [[Types/double]]

=== running_speed ===
'''Type''': [[Types/double]]

=== distance_per_frame ===
'''Type''': [[Types/double]]

=== maximum_corner_sliding_distance ===
'''Type''': [[Types/double]]

=== heartbeat ===
'''Type''': [[Types/FileName]]

The sound file played when the character's health is low

=== eat ===
'''Type''': [[Types/FileName]]

The sound file played when the character eats (fish for example)

=== light ===
'''Type''': [[Types/LightDefinition]]

=== inventory_size ===
'''Type''': [[Types/InventorySize]]

The size of the character's inventory

=== build_distance ===
'''Type''': [[Types/uint]]

Added in 0.11.17

=== drop_item_distance ===
'''Type''': [[Types/uint]]

Added in 0.11.17

=== reach_distance ===
'''Type''': [[Types/uint]]

Added in 0.11.17

=== reach_resource_distance ===
'''Type''': [[Types/double]]

Added in 0.11.17

=== ticks_to_keep_gun ===
'''Type''': [[Types/uint]]

Added in 0.11.17

=== ticks_to_keep_aiming_direction ===
'''Type''': [[Types/uint]]

Added in 0.11.17

== Example ==
{
type = "player",
name = "player",
icon = "__base__/graphics/icons/player.png",
flags = {"pushable", "placeable-player", "placeable-off-grid", "breaths-air"},
max_health = 100,
healing_per_tick = 0.01,
collision_box = {{-0.2, -0.2}, {0.2, 0.2}},
selection_box = {{-0.2, -0.2}, {0.2, 0.2}},
crafting_categories = {"crafting"},
inventory_size = 60,
build_distance = 6,
drop_item_distance = 6,
reach_distance = 6,
reach_resource_distance = 2.7,
ticks_to_keep_gun = 600,
ticks_to_keep_aiming_direction = 100,
running_speed = 0.15,
distance_per_frame = 0.13,
maximum_corner_sliding_distance = 0.7,
eat =
{
{
filename = "__base__/sound/eat.wav",
volume = 1
}
},
heartbeat =
{
{
filename = "__base__/sound/heartbeat.ogg",
volume = 1.5
}
},
idle_animation =
{
priority = "medium",
frame_width = 48,
frame_height = 66,
direction_count = 5,
frame_count = 120,
stripes =
{
{
filename = "__base__/graphics/entity/player/character-idle-1.png",
width_in_frames = 40
},
{
filename = "__base__/graphics/entity/player/character-idle-2.png",
width_in_frames = 40
},
{
filename = "__base__/graphics/entity/player/character-idle-3.png",
width_in_frames = 40
}
},
shift = {0, -0.6}
},
idle_with_gun_animation =
{
priority = "medium",
frame_width = 48,
frame_height = 66,
direction_count = 5,
frame_count = 120,
stripes =
{
{
filename = "__base__/graphics/entity/player/character-idle-with-gun-1.png",
width_in_frames = 40
},
{
filename = "__base__/graphics/entity/player/character-idle-with-gun-2.png",
width_in_frames = 40
},
{
filename = "__base__/graphics/entity/player/character-idle-with-gun-3.png",
width_in_frames = 40
}
},
shift = {0, -0.6}
},
light = {intensity = 0.4, size = 25},
mining_speed = 0.01,
mining_with_hands_animation =
{
priority = "medium",
frame_width = 48,
frame_height = 66,
direction_count = 5,
frame_count = 80,
stripes =
{
{
filename = "__base__/graphics/entity/player/character-mine-with-hands-1.png",
width_in_frames = 40
},
{
filename = "__base__/graphics/entity/player/character-mine-with-hands-2.png",
width_in_frames = 40
}
},
shift = {0, -0.6}
},
mining_with_hands_particles_animation_positions = {29, 63},
mining_with_tool_animation =
{
priority = "medium",
frame_width = 64,
frame_height = 88,
direction_count = 5,
frame_count = 48,
stripes =
{
{
filename = "__base__/graphics/entity/player/character-mine-with-tool-1.png",
width_in_frames = 24
},
{
filename = "__base__/graphics/entity/player/character-mine-with-tool-2.png",
width_in_frames = 24
}
},
shift = {0, -0.6}
},
mining_with_tool_particles_animation_positions = {28},
running_aim =
{
filename = "__base__/graphics/entity/player/character-clothes-run-aim.png",
priority = "medium",
frame_width = 58,
frame_height = 72,
frame_count = 30,
direction_count = 18,
shift = {0, -0.6}
},
running_animation =
{
filename = "__base__/graphics/entity/player/character-clothes-run.png",
priority = "medium",
frame_width = 48,
frame_height = 66,
frame_count = 30,
direction_count = 5,
shift = {0, -0.6}
},
running_mask_animation =
{
filename = "__base__/graphics/entity/player/character-clothes-run-mask.png",
priority = "medium",
frame_width = 48,
frame_height = 66,
frame_count = 30,
direction_count = 5,
shift = {0, -0.6}
},
running_sound_animation_positions = {14, 29}
},

Prototype/Character

2015-02-05T15:47:39Z

Rseding91: Added information about reach distance and ticks to keep gun.

==Basics==
Entity that you move around on the screen during the campaign and freeplay. Extends the Prototype/EntityWithHealth
== Properties ==
=== crafting_categories ===
'''Type''': [[Types/CraftingCategory]]

=== idle_animation ===
'''Type''': [[Types/RotatedAnimation]]

=== idle_with_gun_animation ===
'''Type''': [[Types/RotatedAnimation]]

=== running_animation ===
'''Type''': [[Types/RotatedAnimation]]

=== running_sound_animation_positions (Since 0.8) ===
'''Type''': List of [[Types/float]]

List of positions in the running animation when the walking sound is played.
running_sound_animation_positions = {14, 29}
=== running_mask_animation ===
'''Type''': [[Types/RotatedAnimation]]

Currently not used.

=== mining_with_hands_animation ===
'''Type''': [[Types/RotatedAnimation]]

=== mining_with_hands_particles_animation_positions ===
'''Type''': List of [[Types/float]]

List of positions in the mining with hand animation when the mining sound and mining particles are created.
mining_with_hands_particles_animation_positions = {29, 63}

=== mining_with_tool_animation ===
'''Type''': [[Types/RotatedAnimation]]

=== mining_with_tool_particles_animation_positions ===
'''Type''': List of [[Types/float]]

List of positions in the mining with tool animation when the mining sound and mining particles are created.

=== running_aim ===
'''Type''': [[Types/RotatedAnimation]]

=== mining_speed ===
'''Type''': [[Types/double]]

=== running_speed ===
'''Type''': [[Types/double]]

=== distance_per_frame ===
'''Type''': [[Types/double]]

=== maximum_corner_sliding_distance ===
'''Type''': [[Types/double]]

=== heartbeat ===
'''Type''': [[Types/FileName]]

The sound file played when the character's health is low

=== eat ===
'''Type''': [[Types/FileName]]

The sound file played when the character eats (fish for example)

=== light ===
'''Type''': [[Types/LightDefinition]]

=== inventory_size ===
'''Type''': [[Types/InventorySize]]

The size of the character's inventory

=== build_distance ===
'''Type''': [[Types/uint]]

Added in 0.11.17

=== drop_item_distance ===
'''Type''': [[Types/uint]]

Added in 0.11.17

=== reach_distance ===
'''Type''': [[Types/uint]]

Added in 0.11.17

=== reach_resource_distance ===
'''Type''': [[Types/double]]

Added in 0.11.17

=== ticks_to_keep_gun ===
'''Type''': [[Types/uint]]

Added in 0.11.17

=== ticks_to_keep_aiming_direction ===
'''Type''': [[Types/uint]]

Added in 0.11.17

== Example ==
{
type = "player",
name = "player",
icon = "__base__/graphics/icons/player.png",
flags = {"pushable", "placeable-player", "placeable-off-grid", "breaths-air"},
max_health = 100,
healing_per_tick = 0.01,
collision_box = {{-0.2, -0.2}, {0.2, 0.2}},
selection_box = {{-0.2, -0.2}, {0.2, 0.2}},
crafting_categories = {"crafting"},
inventory_size = 60,
running_speed = 0.15,
distance_per_frame = 0.13,
maximum_corner_sliding_distance = 0.7,
eat =
{
{
filename = "__base__/sound/eat.wav",
volume = 1
}
},
heartbeat =
{
{
filename = "__base__/sound/heartbeat.ogg",
volume = 1.5
}
},
idle_animation =
{
priority = "medium",
frame_width = 48,
frame_height = 66,
direction_count = 5,
frame_count = 120,
stripes =
{
{
filename = "__base__/graphics/entity/player/character-idle-1.png",
width_in_frames = 40
},
{
filename = "__base__/graphics/entity/player/character-idle-2.png",
width_in_frames = 40
},
{
filename = "__base__/graphics/entity/player/character-idle-3.png",
width_in_frames = 40
}
},
shift = {0, -0.6}
},
idle_with_gun_animation =
{
priority = "medium",
frame_width = 48,
frame_height = 66,
direction_count = 5,
frame_count = 120,
stripes =
{
{
filename = "__base__/graphics/entity/player/character-idle-with-gun-1.png",
width_in_frames = 40
},
{
filename = "__base__/graphics/entity/player/character-idle-with-gun-2.png",
width_in_frames = 40
},
{
filename = "__base__/graphics/entity/player/character-idle-with-gun-3.png",
width_in_frames = 40
}
},
shift = {0, -0.6}
},
light = {intensity = 0.4, size = 25},
mining_speed = 0.01,
mining_with_hands_animation =
{
priority = "medium",
frame_width = 48,
frame_height = 66,
direction_count = 5,
frame_count = 80,
stripes =
{
{
filename = "__base__/graphics/entity/player/character-mine-with-hands-1.png",
width_in_frames = 40
},
{
filename = "__base__/graphics/entity/player/character-mine-with-hands-2.png",
width_in_frames = 40
}
},
shift = {0, -0.6}
},
mining_with_hands_particles_animation_positions = {29, 63},
mining_with_tool_animation =
{
priority = "medium",
frame_width = 64,
frame_height = 88,
direction_count = 5,
frame_count = 48,
stripes =
{
{
filename = "__base__/graphics/entity/player/character-mine-with-tool-1.png",
width_in_frames = 24
},
{
filename = "__base__/graphics/entity/player/character-mine-with-tool-2.png",
width_in_frames = 24
}
},
shift = {0, -0.6}
},
mining_with_tool_particles_animation_positions = {28},
running_aim =
{
filename = "__base__/graphics/entity/player/character-clothes-run-aim.png",
priority = "medium",
frame_width = 58,
frame_height = 72,
frame_count = 30,
direction_count = 18,
shift = {0, -0.6}
},
running_animation =
{
filename = "__base__/graphics/entity/player/character-clothes-run.png",
priority = "medium",
frame_width = 48,
frame_height = 66,
frame_count = 30,
direction_count = 5,
shift = {0, -0.6}
},
running_mask_animation =
{
filename = "__base__/graphics/entity/player/character-clothes-run-mask.png",
priority = "medium",
frame_width = 48,
frame_height = 66,
frame_count = 30,
direction_count = 5,
shift = {0, -0.6}
},
running_sound_animation_positions = {14, 29}
},