Official Factorio Wiki - User contributions [en]

Command line parameters

2025-06-21T19:11:19Z

SpeckledFleebeedoo: Add more detail to --sync-mods

{{Languages}}__TOC__

Command line parameters can be used to set settings in the command line before the game launches, this is useful mainly for advanced users or server hosts.

{| class="wikitable"
|+General options
|-
| -h, --help
|
| display help
|-
| --version
|
| show version information
|-
| -v, --verbose
|
| enable verbose logging
|-
| -c, --config
| PATH
| config file to use
|-
| --no-log-rotation
|
| don't rotate log file
|-
| --mod-directory
| PATH
| Mod directory to use
|-
| --check-unused-prototype-data
|
| Print a warning for all prototype values that were not accessed. Note for mod authors: If an entry is unused and is a table that contains the key/value pair 'ignore' with the value 'true' then the entire entry is ignored.
|-
| --executable-path
| PATH
| Override autodetected __PATH__executable. Usually not needed except on very weird systems.
|}

{| class="wikitable"
|+ Running options
|-
| -s, --map2scenario
| arg
| map to scenario conversion
|-
| -m, --scenario2map
| arg
| scenario to map conversion
|-
| --apply-update
| arg
| immediately apply update package
|-
| --create
| FILE
| create a new map
|-
| --map-gen-settings
| FILE
| Map generation settings for use with <code>--create</code>, <code>--start-server-load-scenario</code> or <code>--generate-map-preview</code>. See data/map-gen-settings.example.json
|-
| --map-gen-seed
| SEED
| Map generation seed for use with --create, --start-server-load-scenario or --generate-map-preview. Will override seed specified in map gen settings
|-
| --map-gen-seed-max
| SEED
| Map generation seed for use with --generate-map-preview to generate multiple previews using every second seed in the interval from map-gen-seed to map-gen-seed-max.
|-
| --map-settings
| FILE
| Map settings for use with --create or --start-server-load-scenario. See data/base/prototypes/map-settings.lua
|-
| --preset
| arg
| Name of the map generation preset to be used.
|-
| --generate-map-preview
| PATH
| Generate preview images of the map; PATH should name a PNG file or end with a '/' or '\' to indicate a directory.
|-
| --generate-map-preview-random
| COUNT
| Number of maps to generate with a random seed using --generate-map-preview.
|-
| --map-preview-size
| SIZE
| Size (in pixels) of map preview (default: 1024)
|-
| --map-preview-offset
| X,Y
| Offset of the center of the map, in meters (default: 0,0)
|-
| --map-preview-planet
| PLANET
| Planet to generate the preview for (default: nauvis)
|-
| --report-quantities
| PROTOTYPE,...
| When generating map preview, report approximate quantities of the named entity prototypes
|-
| --threads
| THREADCOUNT
| Number of threads to use when generating map previews
|-
| --disable-migration-window
|
| Disables the gui that is shown when opening a save with migrated content
|-
| --instrument-mod
| arg
| Name of a mod to enable [https://lua-api.factorio.com/latest/auxiliary/instrument.html Instrument Mode]
|-
| --sync-mods
| FILE
| Sync mods with save. Note for headless servers: requires <code>service-username</code> and <code>service-token</code> to be set in the player-data.json file if any mods need to be downloaded.
|-
| --enable-unsafe-lua-debug-api
|
| Enables unsafe functions in the Lua debug library.
|-
| --host
| FILE
| Start hosting a multiplayer game
|-
| --host-interactive
| FILE
| Open multiplayer server settings for hosting the selecting save
|-
| --start-server
| FILE
| start a multiplayer server
|-
| --start-server-load-scenario
| [MOD/]NAME
| start a multiplayer server and load the specified scenario. The scenario is looked for inside the given mod. If no mod is given, it is looked for in the top-level scenarios directory.
|-
| --start-server-load-latest
|
| start a multiplayer server and load the latest available save
|-
| --until-tick
| TICK
| run a save until given map tick
|-
| --benchmark
| FILE
| load save and run benchmark
|-
| --benchmark-ticks
| N
| number of ticks for benchmarking. Default is 1000
|-
| --benchmark-runs
| N
| how often the number of ticks will be run, map will reload after each run. Default is 1
|-
| --benchmark-verbose
| timings
| comma separated list of Update timings to output each tick. "all", "timestamp" as well as all other values seen in the debug show-time-usage view's Update section are allowed here. An empty string disabled verbose benchmarking. Timings are returned in nanoseconds.
|-
| --benchmark-sanitize
|
| only output the final benchmark results
|-
| --benchmark-ignore-paused
|
| leaves the game paused if it was paused when saved. By default the game is unpaused when a benchmark starts.
|-
| --output-perf-stats
| FILE
| path of file to which rendering performance statistics measurements should be saved. Special tags {api}, {hw}, {time} and {tag} will be replaced.
|-
| --dump-data
|
| dumps data.raw as JSON to the script output folder and exits.
|-
| --dump-icon-sprites
|
| dumps all icon sprites as png files to the script output folder and exits.
|-
| --dump-prototype-locale
|
| dumps all prototypes name and description (if they have a valid value) to the script output folder and exits.
|-
| --report-autogenerated-icon-mipmaps
|
| Report which icons will have generated mipmaps.
|-
| --log-shared-tile-layers
|
| After loading prototypes logs which tile layers are shared by multiple prototypes and lists the prototypes that share them.
|-
| --log-spritesheets-to-optimize
| N
| Logs N spritesheets that seem to have some nearly transparent noise, and could be made much smaller if the noise was cleaned up.
|-
| --mp-connect
| ADDRESS
| start factorio and connect to address
|-
| --password
| PASSWORD
| the password to use when using mp-connect (if any)
|-
| --heavy
|
| run the game in heavy mode if singleplayer with graphics. (heavy mode is related to investigating desyncs, see [[Desynchronization#Using_heavy_mode_command]])
|-
| --load-game
| FILE
| start Factorio and load a game in singleplayer
|-
| --load-scenario
| [MOD/]NAME
| start Factorio and load the specified scenario in singleplayer. The scenario is looked for inside the given mod. If no mod is given, it is looked for in the top-level scenarios directory.
|-
| --benchmark-graphics
| FILE
| load save and run it with graphics for benchmark-ticks number of ticks as normal game would
|-
| --benchmark-frame
| FILE
| load save and benchmark graphics rendering of single frame (prepare + render) without updating the game
|-
| --force-opengl
|
|use OpenGL for rendering (windows, mac only)
|-
| --force-d3d
|
|use Direct3D for rendering (windows only)
|-
| --d3d-adapter
| ID
|adapter which should be used to initialized Direct3D (windows only)
|-
| --d3d-feature-level
|
|override feature level (11, 10.1, 10) (windows only)
|-
| --dxgi-blit-model
|
|force Blit presentation mode (windows only)
|-
| --force-metal
|
|use Metal for rendering (mac only)
|-
| --debug-graphics
|
| enables debugging layer for graphics API. If DirectX is used DirectX SDK needs to be installed for this to work.
|-
| --fullscreen
| BOOL
| start game in windowed mode (saved to configuration)
|-
| --max-texture-size
| N
| maximal size of texture that the game can use (saved to configuration). Should be power of two greater than 2048
|-
| --graphics-quality
| arg
| accepted values: high, medium
|-
| --video-memory-usage
| arg
| accepted values: all, high, medium, low
|-
| --force-graphics-preset
| arg
| accepted values: very-low, low, mac-with-low-ram, medium-with-low-vram, medium, high, very-high, extreme
|-
| --gfx-safe-mode
|
| resets some graphics settings to values that should work on most configurations
|-
| --low-vram
|
| sprites that are not put into sprite atlases won't be allocated as texture objects
|-
| --shader
| arg
| enable/disable shader postprocessing (saved to configuration)
|-
| --disable-audio
|
| Disable audio. Mainly for faster startup during development.
|-
| --window-size
| arg
| Desired window resolution. For example "1680x1050". Or "maximized"
|-
| --single-thread-loading
|
| Disables loading of sprites in multiple threads.
|-
| --cache-sprite-atlas
| BOOL
| Enable/disable sprite atlas cache.
|-
| --nogamepad
|
| Disable gamepad(controller) support
|}

{| class="wikitable"
|+ Server options
|-
| --port
| N
| network port to use
|-
| --bind
| ADDRESS[:PORT]
| IP address (and optionally port) to bind to
|-
| --rcon-port
| N
| Port to use for RCON
|-
| --rcon-bind
| ADDRESS:PORT
| IP address and port to use for RCON
|-
| --rcon-password
| PASSWORD
| Password for RCON
|-
| --server-settings
| FILE
| Path to file with server settings. See data/server-settings.example.json
|-
| --use-server-whitelist
| BOOL
| If the whitelist should be used.
|-
| --use-authserver-bans
|
| Verify that connecting players are not banned from multiplayer and inform Factorio.com about ban/unban commands.
|-
| --server-whitelist
| FILE
| Path to file with server whitelist.
|-
| --server-banlist
| FILE
| Path to file with server banlist.
|-
| --server-adminlist
| FILE
| Path to file with server adminlist.
|-
| --console-log
| FILE
| Path to file where a copy of the server's log will be stored
|-
| --server-id
| FILE
| Path where server ID will be stored or read from
|}

=== Boolean options ===

Parameters shown above with a BOOL option must be formatted as <code>[parameter]=true</code> or <code>[parameter]=false</code>. For example,

--fullscreen=false

will start the game in windowed (not fullscreen) mode.

=== Multiplayer ===

--start-server SAVE

Will start a Headless (Dedicated) server, with no GUI.

--mp-connect ADDRESS
ADDRESS is the IP:port of the remote host. Port is optional.
Examples:

./factorio --mp-connect 192.168.1.101
./factorio --mp-connect 192.168.1.101:2345

As above, port can be specified by placing the port number after a colon in the address.

=== Creating a map from custom settings ===

Sometimes it's useful to create a new game with map and/or map generator settings stored in a JSON file rather than going through the in-game map settings screen.
One reason is that by editing the settings directly it is possible to set settings outside the range normally available from the GUI.

To do this, Factorio is run from the command-line, and a JSON file containing the map generator settings and a JSON file containing map settings (if customizing them) are needed.

Example for custom generator settings:
<pre>{
"terrain_segmentation": 0.5,
"water": "2",
"width": 0,
"height": 0,
"starting_area": "normal",
"peaceful_mode": false,
"autoplace_controls":
{
"coal": {"frequency": 1, "size": 2, "richness": 0.5},
"copper-ore": {"frequency": "low", "size": "normal", "richness": "high"},
"crude-oil": {"frequency": "normal", "size": "normal", "richness": "normal"},
"enemy-base": {"frequency": "normal", "size": "normal", "richness": "normal"},
"iron-ore": {"frequency": "normal", "size": "normal", "richness": "normal"},
"stone": {"frequency": "normal", "size": 0, "richness": "normal"},
"uranium-ore": {"frequency": "normal", "size": "none", "richness": "normal"}
},

"cliff_settings":
{
"name": "cliff",
"cliff_elevation_0": 30,
"cliff_elevation_interval": 20,
"richness": 1
},

"property_expression_names":
{
"elevation": "0_16-elevation",
"temperature": "35"
},

"seed": null
}
</pre>

Note that this is the same format as [https://lua-api.factorio.com/latest/concepts/MapGenSettings.html MapGenSettings] that are modifiable from Lua. Everything in the file is optional.

Creating a custom save:
<pre>
"C:\Program Files\Factorio\bin\x64\Factorio.exe" --create stuff-seed123.zip --map-gen-settings map-gen-settings.json --map-gen-seed 123
</pre>

Generating a map preview:
<pre>
"C:\Program Files\Factorio\bin\x64\Factorio.exe" --generate-map-preview preview-seed123.png --map-gen-settings map-gen-settings.json --map-gen-seed 123
</pre>

==== Creating the JSON files from a map exchange string ====

It can be useful to create the initial JSON files from a known map exchange string instead of creating them from scratch. To convert the map exchange string to JSON, open the game and run the following command with your map exchange string:

/c helpers.write_file('map.txt', helpers.table_to_json(helpers.parse_map_exchange_string("<your exchange string here>")))

Then open the script_output folder in the [[user data directory]] and open map.txt - it will look like this:

{"map_settings":{ ...<MAP_SETTINGS> ... },"map_gen_settings":{ ...<MAP_GEN_SETTINGS>... }}

Copy the { ...<MAP_SETTINGS> ... } section into a new file called 'map-settings.json' in the desired location. Copy the { ...<MAP_GEN_SETTINGS> ... } section section into a new file called 'map-gen-settings.json' in the desired location.

== See also ==
* [[Console]]

{{C|Modding}}

Units

2025-04-12T21:30:33Z

SpeckledFleebeedoo: /* Day */ Fix other time units

{{Languages}}
'''Units''' - by definition - are definite, representational quantities of measurement for different systems. Units can represent the measuring of electricity, amount of items, the time taken/required to perform a task or even the amount of stacks of items with differing amounts within said stacks.

Not all in-game units are simulated with full realism.

== Numerical abbreviations ==
Each unit in the game can be abbreviated with the following:
{| class="wikitable"
|-
! Abbreviation !! Value !! Numeral !! SI Prefix
|-
| k || 10^3 || thousand || kilo
|-
| M || 10^6 || million || Mega
|-
| G || 10^9 || billion || Giga
|-
| T || 10^12 || trillion || Tera
|-
| P || 10^16 || quadrillion || Peta
|-
| E || 10^18 || quintillion || Exa
|-
| Z || 10^21 || sextillion || Zetta
|-
| Y || 10^24 || septillion || Yotta
|-
| R || 10^27 || octillion || Ronna
|-
| Q || 10^30 || nonillion || Quetta
|-
|}

For example, instead of using 1000 J is equal to 1kJ.

== Power ==
Power is defined as work being done per unit of time.

=== Watt (W) ===
The basic unit of power is 1 watt (W), which is defined as '''1 W = 1 J/s ''', ie. one Joule of work being done every second.

The game commonly deals with larger units, namely kilowatts (kW) and megawatts (MW).

[[Lamp|Lamps]] use 5 kW while turned on. A [[Radar]] uses 300 kW while active - equivalent to 60 lamps.
One [[Steam engine]] is capable of outputting 900 kW.

== Work ==

Work is defined as a transfer of energy, or as energy being "spent".

=== Joule (J) ===
The basic unit of work is 1 joule (J), and is equivalent to the work done (total energy transferred) by one watt applied for one second: '''1 J = 1 W s'''.

In-game, [[Fuel]] is really just potential energy, which, when applied, does work. For example, every piece of [[coal]] burned will produce 4 MJ. One [[Accumulator]] is capable of storing 5 MJ.

In the real world, kilowatt hours is a much more common unit for energy, but it is ''not'' an [[:WIKIPEDIA:International_System_of_Units#Derived_units|SI derived unit]] so it is not used by the game.

== [[Time]] ==

=== Tick (1/60 s) ===
A 1/60 second in game. This is the shortest time fraction the game handles.

=== Second (s) ===
One second in-game. This is not guaranteed to correspond to one real second. For example, slow computers may not manage to calculate an entire tick during the corresponding real time frame of 1/60th of a second.

=== Day ===

A day is 25200 in-game ticks or 420 in-game seconds (= 7 in-game minutes) long.

== [[Map structure|Distance / Space]] ==

=== Tile ===
The tile is both used as a unit of distance/length and a unit of area. For example, the size of an object may be expressed as "2×2 tiles", which means the object covers an area of 4 square tiles or tiles². The unit of square tiles is often simplified into tiles. It can be assumed, that a tile has the length of 1 meter.

=== Chunk ===
A chunk is a quadratic area where one side is 32 tiles long. (1024 square tiles). A grid of tiles and chunks in can be viewed in the [[debug mode]] by pressing {{keybinding|F5}}.

=== Kilometers ===
A kilometer is 1000 meters, it is used to measure distance traveled in a [[space platform]].

== Force ==

=== Newtons (N) ===
Newtons measure the amount of forceful thrust of a space platform being moved by [[thruster]]s. This can be increased by adding more thrusters. More force can add damage to [[asteroids]] colliding with a platform, but the asteroids will, in turn, damage the platform as well.

== Mass / Weight ==

=== Tons (t) ===
A single ton is 1000 kilograms. The only time mass is measured in ''Factorio'' is calculating the sum of all parts that make up a space platform. The more components added and the bigger the platform's size, the more mass it will accumulate. The larger the mass of a platform, the harder it is for thrusters to move it to its destination.

== Logistics ==

=== Throughput ===

Items per time, or fluid-units per time. A unit measurement is

items / game-minute

==== Belts ====

Throughput = speed × density

For comparison: A [[transport belt]] transports normally about 900 items per in-game minute. A [[fast transport belt]] up to 1800 items/min and [[express transport belt]] nearly 2700 items / min.
See [[Transport belts/Physics|physics of transport belts]] for more information.

==== Logistic robots ====

Throughput depends on the distance, the number of robots and their item-stacksize. Let's assume a robot can travel 1 tile per second and can transport only one item at once. It needs also to return. Then this robot can transport ½ item per second. If you use 2 you can transport 1 item per second. If you double the distance, we are again at ½ item per second.

==== Trains ====

Items per train is the sum of all wagons' capacity (40 stacks for [[cargo wagon]], 50000 fluid for [[fluid wagon]] & 100 shells for [[artillery wagon]])

Top speed (later referred to as S) and acceleration (later referred to as A) depend on fuel type and train weight, for a coal-powered single locomotive without wagons they are 72 tiles/s and 9.26 tiles/s/s.

After some threshold the top speed starts decreasing linearly as train mass increases; acceleration is proportional to amount of locomotives pointing towards the travel direction and inversely proportional to train mass; deceleration is proportional to amount of wagons + amount of locomotives, inversely proportional to train mass, and affected by [[braking force (research)]] (train mass is the sum of all wagon and locomotive masses; see detailed info on wagon masses on [[locomotive]], [[cargo wagon]], [[fluid wagon]], and [[artillery wagon]] pages).

Warning: The following calculations assume deceleration = acceleration and do not account for red lights.

Travel time is <syntaxhighlight lang="lua">(2S / A) + (distance - 4 * S^2 / A) / S</syntaxhighlight> if the stations are far enough for the train to achieve full speed. If they are closer than that, the time is <syntaxhighlight lang="lua">2 * sqrt(distance / A)</syntaxhighlight>

Since a train has to make a trip back to load, the total throughput is <syntaxhighlight lang="lua">items per train / (2 * travel time)</syntaxhighlight>

=== Capacity ===
Basically items per transport unit. This depends in many cases on the item type you use. A [[cargo wagon]] has a capacity of 40 stacks. Stack size depends on the item type so this means that it can hold 2000 items for ore, or 4000 for steel or copper plates.

=== Density ===
Measured in items per tile.

An item, that lays on ground has the size of 0.28 tiles<sup>2</sup>. On one tile we can place 12.752041 items, which means, that we can put in the best case 12 items on one tile.

==== Belts ====

For belts this is the same: We have two lanes on a belt, 4 items per lane or 8 item on one belt.

On belts there comes also another thing into play: '''Compression.''' Good compression is, when you fill a belt so, that you come to the maximum density and so to the maximum '''throughput'''.
See also [[Transport belts/Physics|physics of transport belts]] for more information.

=== Stacks/chests ===
On the first glance, it is simple: A chest has the size of one tile. You have X number of stack in a chest, where you can put Y numbers of items into each, so the density is simply X × Y.

The thing changes, if you use mods, that add chest-like transport boxes, which enables to pack/box items.

{{C|Main}}

Units

2025-04-12T21:29:55Z

SpeckledFleebeedoo: /* Day */ Fix daytime length for 2.0

{{Languages}}
'''Units''' - by definition - are definite, representational quantities of measurement for different systems. Units can represent the measuring of electricity, amount of items, the time taken/required to perform a task or even the amount of stacks of items with differing amounts within said stacks.

Not all in-game units are simulated with full realism.

== Numerical abbreviations ==
Each unit in the game can be abbreviated with the following:
{| class="wikitable"
|-
! Abbreviation !! Value !! Numeral !! SI Prefix
|-
| k || 10^3 || thousand || kilo
|-
| M || 10^6 || million || Mega
|-
| G || 10^9 || billion || Giga
|-
| T || 10^12 || trillion || Tera
|-
| P || 10^16 || quadrillion || Peta
|-
| E || 10^18 || quintillion || Exa
|-
| Z || 10^21 || sextillion || Zetta
|-
| Y || 10^24 || septillion || Yotta
|-
| R || 10^27 || octillion || Ronna
|-
| Q || 10^30 || nonillion || Quetta
|-
|}

For example, instead of using 1000 J is equal to 1kJ.

== Power ==
Power is defined as work being done per unit of time.

=== Watt (W) ===
The basic unit of power is 1 watt (W), which is defined as '''1 W = 1 J/s ''', ie. one Joule of work being done every second.

The game commonly deals with larger units, namely kilowatts (kW) and megawatts (MW).

[[Lamp|Lamps]] use 5 kW while turned on. A [[Radar]] uses 300 kW while active - equivalent to 60 lamps.
One [[Steam engine]] is capable of outputting 900 kW.

== Work ==

Work is defined as a transfer of energy, or as energy being "spent".

=== Joule (J) ===
The basic unit of work is 1 joule (J), and is equivalent to the work done (total energy transferred) by one watt applied for one second: '''1 J = 1 W s'''.

In-game, [[Fuel]] is really just potential energy, which, when applied, does work. For example, every piece of [[coal]] burned will produce 4 MJ. One [[Accumulator]] is capable of storing 5 MJ.

In the real world, kilowatt hours is a much more common unit for energy, but it is ''not'' an [[:WIKIPEDIA:International_System_of_Units#Derived_units|SI derived unit]] so it is not used by the game.

== [[Time]] ==

=== Tick (1/60 s) ===
A 1/60 second in game. This is the shortest time fraction the game handles.

=== Second (s) ===
One second in-game. This is not guaranteed to correspond to one real second. For example, slow computers may not manage to calculate an entire tick during the corresponding real time frame of 1/60th of a second.

=== Day ===

A day is 25200 in-game ticks or 416.67 in-game seconds (= 6.94 in-game minutes) long.

== [[Map structure|Distance / Space]] ==

=== Tile ===
The tile is both used as a unit of distance/length and a unit of area. For example, the size of an object may be expressed as "2×2 tiles", which means the object covers an area of 4 square tiles or tiles². The unit of square tiles is often simplified into tiles. It can be assumed, that a tile has the length of 1 meter.

=== Chunk ===
A chunk is a quadratic area where one side is 32 tiles long. (1024 square tiles). A grid of tiles and chunks in can be viewed in the [[debug mode]] by pressing {{keybinding|F5}}.

=== Kilometers ===
A kilometer is 1000 meters, it is used to measure distance traveled in a [[space platform]].

== Force ==

=== Newtons (N) ===
Newtons measure the amount of forceful thrust of a space platform being moved by [[thruster]]s. This can be increased by adding more thrusters. More force can add damage to [[asteroids]] colliding with a platform, but the asteroids will, in turn, damage the platform as well.

== Mass / Weight ==

=== Tons (t) ===
A single ton is 1000 kilograms. The only time mass is measured in ''Factorio'' is calculating the sum of all parts that make up a space platform. The more components added and the bigger the platform's size, the more mass it will accumulate. The larger the mass of a platform, the harder it is for thrusters to move it to its destination.

== Logistics ==

=== Throughput ===

Items per time, or fluid-units per time. A unit measurement is

items / game-minute

==== Belts ====

Throughput = speed × density

For comparison: A [[transport belt]] transports normally about 900 items per in-game minute. A [[fast transport belt]] up to 1800 items/min and [[express transport belt]] nearly 2700 items / min.
See [[Transport belts/Physics|physics of transport belts]] for more information.

==== Logistic robots ====

Throughput depends on the distance, the number of robots and their item-stacksize. Let's assume a robot can travel 1 tile per second and can transport only one item at once. It needs also to return. Then this robot can transport ½ item per second. If you use 2 you can transport 1 item per second. If you double the distance, we are again at ½ item per second.

==== Trains ====

Items per train is the sum of all wagons' capacity (40 stacks for [[cargo wagon]], 50000 fluid for [[fluid wagon]] & 100 shells for [[artillery wagon]])

Top speed (later referred to as S) and acceleration (later referred to as A) depend on fuel type and train weight, for a coal-powered single locomotive without wagons they are 72 tiles/s and 9.26 tiles/s/s.

After some threshold the top speed starts decreasing linearly as train mass increases; acceleration is proportional to amount of locomotives pointing towards the travel direction and inversely proportional to train mass; deceleration is proportional to amount of wagons + amount of locomotives, inversely proportional to train mass, and affected by [[braking force (research)]] (train mass is the sum of all wagon and locomotive masses; see detailed info on wagon masses on [[locomotive]], [[cargo wagon]], [[fluid wagon]], and [[artillery wagon]] pages).

Warning: The following calculations assume deceleration = acceleration and do not account for red lights.

Travel time is <syntaxhighlight lang="lua">(2S / A) + (distance - 4 * S^2 / A) / S</syntaxhighlight> if the stations are far enough for the train to achieve full speed. If they are closer than that, the time is <syntaxhighlight lang="lua">2 * sqrt(distance / A)</syntaxhighlight>

Since a train has to make a trip back to load, the total throughput is <syntaxhighlight lang="lua">items per train / (2 * travel time)</syntaxhighlight>

=== Capacity ===
Basically items per transport unit. This depends in many cases on the item type you use. A [[cargo wagon]] has a capacity of 40 stacks. Stack size depends on the item type so this means that it can hold 2000 items for ore, or 4000 for steel or copper plates.

=== Density ===
Measured in items per tile.

An item, that lays on ground has the size of 0.28 tiles<sup>2</sup>. On one tile we can place 12.752041 items, which means, that we can put in the best case 12 items on one tile.

==== Belts ====

For belts this is the same: We have two lanes on a belt, 4 items per lane or 8 item on one belt.

On belts there comes also another thing into play: '''Compression.''' Good compression is, when you fill a belt so, that you come to the maximum density and so to the maximum '''throughput'''.
See also [[Transport belts/Physics|physics of transport belts]] for more information.

=== Stacks/chests ===
On the first glance, it is simple: A chest has the size of one tile. You have X number of stack in a chest, where you can put Y numbers of items into each, so the density is simply X × Y.

The thing changes, if you use mods, that add chest-like transport boxes, which enables to pack/box items.

{{C|Main}}

Jellynut seed

2025-02-16T00:17:04Z

SpeckledFleebeedoo: /* See also */ Add Space Age tags to links

{{Languages}}
{{:Infobox:Jellynut seed}}
{{Stub}}
{{About/Space age}}
'''Jellynut seed''' is an item used to plant [[jellystem]] trees, either manually or with a [[agricultural tower]]. These trees produce [[jellynut]] fruits when harvested. The seeds are then extracted from those fruits when processed.

== History ==
{{History|2.0.7|
* Introduced in [[Space Age]]{{SA}} expansion.
}}

== See also ==
* [[Gleba]]{{SA}}
* [[Yumako seed]]{{SA}}
* [[Tree seed]]{{SA}}

{{IntermediateNav}}

Yumako seed

2025-02-16T00:16:36Z

SpeckledFleebeedoo: /* See also */ Add Space Age tags to links

{{Languages}}
{{:Infobox:Yumako seed}}
{{Stub}}
{{About/Space age}}
'''Yumako seed''' is an item used to plant [[yumako tree]]s, either manually or with a [[agricultural tower]]. These trees produce [[yumako]] fruits when harvested. The seeds are then extracted from those fruits when processed.

On average, the yumako processing recipe produces exactly one seed from each mature yumako tree being harvested, making yumako processing by hand is a barely and unreliably self-sustaining process. However, the built-in productivity of a [[biochamber]] increases this statistic to one and a half seeds from each tree harvested, which is a net positive, thereby making yumako tree production a reliably self-sustaining process.

== History ==
{{History|2.0.7|
* Introduced in [[Space Age]]{{SA}} expansion.
}}

== See also ==
* [[Gleba]]{{SA}}
* [[Jellynut seed]]{{SA}}
* [[Tree seed]]{{SA}}

{{IntermediateNav}}

Infobox:Yumako seed

2025-02-16T00:15:06Z

SpeckledFleebeedoo: Flesh out infobox

{{Infobox
|space-age = yes
|prototype-type = item
|internal-name = yumako-seed
|stack-size = 10
|rocket-capacity = 100 (10 {{Translation|stacks}})
|fuel-value = 4.0 MJ burner
|recipe = Time, 1 + Yumako, 1 = Yumako seed, 0.02 + Yumako mash, 2
|producers = Biochamber + Assembling machine 2 + Assembling machine 3 + Player
|consumers = Artificial yumako soil + Overgrowth yumako soil + Agricultural tower
|used-as-fuel-by = Burner inserter + Burner mining drill + Boiler + Heating tower + Stone furnace + Steel furnace + Locomotive + Car + Tank
}}<noinclude>[[Category:Infobox page]]</noinclude>

Infobox:Jellynut seed

2025-02-16T00:12:15Z

SpeckledFleebeedoo: Flesh out infobox

{{Infobox
|space-age = yes
|prototype-type = item
|internal-name = jellynut-seed
|stack-size = 10
|rocket-capacity = 100 (10 {{Translation|stacks}})
|fuel-value = 4.0 MJ burner
|recipe = Time, 1 + Jellynut, 1 = Jellynut seed, 0.02 + Jelly, 4
|producers = Biochamber + Assembling machine 2 + Assembling machine 3 + Player
|consumers = Artificial jellynut soil + Overgrowth jellynut soil + Agricultural tower
|used-as-fuel-by = Burner inserter + Burner mining drill + Boiler + Heating tower + Stone furnace + Steel furnace + Locomotive + Car + Tank
}}<noinclude>[[Category:Infobox page]]</noinclude>

Jellynut seed

2025-02-15T23:58:54Z

SpeckledFleebeedoo: Add link to tree seed page

Yumako seed

2025-02-15T23:58:33Z

SpeckledFleebeedoo: Fix up link to tree seed page

Yumako seed

2025-02-15T23:58:09Z

SpeckledFleebeedoo: Add link to tree seed page

Mod portal API

2025-02-13T19:11:37Z

SpeckledFleebeedoo: Yet more optional fields

<div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Internal|Internal API]]</div>

The Mod Portal API is used to both browse and download all mods available on the [https://mods.factorio.com/ official Factorio mod portal]. Using the API does not require any kind of authentication or account information and can be viewed simply by following the URLs below in any web browser.

<code>https://mods.factorio.com/api/mods</code>

More detailed information about a particular mod can be obtained by retrieving the following URL, where {name} is the mod's name field in the result object.

<code>https://mods.factorio.com/api/mods/{name}</code>

To get even more information about a mod, you can use the following URL.

<code>https://mods.factorio.com/api/mods/{name}/full</code>

== Endpoints ==

=== /api/mods ===

GET Parameters (sent as query parameters):

{| class="wikitable"
! Key !! Values !! Description
|-
| hide_deprecated || {boolean} || Only return non-deprecated mods.
|-
| page ||{an integer}||Page number you would like to show. Makes it so you can see a certain part of the list without getting detail on all
|-
| page_size ||{an integer or 'max'}||The amount of results to show in your search
|-
| sort || {enum, one of name, created_at or updated_at} || Sort results by this property. Defaults to name when not defined. Ignored for <code>page_size=max</code> queries.
|-
| sort_order || {enum, one of asc or desc} || Sort results ascending or descending. Defaults to descending when not defined. Ignored for <code>page_size=max</code> queries.
|-
| namelist || {array of strings} || Return only mods that match the given names. Either comma-separated names or supply the namelist parameter more than once. Response will include <code>releases</code> instead of <code>latest_release</code>.
|-
| version || {enum, one of 0.13, 0.14, 0.15, 0.16, 0.17, 0.18, 1.0, 1.1 or 2.0} || Only return non-deprecated mods compatible with this Factorio version
|}

Returns [[#Mod List Response]]

=== /api/mods/{mod_name} ===

Return short information of a specific mod.

See [[#Result Entry]], "Short" column.

=== /api/mods/{mod_name}/full ===

Returns more information of a mod.

See [[#Result Entry]], "Full" column.

== JSON Object Types ==

=== Mod List Response ===

{| class="wikitable"
! Key !! Type !! Description
|-
| pagination || [[#Pagination|Pagination]] || See [[#Pagination]]
|-
| results || [[#Result Entry|Result]][] || A list of mods, matching any filters you specified.
|}

=== Pagination ===

{| class="wikitable"
! Key !! Type !! Description
|-
| count || Integer || Total number of mods that match your specified filters.
|-
| links || [[#Pagination_Links|Links]] || Utility links to mod portal api requests, preserving all filters and search queries.
|-
| page || Integer || The current page number.
|-
| page_count || Integer || The total number of pages returned.
|-
| page_size || Integer || The number of results per page.
|}

=== Pagination Links ===

{| class="wikitable"
! Key !! Type !! Description
|-
| first || String(URL) || URL to the first page of the results, or null if you're already on the first page.
|-
| prev || String(URL) || URL to the previous page of the results, or null if you're already on the first page.
|-
| next || String(URL) || URL to the next page of the results, or null if you're already on the last page.
|-
| last || String(URL) || URL to the last page of the results, or null if you're already on the last page.
|}

=== Result Entry ===

Fields returned by the api/mods endpoint are marked with a check (✓) in the "api/mods endpoint" column, those returned by the api/mods/{name} endpoint are marked with a check in the "Short" column and those returned by the api/mods/{name}/full endpoint are marked in the "Full" column. Fields may be absent if there is no data.

{| class="wikitable"
! Key !! Type !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' | api/mods endpoint !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' | Short !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' | Full !! Description
|-
| latest_release || [[#Releases|Release]]? || ✓ || ||
| The latest version of the mod available for download. Absent when the <code>namelist</code> [[#/api/mods|parameter]] is used.
|-
| downloads_count || Integer || ✓ || ✓ || ✓
| Number of downloads.
|-
| name || String || ✓ || ✓ || ✓
| The mod's machine-readable ID string.
|-
| owner || String || ✓ || ✓ || ✓
| The Factorio username of the mod's author.
|-
| releases || [[#Releases|Release]][] || ✓* || ✓ || ✓
| A list of different versions of the mod available for download. See [[#Releases]]. *Only when using <code>namelist</code> [[#/api/mods|parameter]].
|-
| summary || String || ✓ || ✓ || ✓
| A shorter mod description.
|-
| title || String || ✓ || ✓ || ✓
| The mod's human-readable name.
|-
| category || [[Mod_details_API#Category|Category]]? || ✓ || ✓ || ✓
| A single category describing the mod. See [[Mod_details_API#Category]].

|-
| score || Integer || ✓ || ✓* || ✓*
| The score of the mod. *Only when not 0.
|-
| thumbnail || String(relative URL)? || || ✓ || ✓
| The relative path to the thumbnail of the mod. For mods that have no thumbnail it may be absent or default to <code>"/assets/.thumb.png"</code>. Prepend "assets-mod.factorio.com".
|-
| changelog || String? || || || ✓
| A string describing the recent changes to a mod.
|-
| created_at || String(ISO 8601) || || || ✓
| ISO 8601 for when the mod was created. (RFC 3339 nano)
|-
| updated_at || String(ISO 8601) || || || ✓
| ISO 8601 for when the mod was last updated. (RFC 3339 nano)
|-
| last_highlighted_at || String(ISO 8601)? || || || ✓
| ISO 8601 for when the mod was last featured on the "Highlighted mods" tab. (RFC 3339 nano)
|-
| description || String? || || || ✓
| A longer description of the mod, in text only format.
|-
| source_url || String? || || || ✓
| A URL to the mod's source code.
|-
| github_path || String? || || || ✓
| Deprecated: Use <code>source_url</code> instead. A link to the mod's github project page, just prepend "github.com/". Can be blank ("").
|-
| homepage || String || || || ✓
| Usually a URL to the mod's main project page, but can be any string.
|-
| tags || [[#Tags|Tag]][] || || || ✓
| A list of tag names that categorize the mod. See [[#Tags]].
|-
| license || [[#License]][] || || || ✓
| The license that applies to the mod. See [[#License]].
|-
| deprecated || Boolean? || || || ✓
| <ref></ref>True if the mod is marked as deprecated by its owner. Absent when false.
|-
|}

=== Releases ===

Only difference here between the api/mods/{name} endpoint and the api/mods/{name}/full endpoint is that the full one includes an array of dependencies in the info_json object.

{| class="wikitable"
! Key !! Type !! Description
|-
| download_url || String
| Path to download for a mod. starts with "/download" and does not include a full url. See [[#Downloading Mods]]
|-
| file_name || String
| The file name of the release. Always seems to follow the pattern "{name}_{version}.zip"
|-
| info_json || Object
| A copy of the mod's info.json file, only contains factorio_version in short version, also contains an array of dependencies in full version
|-
| released_at || String(ISO 8601)
| ISO 8601 for when the mod was released. (RFC 3339 nano)
|-
| version || String
| The version string of this mod release. Used to determine dependencies.
|-
| sha1 || String
| The sha1 key for the file
|-
|}

=== Tags ===

Currently, there are only a fixed number of tags available, these include:

{| class="wikitable"
! id !! type !! name !! title !! description
|-
| 12 || t || transportation || Transportation || Transportation of the player, be it vehicles or teleporters.
|-
| 13 || t || logistics || Logistics || Augmented or new ways of transporting materials - belts, inserters, pipes!
|-
| ?? || t || combat || Combat || New ways to deal with enemies, be it attack or defense.
|-
| 17 || t || enemies || Enemies || Changes to enemies or entirely new enemies to deal with.
|-
| 18 || t || armor || Armor || Armors or armor equipment.
|-
| ?? || t || environment || Environment || Map generation and terrain modification.
|-
| 20 || t || logistic-network || Logistics Network || Related to roboports and logistic robots
|-
| ?? || t || circuit-network || Circuit network || Entities which interact with the circuit network.
|-
| 21 || t || storage || Storage || More than just chests.
|-
| 22 || t || power || Power Production || Changes to power production and distribution.
|-
| 23 || t || manufacturing || Manufacture || Furnaces, assembling machines, production chains
|-
| 24 || t || blueprints || Blueprints || Change blueprint behavior.
|-
| 25 || t || cheats || Cheats || Play it your way.
|-
| 27 || t || mining || Mining || New ores and resources as well as machines.
|-
| ?? || t || fluids || Fluids || Things related to oil and other fluids.
|-
| 29 || t || trains || Trains || Trains are great, but what if they could do even more?
|}

=== License ===

{| class="wikitable"
! Key !! Type !! Description
|-
| description || String || A short description of the license.
|-
| id || String || The unique id of the license.
|-
| name || String || The internal name of the license.
|-
| title || String || The human-readable title of the license.
|-
| url || String || Usually a URL to the full license text, but can be any string.
|}

=== Error ===

{| class="wikitable"
! Key !! Type !! Description
|-
| message || String ||
|}

== Downloading Mods ==

You can get the full url by appending the download_url to mods.factorio.com, but if you're not authenticated, you will be redirected to mods.factorio.com/login. Logging in to that would give you access to the file. Fortunately, there's a better way to do this. Simply adding username and token parameters to the download url will prevent the redirecting and let you download the file immediately. The token can be acquired from a json file called "player-data.json", located in the User Data directory (see [[Application_directory#User_data_directory]]). You can also get the token by using the [[Web_authentication_API | Web Authentication API]].

Example usage:
https://mods.factorio.com/{download_url}?username={username}&token={token}

[[Category:Technical]]

Mod portal API

2025-02-13T19:09:51Z

SpeckledFleebeedoo: Mark another optional field

<div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Internal|Internal API]]</div>

The Mod Portal API is used to both browse and download all mods available on the [https://mods.factorio.com/ official Factorio mod portal]. Using the API does not require any kind of authentication or account information and can be viewed simply by following the URLs below in any web browser.

<code>https://mods.factorio.com/api/mods</code>

More detailed information about a particular mod can be obtained by retrieving the following URL, where {name} is the mod's name field in the result object.

<code>https://mods.factorio.com/api/mods/{name}</code>

To get even more information about a mod, you can use the following URL.

<code>https://mods.factorio.com/api/mods/{name}/full</code>

== Endpoints ==

=== /api/mods ===

GET Parameters (sent as query parameters):

{| class="wikitable"
! Key !! Values !! Description
|-
| hide_deprecated || {boolean} || Only return non-deprecated mods.
|-
| page ||{an integer}||Page number you would like to show. Makes it so you can see a certain part of the list without getting detail on all
|-
| page_size ||{an integer or 'max'}||The amount of results to show in your search
|-
| sort || {enum, one of name, created_at or updated_at} || Sort results by this property. Defaults to name when not defined. Ignored for <code>page_size=max</code> queries.
|-
| sort_order || {enum, one of asc or desc} || Sort results ascending or descending. Defaults to descending when not defined. Ignored for <code>page_size=max</code> queries.
|-
| namelist || {array of strings} || Return only mods that match the given names. Either comma-separated names or supply the namelist parameter more than once. Response will include <code>releases</code> instead of <code>latest_release</code>.
|-
| version || {enum, one of 0.13, 0.14, 0.15, 0.16, 0.17, 0.18, 1.0, 1.1 or 2.0} || Only return non-deprecated mods compatible with this Factorio version
|}

Returns [[#Mod List Response]]

=== /api/mods/{mod_name} ===

Return short information of a specific mod.

See [[#Result Entry]], "Short" column.

=== /api/mods/{mod_name}/full ===

Returns more information of a mod.

See [[#Result Entry]], "Full" column.

== JSON Object Types ==

=== Mod List Response ===

{| class="wikitable"
! Key !! Type !! Description
|-
| pagination || [[#Pagination|Pagination]] || See [[#Pagination]]
|-
| results || [[#Result Entry|Result]][] || A list of mods, matching any filters you specified.
|}

=== Pagination ===

{| class="wikitable"
! Key !! Type !! Description
|-
| count || Integer || Total number of mods that match your specified filters.
|-
| links || [[#Pagination_Links|Links]] || Utility links to mod portal api requests, preserving all filters and search queries.
|-
| page || Integer || The current page number.
|-
| page_count || Integer || The total number of pages returned.
|-
| page_size || Integer || The number of results per page.
|}

=== Pagination Links ===

{| class="wikitable"
! Key !! Type !! Description
|-
| first || String(URL) || URL to the first page of the results, or null if you're already on the first page.
|-
| prev || String(URL) || URL to the previous page of the results, or null if you're already on the first page.
|-
| next || String(URL) || URL to the next page of the results, or null if you're already on the last page.
|-
| last || String(URL) || URL to the last page of the results, or null if you're already on the last page.
|}

=== Result Entry ===

Fields returned by the api/mods endpoint are marked with a check (✓) in the "api/mods endpoint" column, those returned by the api/mods/{name} endpoint are marked with a check in the "Short" column and those returned by the api/mods/{name}/full endpoint are marked in the "Full" column. Fields may be absent if there is no data.

{| class="wikitable"
! Key !! Type !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' | api/mods endpoint !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' | Short !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' | Full !! Description
|-
| latest_release || [[#Releases|Release]]? || ✓ || ||
| The latest version of the mod available for download. Absent when the <code>namelist</code> [[#/api/mods|parameter]] is used.
|-
| downloads_count || Integer || ✓ || ✓ || ✓
| Number of downloads.
|-
| name || String || ✓ || ✓ || ✓
| The mod's machine-readable ID string.
|-
| owner || String || ✓ || ✓ || ✓
| The Factorio username of the mod's author.
|-
| releases || [[#Releases|Release]][] || ✓* || ✓ || ✓
| A list of different versions of the mod available for download. See [[#Releases]]. *Only when using <code>namelist</code> [[#/api/mods|parameter]].
|-
| summary || String || ✓ || ✓ || ✓
| A shorter mod description.
|-
| title || String || ✓ || ✓ || ✓
| The mod's human-readable name.
|-
| category || [[Mod_details_API#Category|Category]]? || ✓ || ✓ || ✓
| A single category describing the mod. See [[Mod_details_API#Category]].

|-
| score || Integer || ✓ || ✓* || ✓*
| The score of the mod. *Only when not 0.
|-
| thumbnail || String(relative URL)? || || ✓ || ✓
| The relative path to the thumbnail of the mod. For mods that have no thumbnail it may be absent or default to <code>"/assets/.thumb.png"</code>. Prepend "assets-mod.factorio.com".
|-
| changelog || String? || || || ✓
| A string describing the recent changes to a mod.
|-
| created_at || String(ISO 8601) || || || ✓
| ISO 8601 for when the mod was created. (RFC 3339 nano)
|-
| updated_at || String(ISO 8601) || || || ✓
| ISO 8601 for when the mod was last updated. (RFC 3339 nano)
|-
| last_highlighted_at || String(ISO 8601)? || || || ✓
| ISO 8601 for when the mod was last featured on the "Highlighted mods" tab. (RFC 3339 nano)
|-
| description || String || || || ✓
| A longer description of the mod, in text only format.
|-
| source_url || String? || || || ✓
| A URL to the mod's source code.
|-
| github_path || String? || || || ✓
| Deprecated: Use <code>source_url</code> instead. A link to the mod's github project page, just prepend "github.com/". Can be blank ("").
|-
| homepage || String || || || ✓
| Usually a URL to the mod's main project page, but can be any string.
|-
| tags || [[#Tags|Tag]][] || || || ✓
| A list of tag names that categorize the mod. See [[#Tags]].
|-
| license || [[#License]][] || || || ✓
| The license that applies to the mod. See [[#License]].
|-
| deprecated || Boolean? || || || ✓
| <ref></ref>True if the mod is marked as deprecated by its owner. Absent when false.
|-
|}

=== Releases ===

Only difference here between the api/mods/{name} endpoint and the api/mods/{name}/full endpoint is that the full one includes an array of dependencies in the info_json object.

{| class="wikitable"
! Key !! Type !! Description
|-
| download_url || String
| Path to download for a mod. starts with "/download" and does not include a full url. See [[#Downloading Mods]]
|-
| file_name || String
| The file name of the release. Always seems to follow the pattern "{name}_{version}.zip"
|-
| info_json || Object
| A copy of the mod's info.json file, only contains factorio_version in short version, also contains an array of dependencies in full version
|-
| released_at || String(ISO 8601)
| ISO 8601 for when the mod was released. (RFC 3339 nano)
|-
| version || String
| The version string of this mod release. Used to determine dependencies.
|-
| sha1 || String
| The sha1 key for the file
|-
|}

=== Tags ===

Currently, there are only a fixed number of tags available, these include:

{| class="wikitable"
! id !! type !! name !! title !! description
|-
| 12 || t || transportation || Transportation || Transportation of the player, be it vehicles or teleporters.
|-
| 13 || t || logistics || Logistics || Augmented or new ways of transporting materials - belts, inserters, pipes!
|-
| ?? || t || combat || Combat || New ways to deal with enemies, be it attack or defense.
|-
| 17 || t || enemies || Enemies || Changes to enemies or entirely new enemies to deal with.
|-
| 18 || t || armor || Armor || Armors or armor equipment.
|-
| ?? || t || environment || Environment || Map generation and terrain modification.
|-
| 20 || t || logistic-network || Logistics Network || Related to roboports and logistic robots
|-
| ?? || t || circuit-network || Circuit network || Entities which interact with the circuit network.
|-
| 21 || t || storage || Storage || More than just chests.
|-
| 22 || t || power || Power Production || Changes to power production and distribution.
|-
| 23 || t || manufacturing || Manufacture || Furnaces, assembling machines, production chains
|-
| 24 || t || blueprints || Blueprints || Change blueprint behavior.
|-
| 25 || t || cheats || Cheats || Play it your way.
|-
| 27 || t || mining || Mining || New ores and resources as well as machines.
|-
| ?? || t || fluids || Fluids || Things related to oil and other fluids.
|-
| 29 || t || trains || Trains || Trains are great, but what if they could do even more?
|}

=== License ===

{| class="wikitable"
! Key !! Type !! Description
|-
| description || String || A short description of the license.
|-
| id || String || The unique id of the license.
|-
| name || String || The internal name of the license.
|-
| title || String || The human-readable title of the license.
|-
| url || String || Usually a URL to the full license text, but can be any string.
|}

=== Error ===

{| class="wikitable"
! Key !! Type !! Description
|-
| message || String ||
|}

== Downloading Mods ==

You can get the full url by appending the download_url to mods.factorio.com, but if you're not authenticated, you will be redirected to mods.factorio.com/login. Logging in to that would give you access to the file. Fortunately, there's a better way to do this. Simply adding username and token parameters to the download url will prevent the redirecting and let you download the file immediately. The token can be acquired from a json file called "player-data.json", located in the User Data directory (see [[Application_directory#User_data_directory]]). You can also get the token by using the [[Web_authentication_API | Web Authentication API]].

Example usage:
https://mods.factorio.com/{download_url}?username={username}&token={token}

[[Category:Technical]]

Mod portal API

2025-02-13T19:08:48Z

SpeckledFleebeedoo: Mark (some) optional fields

<div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Internal|Internal API]]</div>

The Mod Portal API is used to both browse and download all mods available on the [https://mods.factorio.com/ official Factorio mod portal]. Using the API does not require any kind of authentication or account information and can be viewed simply by following the URLs below in any web browser.

<code>https://mods.factorio.com/api/mods</code>

More detailed information about a particular mod can be obtained by retrieving the following URL, where {name} is the mod's name field in the result object.

<code>https://mods.factorio.com/api/mods/{name}</code>

To get even more information about a mod, you can use the following URL.

<code>https://mods.factorio.com/api/mods/{name}/full</code>

== Endpoints ==

=== /api/mods ===

GET Parameters (sent as query parameters):

{| class="wikitable"
! Key !! Values !! Description
|-
| hide_deprecated || {boolean} || Only return non-deprecated mods.
|-
| page ||{an integer}||Page number you would like to show. Makes it so you can see a certain part of the list without getting detail on all
|-
| page_size ||{an integer or 'max'}||The amount of results to show in your search
|-
| sort || {enum, one of name, created_at or updated_at} || Sort results by this property. Defaults to name when not defined. Ignored for <code>page_size=max</code> queries.
|-
| sort_order || {enum, one of asc or desc} || Sort results ascending or descending. Defaults to descending when not defined. Ignored for <code>page_size=max</code> queries.
|-
| namelist || {array of strings} || Return only mods that match the given names. Either comma-separated names or supply the namelist parameter more than once. Response will include <code>releases</code> instead of <code>latest_release</code>.
|-
| version || {enum, one of 0.13, 0.14, 0.15, 0.16, 0.17, 0.18, 1.0, 1.1 or 2.0} || Only return non-deprecated mods compatible with this Factorio version
|}

Returns [[#Mod List Response]]

=== /api/mods/{mod_name} ===

Return short information of a specific mod.

See [[#Result Entry]], "Short" column.

=== /api/mods/{mod_name}/full ===

Returns more information of a mod.

See [[#Result Entry]], "Full" column.

== JSON Object Types ==

=== Mod List Response ===

{| class="wikitable"
! Key !! Type !! Description
|-
| pagination || [[#Pagination|Pagination]] || See [[#Pagination]]
|-
| results || [[#Result Entry|Result]][] || A list of mods, matching any filters you specified.
|}

=== Pagination ===

{| class="wikitable"
! Key !! Type !! Description
|-
| count || Integer || Total number of mods that match your specified filters.
|-
| links || [[#Pagination_Links|Links]] || Utility links to mod portal api requests, preserving all filters and search queries.
|-
| page || Integer || The current page number.
|-
| page_count || Integer || The total number of pages returned.
|-
| page_size || Integer || The number of results per page.
|}

=== Pagination Links ===

{| class="wikitable"
! Key !! Type !! Description
|-
| first || String(URL) || URL to the first page of the results, or null if you're already on the first page.
|-
| prev || String(URL) || URL to the previous page of the results, or null if you're already on the first page.
|-
| next || String(URL) || URL to the next page of the results, or null if you're already on the last page.
|-
| last || String(URL) || URL to the last page of the results, or null if you're already on the last page.
|}

=== Result Entry ===

Fields returned by the api/mods endpoint are marked with a check (✓) in the "api/mods endpoint" column, those returned by the api/mods/{name} endpoint are marked with a check in the "Short" column and those returned by the api/mods/{name}/full endpoint are marked in the "Full" column. Fields may be absent if there is no data.

{| class="wikitable"
! Key !! Type !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' | api/mods endpoint !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' | Short !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' | Full !! Description
|-
| latest_release || [[#Releases|Release]]? || ✓ || ||
| The latest version of the mod available for download. Absent when the <code>namelist</code> [[#/api/mods|parameter]] is used.
|-
| downloads_count || Integer || ✓ || ✓ || ✓
| Number of downloads.
|-
| name || String || ✓ || ✓ || ✓
| The mod's machine-readable ID string.
|-
| owner || String || ✓ || ✓ || ✓
| The Factorio username of the mod's author.
|-
| releases || [[#Releases|Release]][] || ✓* || ✓ || ✓
| A list of different versions of the mod available for download. See [[#Releases]]. *Only when using <code>namelist</code> [[#/api/mods|parameter]].
|-
| summary || String || ✓ || ✓ || ✓
| A shorter mod description.
|-
| title || String || ✓ || ✓ || ✓
| The mod's human-readable name.
|-
| category || [[Mod_details_API#Category|Category]]? || ✓ || ✓ || ✓
| A single category describing the mod. See [[Mod_details_API#Category]].

|-
| score || Integer || ✓ || ✓* || ✓*
| The score of the mod. *Only when not 0.
|-
| thumbnail || String(relative URL) || || ✓ || ✓
| The relative path to the thumbnail of the mod. For mods that have no thumbnail it may be absent or default to <code>"/assets/.thumb.png"</code>. Prepend "assets-mod.factorio.com".
|-
| changelog || String? || || || ✓
| A string describing the recent changes to a mod.
|-
| created_at || String(ISO 8601) || || || ✓
| ISO 8601 for when the mod was created. (RFC 3339 nano)
|-
| updated_at || String(ISO 8601) || || || ✓
| ISO 8601 for when the mod was last updated. (RFC 3339 nano)
|-
| last_highlighted_at || String(ISO 8601)? || || || ✓
| ISO 8601 for when the mod was last featured on the "Highlighted mods" tab. (RFC 3339 nano)
|-
| description || String || || || ✓
| A longer description of the mod, in text only format.
|-
| source_url || String? || || || ✓
| A URL to the mod's source code.
|-
| github_path || String? || || || ✓
| Deprecated: Use <code>source_url</code> instead. A link to the mod's github project page, just prepend "github.com/". Can be blank ("").
|-
| homepage || String || || || ✓
| Usually a URL to the mod's main project page, but can be any string.
|-
| tags || [[#Tags|Tag]][] || || || ✓
| A list of tag names that categorize the mod. See [[#Tags]].
|-
| license || [[#License]][] || || || ✓
| The license that applies to the mod. See [[#License]].
|-
| deprecated || Boolean? || || || ✓
| <ref></ref>True if the mod is marked as deprecated by its owner. Absent when false.
|-
|}

=== Releases ===

Only difference here between the api/mods/{name} endpoint and the api/mods/{name}/full endpoint is that the full one includes an array of dependencies in the info_json object.

{| class="wikitable"
! Key !! Type !! Description
|-
| download_url || String
| Path to download for a mod. starts with "/download" and does not include a full url. See [[#Downloading Mods]]
|-
| file_name || String
| The file name of the release. Always seems to follow the pattern "{name}_{version}.zip"
|-
| info_json || Object
| A copy of the mod's info.json file, only contains factorio_version in short version, also contains an array of dependencies in full version
|-
| released_at || String(ISO 8601)
| ISO 8601 for when the mod was released. (RFC 3339 nano)
|-
| version || String
| The version string of this mod release. Used to determine dependencies.
|-
| sha1 || String
| The sha1 key for the file
|-
|}

=== Tags ===

Currently, there are only a fixed number of tags available, these include:

{| class="wikitable"
! id !! type !! name !! title !! description
|-
| 12 || t || transportation || Transportation || Transportation of the player, be it vehicles or teleporters.
|-
| 13 || t || logistics || Logistics || Augmented or new ways of transporting materials - belts, inserters, pipes!
|-
| ?? || t || combat || Combat || New ways to deal with enemies, be it attack or defense.
|-
| 17 || t || enemies || Enemies || Changes to enemies or entirely new enemies to deal with.
|-
| 18 || t || armor || Armor || Armors or armor equipment.
|-
| ?? || t || environment || Environment || Map generation and terrain modification.
|-
| 20 || t || logistic-network || Logistics Network || Related to roboports and logistic robots
|-
| ?? || t || circuit-network || Circuit network || Entities which interact with the circuit network.
|-
| 21 || t || storage || Storage || More than just chests.
|-
| 22 || t || power || Power Production || Changes to power production and distribution.
|-
| 23 || t || manufacturing || Manufacture || Furnaces, assembling machines, production chains
|-
| 24 || t || blueprints || Blueprints || Change blueprint behavior.
|-
| 25 || t || cheats || Cheats || Play it your way.
|-
| 27 || t || mining || Mining || New ores and resources as well as machines.
|-
| ?? || t || fluids || Fluids || Things related to oil and other fluids.
|-
| 29 || t || trains || Trains || Trains are great, but what if they could do even more?
|}

=== License ===

{| class="wikitable"
! Key !! Type !! Description
|-
| description || String || A short description of the license.
|-
| id || String || The unique id of the license.
|-
| name || String || The internal name of the license.
|-
| title || String || The human-readable title of the license.
|-
| url || String || Usually a URL to the full license text, but can be any string.
|}

=== Error ===

{| class="wikitable"
! Key !! Type !! Description
|-
| message || String ||
|}

== Downloading Mods ==

You can get the full url by appending the download_url to mods.factorio.com, but if you're not authenticated, you will be redirected to mods.factorio.com/login. Logging in to that would give you access to the file. Fortunately, there's a better way to do this. Simply adding username and token parameters to the download url will prevent the redirecting and let you download the file immediately. The token can be acquired from a json file called "player-data.json", located in the User Data directory (see [[Application_directory#User_data_directory]]). You can also get the token by using the [[Web_authentication_API | Web Authentication API]].

Example usage:
https://mods.factorio.com/{download_url}?username={username}&token={token}

[[Category:Technical]]

Command line parameters

2025-01-25T12:45:30Z

SpeckledFleebeedoo: Add better explanation to --sync-mods

{{Languages}}__TOC__

Command line parameters can be used to set settings in the command line before the game launches, this is useful mainly for advanced users or server hosts.

{| class="wikitable"
|+General options
|-
| -h, --help
|
| display help
|-
| --version
|
| show version information
|-
| -v, --verbose
|
| enable verbose logging
|-
| -c, --config
| PATH
| config file to use
|-
| --no-log-rotation
|
| don't rotate log file
|-
| --mod-directory
| PATH
| Mod directory to use
|-
| --check-unused-prototype-data
|
| Print a warning for all prototype values that were not accessed. Note for mod authors: If an entry is unused and is a table that contains the key/value pair 'ignore' with the value 'true' then the entire entry is ignored.
|-
| --executable-path
| PATH
| Override autodetected __PATH__executable. Usually not needed except on very weird systems.
|}

{| class="wikitable"
|+ Running options
|-
| -s, --map2scenario
| arg
| map to scenario conversion
|-
| -m, --scenario2map
| arg
| scenario to map conversion
|-
| --apply-update
| arg
| immediately apply update package
|-
| --create
| FILE
| create a new map
|-
| --map-gen-settings
| FILE
| Map generation settings for use with <code>--create</code>, <code>--start-server-load-scenario</code> or <code>--generate-map-preview</code>. See data/map-gen-settings.example.json
|-
| --map-gen-seed
| SEED
| Map generation seed for use with --create, --start-server-load-scenario or --generate-map-preview. Will override seed specified in map gen settings
|-
| --map-gen-seed-max
| SEED
| Map generation seed for use with --generate-map-preview to generate multiple previews using every second seed in the interval from map-gen-seed to map-gen-seed-max.
|-
| --map-settings
| FILE
| Map settings for use with --create or --start-server-load-scenario. See data/base/prototypes/map-settings.lua
|-
| --preset
| arg
| Name of the map generation preset to be used.
|-
| --generate-map-preview
| PATH
| Generate preview images of the map; PATH should name a PNG file or end with a '/' or '\' to indicate a directory.
|-
| --generate-map-preview-random
| COUNT
| Number of maps to generate with a random seed using --generate-map-preview.
|-
| --map-preview-size
| SIZE
| Size (in pixels) of map preview (default: 1024)
|-
| --map-preview-offset
| X,Y
| Offset of the center of the map, in meters (default: 0,0)
|-
| --map-preview-planet
| PLANET
| Planet to generate the preview for (default: nauvis)
|-
| --report-quantities
| PROTOTYPE,...
| When generating map preview, report approximate quantities of the named entity prototypes
|-
| --threads
| THREADCOUNT
| Number of threads to use when generating map previews
|-
| --disable-migration-window
|
| Disables the gui that is shown when opening a save with migrated content
|-
| --instrument-mod
| arg
| Name of a mod to enable [https://lua-api.factorio.com/latest/auxiliary/instrument.html Instrument Mode]
|-
| --sync-mods
| FILE
| Sync mods with save. Note for headless servers: requires <code>service-username</code> and <code>service-token</code> to be set in the player-data.json file.
|-
| --enable-unsafe-lua-debug-api
|
| Enables unsafe functions in the Lua debug library.
|-
| --host
| FILE
| Start hosting a multiplayer game
|-
| --host-interactive
| FILE
| Open multiplayer server settings for hosting the selecting save
|-
| --start-server
| FILE
| start a multiplayer server
|-
| --start-server-load-scenario
| [MOD/]NAME
| start a multiplayer server and load the specified scenario. The scenario is looked for inside the given mod. If no mod is given, it is looked for in the top-level scenarios directory.
|-
| --start-server-load-latest
|
| start a multiplayer server and load the latest available save
|-
| --until-tick
| TICK
| run a save until given map tick
|-
| --benchmark
| FILE
| load save and run benchmark
|-
| --benchmark-ticks
| N
| number of ticks for benchmarking. Default is 1000
|-
| --benchmark-runs
| N
| how often the number of ticks will be run, map will reload after each run. Default is 1
|-
| --benchmark-verbose
| timings
| comma separated list of timings to output each tick. "all", "timestamp" as well as all other values seen in the debug view are allowed here. An empty string disabled verbose benchmarking.
|-
| --benchmark-sanitize
|
| only output the final benchmark results
|-
| --benchmark-ignore-paused
|
| leaves the game paused if it was paused when saved. By default the game is unpaused when a benchmark starts.
|-
| --output-perf-stats
| FILE
| path of file to which rendering performance statistics measurements should be saved. Special tags {api}, {hw}, {time} and {tag} will be replaced.
|-
| --dump-data
|
| dumps data.raw as JSON to the script output folder and exits.
|-
| --dump-icon-sprites
|
| dumps all icon sprites as png files to the script output folder and exits.
|-
| --dump-prototype-locale
|
| dumps all prototypes name and description (if they have a valid value) to the script output folder and exits.
|-
| --report-autogenerated-icon-mipmaps
|
| Report which icons will have generated mipmaps.
|-
| --log-shared-tile-layers
|
| After loading prototypes logs which tile layers are shared by multiple prototypes and lists the prototypes that share them.
|-
| --log-spritesheets-to-optimize
| N
| Logs N spritesheets that seem to have some nearly transparent noise, and could be made much smaller if the noise was cleaned up.
|-
| --mp-connect
| ADDRESS
| start factorio and connect to address
|-
| --password
| PASSWORD
| the password to use when using mp-connect (if any)
|-
| --heavy
|
| run the game in heavy mode if singleplayer with graphics. (heavy mode is related to investigating desyncs, see [[Desynchronization#Using_heavy_mode_command]])
|-
| --load-game
| FILE
| start Factorio and load a game in singleplayer
|-
| --load-scenario
| [MOD/]NAME
| start Factorio and load the specified scenario in singleplayer. The scenario is looked for inside the given mod. If no mod is given, it is looked for in the top-level scenarios directory.
|-
| --benchmark-graphics
| FILE
| load save and run it with graphics for benchmark-ticks number of ticks as normal game would
|-
| --benchmark-frame
| FILE
| load save and benchmark graphics rendering of single frame (prepare + render) without updating the game
|-
| --debug-graphics
|
| enables debugging layer for graphics API. If DirectX is used DirectX SDK needs to be installed for this to work.
|-
| --fullscreen
|
| start game in windowed mode (saved to configuration)
|-
| --max-texture-size
| N
| maximal size of texture that the game can use (saved to configuration). Should be power of two greater than 2048
|-
| --graphics-quality
| arg
| accepted values: high, medium
|-
| --video-memory-usage
| arg
| accepted values: all, high, medium, low
|-
| --force-graphics-preset
| arg
| accepted values: very-low, low, mac-with-low-ram, medium-with-low-vram, medium, high, very-high, extreme
|-
| --gfx-safe-mode
|
| resets some graphics settings to values that should work on most configurations
|-
| --low-vram
|
| sprites that are not put into sprite atlases won't be allocated as texture objects
|-
| --shader
| arg
| enable/disable shader postprocessing (saved to configuration)
|-
| --disable-audio
|
| Disable audio. Mainly for faster startup during development.
|-
| --window-size
| arg
| Desired window resolution. For example "1680x1050". Or "maximized"
|-
| --single-thread-loading
|
| Disables loading of sprites in multiple threads.
|-
| --cache-sprite-atlas
|
| Enable/disable sprite atlas cache.
|-
| --nogamepad
|
| Disable gamepad(controller) support
|}

{| class="wikitable"
|+ Server options
|-
| --port
| N
| network port to use
|-
| --bind
| ADDRESS[:PORT]
| IP address (and optionally port) to bind to
|-
| --rcon-port
| N
| Port to use for RCON
|-
| --rcon-bind
| ADDRESS:PORT
| IP address and port to use for RCON
|-
| --rcon-password
| PASSWORD
| Password for RCON
|-
| --server-settings
| FILE
| Path to file with server settings. See data/server-settings.example.json
|-
| --use-server-whitelist
|
| If the whitelist should be used.
|-
| --use-authserver-bans
|
| Verify that connecting players are not banned from multiplayer and inform Factorio.com about ban/unban commands.
|-
| --server-whitelist
| FILE
| Path to file with server whitelist.
|-
| --server-banlist
| FILE
| Path to file with server banlist.
|-
| --server-adminlist
| FILE
| Path to file with server adminlist.
|-
| --console-log
| FILE
| Path to file where a copy of the server's log will be stored
|-
| --server-id
| FILE
| Path where server ID will be stored or read from
|}

=== Boolean options ===

Parameters shown above with a BOOL option must be formatted as <code>[parameter]=true</code> or <code>[parameter]=false</code>. For example,

--fullscreen=false

will start the game in windowed (not fullscreen) mode.

=== Multiplayer ===

--start-server SAVE

Will start a Headless (Dedicated) server, with no GUI.

--mp-connect ADDRESS
ADDRESS is the IP:port of the remote host. Port is optional.
Examples:

./factorio --mp-connect 192.168.1.101
./factorio --mp-connect 192.168.1.101:2345

As above, port can be specified by placing the port number after a colon in the address.

=== Creating a map from custom settings ===

Sometimes it's useful to create a new game with map and/or map generator settings stored in a JSON file rather than going through the in-game map settings screen.
One reason is that by editing the settings directly it is possible to set settings outside the range normally available from the GUI.

To do this, Factorio is run from the command-line, and a JSON file containing the map generator settings and a JSON file containing map settings (if customizing them) are needed.

Example for custom generator settings:
<pre>{
"terrain_segmentation": 0.5,
"water": "2",
"width": 0,
"height": 0,
"starting_area": "normal",
"peaceful_mode": false,
"autoplace_controls":
{
"coal": {"frequency": 1, "size": 2, "richness": 0.5},
"copper-ore": {"frequency": "low", "size": "normal", "richness": "high"},
"crude-oil": {"frequency": "normal", "size": "normal", "richness": "normal"},
"enemy-base": {"frequency": "normal", "size": "normal", "richness": "normal"},
"iron-ore": {"frequency": "normal", "size": "normal", "richness": "normal"},
"stone": {"frequency": "normal", "size": 0, "richness": "normal"},
"uranium-ore": {"frequency": "normal", "size": "none", "richness": "normal"}
},

"cliff_settings":
{
"name": "cliff",
"cliff_elevation_0": 30,
"cliff_elevation_interval": 20,
"richness": 1
},

"property_expression_names":
{
"elevation": "0_16-elevation",
"temperature": "35"
},

"seed": null
}
</pre>

Note that this is the same format as [https://lua-api.factorio.com/latest/concepts/MapGenSettings.html MapGenSettings] that are modifiable from Lua. Everything in the file is optional.

Creating a custom save:
<pre>
"C:\Program Files\Factorio\bin\x64\Factorio.exe" --create stuff-seed123.zip --map-gen-settings map-gen-settings.json --map-gen-seed 123
</pre>

Generating a map preview:
<pre>
"C:\Program Files\Factorio\bin\x64\Factorio.exe" --generate-map-preview preview-seed123.png --map-gen-settings map-gen-settings.json --map-gen-seed 123
</pre>

==== Creating the JSON files from a map exchange string ====

It can be useful to create the initial JSON files from a known map exchange string instead of creating them from scratch. To convert the map exchange string to JSON, open the game and run the following command with your map exchange string:

/c helpers.write_file('map.txt', helpers.table_to_json(helpers.parse_map_exchange_string("<your exchange string here>")))

Then open the script_output folder in the [[user data directory]] and open map.txt - it will look like this:

{"map_settings":{ ...<MAP_SETTINGS> ... },"map_gen_settings":{ ...<MAP_GEN_SETTINGS>... }}

Copy the { ...<MAP_SETTINGS> ... } section into a new file called 'map-settings.json' in the desired location. Copy the { ...<MAP_GEN_SETTINGS> ... } section section into a new file called 'map-gen-settings.json' in the desired location.

== See also ==
* [[Console]]

{{C|Modding}}

Command line parameters

2025-01-25T12:39:35Z

SpeckledFleebeedoo: Bring back add-on notes for some entries

{{Languages}}__TOC__

Command line parameters can be used to set settings in the command line before the game launches, this is useful mainly for advanced users or server hosts.

{| class="wikitable"
|+General options
|-
| -h, --help
|
| display help
|-
| --version
|
| show version information
|-
| -v, --verbose
|
| enable verbose logging
|-
| -c, --config
| PATH
| config file to use
|-
| --no-log-rotation
|
| don't rotate log file
|-
| --mod-directory
| PATH
| Mod directory to use
|-
| --check-unused-prototype-data
|
| Print a warning for all prototype values that were not accessed. Note for mod authors: If an entry is unused and is a table that contains the key/value pair 'ignore' with the value 'true' then the entire entry is ignored.
|-
| --executable-path
| PATH
| Override autodetected __PATH__executable. Usually not needed except on very weird systems.
|}

{| class="wikitable"
|+ Running options
|-
| -s, --map2scenario
| arg
| map to scenario conversion
|-
| -m, --scenario2map
| arg
| scenario to map conversion
|-
| --apply-update
| arg
| immediately apply update package
|-
| --create
| FILE
| create a new map
|-
| --map-gen-settings
| FILE
| Map generation settings for use with <code>--create</code>, <code>--start-server-load-scenario</code> or <code>--generate-map-preview</code>. See data/map-gen-settings.example.json
|-
| --map-gen-seed
| SEED
| Map generation seed for use with --create, --start-server-load-scenario or --generate-map-preview. Will override seed specified in map gen settings
|-
| --map-gen-seed-max
| SEED
| Map generation seed for use with --generate-map-preview to generate multiple previews using every second seed in the interval from map-gen-seed to map-gen-seed-max.
|-
| --map-settings
| FILE
| Map settings for use with --create or --start-server-load-scenario. See data/base/prototypes/map-settings.lua
|-
| --preset
| arg
| Name of the map generation preset to be used.
|-
| --generate-map-preview
| PATH
| Generate preview images of the map; PATH should name a PNG file or end with a '/' or '\' to indicate a directory.
|-
| --generate-map-preview-random
| COUNT
| Number of maps to generate with a random seed using --generate-map-preview.
|-
| --map-preview-size
| SIZE
| Size (in pixels) of map preview (default: 1024)
|-
| --map-preview-offset
| X,Y
| Offset of the center of the map, in meters (default: 0,0)
|-
| --map-preview-planet
| PLANET
| Planet to generate the preview for (default: nauvis)
|-
| --report-quantities
| PROTOTYPE,...
| When generating map preview, report approximate quantities of the named entity prototypes
|-
| --threads
| THREADCOUNT
| Number of threads to use when generating map previews
|-
| --disable-migration-window
|
| Disables the gui that is shown when opening a save with migrated content
|-
| --instrument-mod
| arg
| Name of a mod to enable [https://lua-api.factorio.com/latest/auxiliary/instrument.html Instrument Mode]
|-
| --sync-mods
| FILE
| Sync mods with save
|-
| --enable-unsafe-lua-debug-api
|
| Enables unsafe functions in the Lua debug library.
|-
| --host
| FILE
| Start hosting a multiplayer game
|-
| --host-interactive
| FILE
| Open multiplayer server settings for hosting the selecting save
|-
| --start-server
| FILE
| start a multiplayer server
|-
| --start-server-load-scenario
| [MOD/]NAME
| start a multiplayer server and load the specified scenario. The scenario is looked for inside the given mod. If no mod is given, it is looked for in the top-level scenarios directory.
|-
| --start-server-load-latest
|
| start a multiplayer server and load the latest available save
|-
| --until-tick
| TICK
| run a save until given map tick
|-
| --benchmark
| FILE
| load save and run benchmark
|-
| --benchmark-ticks
| N
| number of ticks for benchmarking. Default is 1000
|-
| --benchmark-runs
| N
| how often the number of ticks will be run, map will reload after each run. Default is 1
|-
| --benchmark-verbose
| timings
| comma separated list of timings to output each tick. "all", "timestamp" as well as all other values seen in the debug view are allowed here. An empty string disabled verbose benchmarking.
|-
| --benchmark-sanitize
|
| only output the final benchmark results
|-
| --benchmark-ignore-paused
|
| leaves the game paused if it was paused when saved. By default the game is unpaused when a benchmark starts.
|-
| --output-perf-stats
| FILE
| path of file to which rendering performance statistics measurements should be saved. Special tags {api}, {hw}, {time} and {tag} will be replaced.
|-
| --dump-data
|
| dumps data.raw as JSON to the script output folder and exits.
|-
| --dump-icon-sprites
|
| dumps all icon sprites as png files to the script output folder and exits.
|-
| --dump-prototype-locale
|
| dumps all prototypes name and description (if they have a valid value) to the script output folder and exits.
|-
| --report-autogenerated-icon-mipmaps
|
| Report which icons will have generated mipmaps.
|-
| --log-shared-tile-layers
|
| After loading prototypes logs which tile layers are shared by multiple prototypes and lists the prototypes that share them.
|-
| --log-spritesheets-to-optimize
| N
| Logs N spritesheets that seem to have some nearly transparent noise, and could be made much smaller if the noise was cleaned up.
|-
| --mp-connect
| ADDRESS
| start factorio and connect to address
|-
| --password
| PASSWORD
| the password to use when using mp-connect (if any)
|-
| --heavy
|
| run the game in heavy mode if singleplayer with graphics. (heavy mode is related to investigating desyncs, see [[Desynchronization#Using_heavy_mode_command]])
|-
| --load-game
| FILE
| start Factorio and load a game in singleplayer
|-
| --load-scenario
| [MOD/]NAME
| start Factorio and load the specified scenario in singleplayer. The scenario is looked for inside the given mod. If no mod is given, it is looked for in the top-level scenarios directory.
|-
| --benchmark-graphics
| FILE
| load save and run it with graphics for benchmark-ticks number of ticks as normal game would
|-
| --benchmark-frame
| FILE
| load save and benchmark graphics rendering of single frame (prepare + render) without updating the game
|-
| --debug-graphics
|
| enables debugging layer for graphics API. If DirectX is used DirectX SDK needs to be installed for this to work.
|-
| --fullscreen
|
| start game in windowed mode (saved to configuration)
|-
| --max-texture-size
| N
| maximal size of texture that the game can use (saved to configuration). Should be power of two greater than 2048
|-
| --graphics-quality
| arg
| accepted values: high, medium
|-
| --video-memory-usage
| arg
| accepted values: all, high, medium, low
|-
| --force-graphics-preset
| arg
| accepted values: very-low, low, mac-with-low-ram, medium-with-low-vram, medium, high, very-high, extreme
|-
| --gfx-safe-mode
|
| resets some graphics settings to values that should work on most configurations
|-
| --low-vram
|
| sprites that are not put into sprite atlases won't be allocated as texture objects
|-
| --shader
| arg
| enable/disable shader postprocessing (saved to configuration)
|-
| --disable-audio
|
| Disable audio. Mainly for faster startup during development.
|-
| --window-size
| arg
| Desired window resolution. For example "1680x1050". Or "maximized"
|-
| --single-thread-loading
|
| Disables loading of sprites in multiple threads.
|-
| --cache-sprite-atlas
|
| Enable/disable sprite atlas cache.
|-
| --nogamepad
|
| Disable gamepad(controller) support
|}

{| class="wikitable"
|+ Server options
|-
| --port
| N
| network port to use
|-
| --bind
| ADDRESS[:PORT]
| IP address (and optionally port) to bind to
|-
| --rcon-port
| N
| Port to use for RCON
|-
| --rcon-bind
| ADDRESS:PORT
| IP address and port to use for RCON
|-
| --rcon-password
| PASSWORD
| Password for RCON
|-
| --server-settings
| FILE
| Path to file with server settings. See data/server-settings.example.json
|-
| --use-server-whitelist
|
| If the whitelist should be used.
|-
| --use-authserver-bans
|
| Verify that connecting players are not banned from multiplayer and inform Factorio.com about ban/unban commands.
|-
| --server-whitelist
| FILE
| Path to file with server whitelist.
|-
| --server-banlist
| FILE
| Path to file with server banlist.
|-
| --server-adminlist
| FILE
| Path to file with server adminlist.
|-
| --console-log
| FILE
| Path to file where a copy of the server's log will be stored
|-
| --server-id
| FILE
| Path where server ID will be stored or read from
|}

=== Boolean options ===

Parameters shown above with a BOOL option must be formatted as <code>[parameter]=true</code> or <code>[parameter]=false</code>. For example,

--fullscreen=false

will start the game in windowed (not fullscreen) mode.

=== Multiplayer ===

--start-server SAVE

Will start a Headless (Dedicated) server, with no GUI.

--mp-connect ADDRESS
ADDRESS is the IP:port of the remote host. Port is optional.
Examples:

./factorio --mp-connect 192.168.1.101
./factorio --mp-connect 192.168.1.101:2345

As above, port can be specified by placing the port number after a colon in the address.

=== Creating a map from custom settings ===

Sometimes it's useful to create a new game with map and/or map generator settings stored in a JSON file rather than going through the in-game map settings screen.
One reason is that by editing the settings directly it is possible to set settings outside the range normally available from the GUI.

To do this, Factorio is run from the command-line, and a JSON file containing the map generator settings and a JSON file containing map settings (if customizing them) are needed.

Example for custom generator settings:
<pre>{
"terrain_segmentation": 0.5,
"water": "2",
"width": 0,
"height": 0,
"starting_area": "normal",
"peaceful_mode": false,
"autoplace_controls":
{
"coal": {"frequency": 1, "size": 2, "richness": 0.5},
"copper-ore": {"frequency": "low", "size": "normal", "richness": "high"},
"crude-oil": {"frequency": "normal", "size": "normal", "richness": "normal"},
"enemy-base": {"frequency": "normal", "size": "normal", "richness": "normal"},
"iron-ore": {"frequency": "normal", "size": "normal", "richness": "normal"},
"stone": {"frequency": "normal", "size": 0, "richness": "normal"},
"uranium-ore": {"frequency": "normal", "size": "none", "richness": "normal"}
},

"cliff_settings":
{
"name": "cliff",
"cliff_elevation_0": 30,
"cliff_elevation_interval": 20,
"richness": 1
},

"property_expression_names":
{
"elevation": "0_16-elevation",
"temperature": "35"
},

"seed": null
}
</pre>

Note that this is the same format as [https://lua-api.factorio.com/latest/concepts/MapGenSettings.html MapGenSettings] that are modifiable from Lua. Everything in the file is optional.

Creating a custom save:
<pre>
"C:\Program Files\Factorio\bin\x64\Factorio.exe" --create stuff-seed123.zip --map-gen-settings map-gen-settings.json --map-gen-seed 123
</pre>

Generating a map preview:
<pre>
"C:\Program Files\Factorio\bin\x64\Factorio.exe" --generate-map-preview preview-seed123.png --map-gen-settings map-gen-settings.json --map-gen-seed 123
</pre>

==== Creating the JSON files from a map exchange string ====

It can be useful to create the initial JSON files from a known map exchange string instead of creating them from scratch. To convert the map exchange string to JSON, open the game and run the following command with your map exchange string:

/c helpers.write_file('map.txt', helpers.table_to_json(helpers.parse_map_exchange_string("<your exchange string here>")))

Then open the script_output folder in the [[user data directory]] and open map.txt - it will look like this:

{"map_settings":{ ...<MAP_SETTINGS> ... },"map_gen_settings":{ ...<MAP_GEN_SETTINGS>... }}

Copy the { ...<MAP_SETTINGS> ... } section into a new file called 'map-settings.json' in the desired location. Copy the { ...<MAP_GEN_SETTINGS> ... } section section into a new file called 'map-gen-settings.json' in the desired location.

== See also ==
* [[Console]]

{{C|Modding}}

Command line parameters

2025-01-25T12:32:02Z

SpeckledFleebeedoo: Update list of parameters to match Factorio 2.0.32

{{Languages}}__TOC__

Command line parameters can be used to set settings in the command line before the game launches, this is useful mainly for advanced users or server hosts.

{| class="wikitable"
|+General options
|-
| -h, --help
|
| display help
|-
| --version
|
| show version information
|-
| -v, --verbose
|
| enable verbose logging
|-
| -c, --config
| PATH
| config file to use
|-
| --no-log-rotation
|
| don't rotate log file
|-
| --mod-directory
| PATH
| Mod directory to use
|-
| --check-unused-prototype-data
|
| Print a warning for all prototype values that were not accessed.
|-
| --executable-path
| PATH
| Override autodetected __PATH__executable. Usually not needed except on very weird systems.
|}

{| class="wikitable"
|+ Running options
|-
| -s, --map2scenario
| arg
| map to scenario conversion
|-
| -m, --scenario2map
| arg
| scenario to map conversion
|-
| --apply-update
| arg
| immediately apply update package
|-
| --create
| FILE
| create a new map
|-
| --map-gen-settings
| FILE
| Map generation settings for use with --create, --start-server-load-scenario or --generate-map-preview. See data/map-gen-settings.example.json
|-
| --map-gen-seed
| SEED
| Map generation seed for use with --create, --start-server-load-scenario or --generate-map-preview. Will override seed specified in map gen settings
|-
| --map-gen-seed-max
| SEED
| Map generation seed for use with --generate-map-preview to generate multiple previews using every second seed in the interval from map-gen-seed to map-gen-seed-max.
|-
| --map-settings
| FILE
| Map settings for use with --create or --start-server-load-scenario. See data/base/prototypes/map-settings.lua
|-
| --preset
| arg
| Name of the map generation preset to be used.
|-
| --generate-map-preview
| PATH
| Generate preview images of the map; PATH should name a PNG file or end with a '/' or '\' to indicate a directory.
|-
| --generate-map-preview-random
| COUNT
| Number of maps to generate with a random seed using --generate-map-preview.
|-
| --map-preview-size
| SIZE
| Size (in pixels) of map preview (default: 1024)
|-
| --map-preview-offset
| X,Y
| Offset of the center of the map, in meters (default: 0,0)
|-
| --map-preview-planet
| PLANET
| Planet to generate the preview for (default: nauvis)
|-
| --report-quantities
| PROTOTYPE,...
| When generating map preview, report approximate quantities of the named entity prototypes
|-
| --threads
| THREADCOUNT
| Number of threads to use when generating map previews
|-
| --disable-migration-window
|
| Disables the gui that is shown when opening a save with migrated content
|-
| --instrument-mod
| arg
| Name of a mod to enable Instrument Mode
|-
| --sync-mods
| FILE
| Sync mods with save
|-
| --enable-unsafe-lua-debug-api
|
| Enables unsafe functions in the Lua debug library.
|-
| --host
| FILE
| Start hosting a multiplayer game
|-
| --host-interactive
| FILE
| Open multiplayer server settings for hosting the selecting save
|-
| --start-server
| FILE
| start a multiplayer server
|-
| --start-server-load-scenario
| [MOD/]NAME
| start a multiplayer server and load the specified scenario. The scenario is looked for inside the given mod. If no mod is given, it is looked for in the top-level scenarios directory.
|-
| --start-server-load-latest
|
| start a multiplayer server and load the latest available save
|-
| --until-tick
| TICK
| run a save until given map tick
|-
| --benchmark
| FILE
| load save and run benchmark
|-
| --benchmark-ticks
| N
| number of ticks for benchmarking. Default is 1000 (default: 1000)
|-
| --benchmark-runs
| N
| how often the number of ticks will be run, map will reload after each run. Default is 1 (default: 1)
|-
| --benchmark-verbose
| timings
| comma separated list of timings to output each tick. "all", "timestamp" as well as all other values seen in the debug view are allowed here. An empty string disabled verbose benchmarking. (default: )
|-
| --benchmark-sanitize
|
| only output the final benchmark results
|-
| --benchmark-ignore-paused
|
| leaves the game paused if it was paused when saved. By default the game is unpaused when a benchmark starts.
|-
| --output-perf-stats
| FILE
| path of file to which rendering performance statistics measurements should be saved. Special tags {api}, {hw}, {time} and {tag} will be replaced.
|-
| --dump-data
|
| dumps data.raw as JSON to the script output folder and exits.
|-
| --dump-icon-sprites
|
| dumps all icon sprites as png files to the script output folder and exits.
|-
| --dump-prototype-locale
|
| dumps all prototypes name and description (if they have a valid value) to the script output folder and exits.
|-
| --report-autogenerated-icon-mipmaps
|
| Report which icons will have generated mipmaps.
|-
| --log-shared-tile-layers
|
| After loading prototypes logs which tile layers are shared by multiple prototypes and lists the prototypes that share them.
|-
| --log-spritesheets-to-optimize
| N
| Logs N spritesheets that seem to have some nearly transparent noise, and could be made much smaller if the noise was cleaned up.
|-
| --mp-connect
| ADDRESS
| start factorio and connect to address
|-
| --password
| PASSWORD
| the password to use when using mp-connect (if any)
|-
| --heavy
|
| run the game in heavy mode if singleplayer with graphics
|-
| --load-game
| FILE
| start Factorio and load a game in singleplayer
|-
| --load-scenario
| [MOD/]NAME
| start Factorio and load the specified scenario in singleplayer. The scenario is looked for inside the given mod. If no mod is given, it is looked for in the top-level scenarios directory.
|-
| --benchmark-graphics
| FILE
| load save and run it with graphics for benchmark-ticks number of ticks as normal game would
|-
| --benchmark-frame
| FILE
| load save and benchmark graphics rendering of single frame (prepare + render) without updating the game
|-
| --debug-graphics
|
| enables debugging layer for graphics API. If DirectX is used DirectX SDK needs to be installed for this to work.
|-
| --fullscreen
|
| start game in windowed mode (saved to configuration)
|-
| --max-texture-size
| N
| maximal size of texture that the game can use (saved to configuration). Should be power of two greater than 2048
|-
| --graphics-quality
| arg
| accepted values: high, medium
|-
| --video-memory-usage
| arg
| accepted values: all, high, medium, low
|-
| --force-graphics-preset
| arg
| accepted values: very-low, low, mac-with-low-ram, medium-with-low-vram, medium, high, very-high, extreme
|-
| --gfx-safe-mode
|
| resets some graphics settings to values that should work on most configurations
|-
| --low-vram
|
| sprites that are not put into sprite atlases won't be allocated as texture objects
|-
| --shader
| arg
| enable/disable shader postprocessing (saved to configuration)
|-
| --disable-audio
|
| Disable audio. Mainly for faster startup during development.
|-
| --window-size
| arg
| Desired window resolution. For example "1680x1050". Or "maximized"
|-
| --single-thread-loading
|
| Disables loading of sprites in multiple threads.
|-
| --cache-sprite-atlas
|
| Enable/disable sprite atlas cache.
|-
| --nogamepad
|
| Disable gamepad(controller) support
|}

{| class="wikitable"
|+ Server options
|-
| --port
| N
| network port to use
|-
| --bind
| ADDRESS[:PORT]
| IP address (and optionally port) to bind to
|-
| --rcon-port
| N
| Port to use for RCON
|-
| --rcon-bind
| ADDRESS:PORT
| IP address and port to use for RCON
|-
| --rcon-password
| PASSWORD
| Password for RCON
|-
| --server-settings
| FILE
| Path to file with server settings. See data/server-settings.example.json
|-
| --use-server-whitelist
|
| If the whitelist should be used.
|-
| --use-authserver-bans
|
| Verify that connecting players are not banned from multiplayer and inform Factorio.com about ban/unban commands.
|-
| --server-whitelist
| FILE
| Path to file with server whitelist.
|-
| --server-banlist
| FILE
| Path to file with server banlist.
|-
| --server-adminlist
| FILE
| Path to file with server adminlist.
|-
| --console-log
| FILE
| Path to file where a copy of the server's log will be stored
|-
| --server-id
| FILE
| Path where server ID will be stored or read from
|}

=== Boolean options ===

Parameters shown above with a BOOL option must be formatted as <code>[parameter]=true</code> or <code>[parameter]=false</code>. For example,

--fullscreen=false

will start the game in windowed (not fullscreen) mode.

=== Multiplayer ===

--start-server SAVE

Will start a Headless (Dedicated) server, with no GUI.

--mp-connect ADDRESS
ADDRESS is the IP:port of the remote host. Port is optional.
Examples:

./factorio --mp-connect 192.168.1.101
./factorio --mp-connect 192.168.1.101:2345

As above, port can be specified by placing the port number after a colon in the address.

=== Creating a map from custom settings ===

Sometimes it's useful to create a new game with map and/or map generator settings stored in a JSON file rather than going through the in-game map settings screen.
One reason is that by editing the settings directly it is possible to set settings outside the range normally available from the GUI.

To do this, Factorio is run from the command-line, and a JSON file containing the map generator settings and a JSON file containing map settings (if customizing them) are needed.

Example for custom generator settings:
<pre>{
"terrain_segmentation": 0.5,
"water": "2",
"width": 0,
"height": 0,
"starting_area": "normal",
"peaceful_mode": false,
"autoplace_controls":
{
"coal": {"frequency": 1, "size": 2, "richness": 0.5},
"copper-ore": {"frequency": "low", "size": "normal", "richness": "high"},
"crude-oil": {"frequency": "normal", "size": "normal", "richness": "normal"},
"enemy-base": {"frequency": "normal", "size": "normal", "richness": "normal"},
"iron-ore": {"frequency": "normal", "size": "normal", "richness": "normal"},
"stone": {"frequency": "normal", "size": 0, "richness": "normal"},
"uranium-ore": {"frequency": "normal", "size": "none", "richness": "normal"}
},

"cliff_settings":
{
"name": "cliff",
"cliff_elevation_0": 30,
"cliff_elevation_interval": 20,
"richness": 1
},

"property_expression_names":
{
"elevation": "0_16-elevation",
"temperature": "35"
},

"seed": null
}
</pre>

Note that this is the same format as [https://lua-api.factorio.com/latest/concepts/MapGenSettings.html MapGenSettings] that are modifiable from Lua. Everything in the file is optional.

Creating a custom save:
<pre>
"C:\Program Files\Factorio\bin\x64\Factorio.exe" --create stuff-seed123.zip --map-gen-settings map-gen-settings.json --map-gen-seed 123
</pre>

Generating a map preview:
<pre>
"C:\Program Files\Factorio\bin\x64\Factorio.exe" --generate-map-preview preview-seed123.png --map-gen-settings map-gen-settings.json --map-gen-seed 123
</pre>

==== Creating the JSON files from a map exchange string ====

It can be useful to create the initial JSON files from a known map exchange string instead of creating them from scratch. To convert the map exchange string to JSON, open the game and run the following command with your map exchange string:

/c helpers.write_file('map.txt', helpers.table_to_json(helpers.parse_map_exchange_string("<your exchange string here>")))

Then open the script_output folder in the [[user data directory]] and open map.txt - it will look like this:

{"map_settings":{ ...<MAP_SETTINGS> ... },"map_gen_settings":{ ...<MAP_GEN_SETTINGS>... }}

Copy the { ...<MAP_SETTINGS> ... } section into a new file called 'map-settings.json' in the desired location. Copy the { ...<MAP_GEN_SETTINGS> ... } section section into a new file called 'map-gen-settings.json' in the desired location.

== See also ==
* [[Console]]

{{C|Modding}}

Enemies

2024-11-17T13:18:27Z

SpeckledFleebeedoo: /* Demolishers */ Add segment/tail resistances

{{Languages}}
{{Stub}}
[[File:biter_intro.png|175px|right]]'''Enemies''' are creatures that want to [[Damage|harm]] the [[player]]. They are the native inhabitants of the extraterrestrial worlds on which the player is operating. Enemies show up on the map as red dots.

On [[Nauvis]], the enemies are arthropods which live in organic nests. They are encountered in three species: Biters, Spitters, and Worms (though the nickname "Biters" is often used collectively for all of them).

More enemies can be encountered on other planets with the [[Space Age]] expansion. On the planet [[Gleba]]{{SA}}, there are three types: Wrigglers, Strafers, and Stompers. On the planet [[Vulcanus]]{{SA}}, there are the Demolishers.

Each species comes in a range of sizes, where larger specimens have more health and do more damage.

== Achievements ==
Enemies are directly connected to the following achievements:
{{Achievement|it-stinks-and-they-dont-like-it}}
{{Achievement|steamrolled}}
{{Achievement|art-of-siege}}
{{Achievement|keeping-your-hands-clean}}
{{Achievement|it-stinks-and-they-do-like-it}}
{{Achievement|get-off-my-lawn}}
{{Achievement|if-it-bleeds}}
{{Achievement|we-need-bigger-guns}}
{{Achievement|Size-doesnt-matter}}

==Creatures==
===Biters===
Biters are one of two main antagonists in the base game. They come in four sizes: small, medium, big and behemoth. In the beginning of a game, there will only be the small ones. With increasing [[pollution]], they will become bigger, related to the enemy's [[#Evolution|evolution]]. As common sense may suggest, their method of attack is a straightforward charge to "bite" things.

{| class="wikitable"
|-
! Picture !! Name !! Info
|-
| [[File:small_biter.png|center]] || Small Biter
| Weakest of biters, can be easily killed with a pistol.
* Planet: Nauvis
* Health: 15
* Damage: 7 Physical
* Attack speed: 1.71/s
* Speed: 43.2km/h
* Range: 1
* Pollution to join attack: 4
|-
| [[File:medium_biter.png|center]] || Medium Biter
| Stronger and slightly faster than the small biter. Can pose a problem for and even kill weaker players.
* Planet: Nauvis
* Health: 75
* Damage: 15 Physical
* Attack speed: 1.71/s
* Speed: 51.8km/h
* Range: 1
* Pollution to join attack: 20

[[Damage#Resistance|Resistances]]:
*Explosion: 0/10%
*Physical: 4/10%
|-
| [[File:big_biter.png|center]] || Big Biter
| Dangerous, resistant to small arms. Can attack through walls, hitting objects directly behind them.
* Planet: Nauvis
* Health: 375
* Damage: 30 Physical
* Attack speed: 1.71/s
* Speed: 49.7km/h
* Range: 2
* Pollution to join attack: 80

Resistances:
*Explosion: 0/10%
*Physical: 8/10%
|-
| [[File:behemoth_biter.png|center]] || Behemoth Biter
| Extremely durable and nearly immune to small arms, except for the strongest ordnance. Can attack through walls, hitting objects directly behind them.
* Planet: Nauvis
* Health: 3000
* Damage: 90 Physical
* Attack speed: 1.2/s
* Speed: 64.8km/h
* Range: 2
* Pollution to join attack: 400

Resistances:
*Explosion: 12/10%
*Physical: 12/10%

|}

===Spitters===
'''Spitters''' are much like [[Enemies#Biters|biters]] and only appear slightly later on in the game as the evolution factor increases. Their main difference from biters is their ranged attack. Using predictive aiming, they spit a stream of acid at enemies which leaves behind a puddle of acid where it hits the ground. Due to the spitters' predictive aiming, the acid stream can be dodged by suddenly changing walking directions or standing still.[https://factorio.com/blog/post/fff-279] Both the stream and the puddle of acid deal damage of time and slow down players and vehicles. Most entities of the game have a much lower resistance to acid than other damage types (including [[turret]]s and [[armor]]), so spitters are effectively more potent against the player and their factories. Their behavior and size classification are the same as with biters, but their health is universally lower and they are resistant exclusively against explosives, with no physical resistance.

{| class="wikitable"
|-
! Picture !! Name !! Info
|-
| [[File:small_spitter.png|center]] || Small Spitter
| Weakest of spitters. Easy to kill with any weapon, but attacks at range.
* Planet: Nauvis
* Health: 10
* Range: 13
* Pollution to join attack: 4
* Speed: 40.0km/h

Acid projectile:
* Attack speed: 0.6/s
* Area of effect size: 1
* Damage (on contact): 12 Acid

Acid puddle:
* Lifetime: 32 seconds
* Damage: 7.2 Acid/second
* Applies effect (on contact):
** Movement/vehicle speed modifier: 60%
** Duration: 2 seconds

|-
| [[File:medium_spitter.png|center]] || Medium Spitter
| Stronger and slower than the smaller version. Can pose a problem for and even kill weaker players.
* Planet: Nauvis
* Health: 50
* Range: 14
* Pollution to join attack: 12
* Speed: 35.6km/h

Acid projectile:
* Attack speed: 0.6/s
* Area of effect size: 1.25
* Damage (on contact): 24 Acid

Acid puddle:
* Lifetime: 32 seconds
* Damage: 28.8 Acid/second
* Applies effect (on contact):
** Movement/vehicle speed modifier: 50%
** Duration: 2 seconds

Resistances:
*Explosion: 0/10%
|-
| [[File:big_spitter.png|center]] || Big Spitter
| An even bulkier spitter and so can take more damage.
* Planet: Nauvis
* Health: 200
* Range: 15
* Pollution to join attack: 30
* Speed: 32.4km/h

Acid projectile:
* Attack speed: 0.6/s
* Area of effect size: 1.35
* Damage (on contact): 36 Acid

Acid puddle:
* Lifetime: 32 seconds
* Damage: 130 Acid/second
* Applies effect (on contact):
** Movement/vehicle speed modifier: 40%
** Duration: 2 seconds

Resistances:
*Explosion: 0/15%
|-
| [[File:behemoth_spitter.png|center]] || Behemoth Spitter
| The bulkiest of the spitters and so can take even more damage.
* Planet: Nauvis
* Health: 1500
* Range: 16
* Pollution to join attack: 200
* Speed: 32.4km/h

Acid projectile:
* Attack speed: 0.6/s
* Area of effect size: 1.75
* Damage (on contact): 60 Acid

Acid puddle:
* Lifetime: 32 seconds
* Damage: 360 Acid/second
* Applies effect (on contact):
** Movement/vehicle speed modifier: 30%
** Duration: 2 seconds

Resistances:
*Explosion: 0/30%
|}

===Worms===

The Worms are natural allies of biters and spitters and will attack the player if they get close enough with an attack similar to spitters'. They act like static [[turret]]s and will not follow attackers. They rely on high damage, great range and splash damage to keep the player away from the worms and the nests they protect, but either one of these advantages can be overcome. Unlike other enemies, they are also highly resistant to fire. They will spit acid at the player, which can also leave acidic puddles on the ground that can still damage players and vehicles, as well as slow them both down and leave a brief acidic, damaging effect for a few seconds. However, placed buildings and tiles are unaffected by the acid puddles, but still take damage normally by the acid projectile.

Worms come in 4 sizes, their power increasing with size. Like biters and spitters, behemoth, big and medium worms spawning is influenced by the evolution factor. Worms are only created during enemy expansion when a certain evolution factor requirement is fulfilled. This is 0.3 for the medium worm, 0.5 for the big worm and 0.9 for the behemoth worm. Below these evolution factors, worms can only be created by the map generation. In map generation, the game restricts higher tier worms behind the distance from the starting point. The further away the player goes from the starting area, the stronger the worms become.

{| class="wikitable"
|-
! Picture !! Name !! Info
|-
| [[File:Small worm.png|center]] || Small Worm
| A weak worm. It is still capable of killing the player unless it is targeted as priority.
* Health: 200
* Range: 25

Acid projectile:
* Attack speed: 0.66/s
* Area of effect size: 1.4
* Damage (on contact): 36 Acid

Acid puddle:
* Lifetime: 32 seconds
* Damage: 21.6 Acid/second
* Applies effect (on contact):
** Duration: 2 seconds
** Movement/vehicle speed modifier: 60%
|-
| [[File:Medium worm.png|center]] || Medium Worm
| Medium worms are dangerous to even more advanced players. They should be handled with care.
* Health: 400
* Range: 30

Acid projectile:
* Attack speed: 0.66/s
* Area of effect size: 1.55
* Damage (on contact): 48 Acid

Acid puddle:
* Lifetime: 32 seconds
* Damage: 57.6 Acid/second
* Applies effect (on contact):
** Duration: 2 seconds
** Movement/vehicle speed modifier: 50%

Resistances:
*Explosion: 5/15%
*Fire: 2/50%
*Physical: 5/0%
|-
| [[File:Big worm.png|center]] || Big Worm
| Big worms are not as much more dangerous as resilient. They are almost immune to common gunfire of any sort.
* Health: 750
* Range: 38

Acid projectile:
* Attack speed: 0.66/s
* Area of effect size: 1.75
* Damage (on contact): 72 Acid

Acid puddle:
* Lifetime: 32 seconds
* Damage: 259 Acid/second
* Applies effect (on contact):
** Duration: 2 seconds
** Movement/vehicle speed modifier: 40%

Resistances:
*Explosion: 10/30%
*Fire: 3/70%
*Physical: 10/0%
|-
| [[File:Behemoth worm.png|center]] || Behemoth Worm
| Behemoth worms are the most dangerous of worms. They are just as resilient as Big worms, with much greater range.
* Health: 750
* Range: 48

Acid projectile:
* Attack speed: 0.66/s
* Area of effect size: 2
* Damage (on contact): 96 Acid

Acid puddle:
* Lifetime: 32 seconds
* Damage: 691 Acid/second
* Applies effect (on contact):
** Duration: 2 seconds
** Movement/vehicle speed modifier: 30%

Resistances:
*Explosion: 10/30%
*Fire: 3/70%
*Physical: 10/0%
|}

{| class="wikitable"
|-
! Picture !! Description
|-
| [[File:worm.gif]] || A worm's attack animation.
|-
|}

===Wrigglers===
Wrigglers are the biter equivalents to the planet Gleba, as they are standard melee enemies. True to their name, they flail and squirm their digits to move around and attack. Much like how biters and spitters spawn from nests, wrigglers spawn from egg rafts. Destroying egg rafts will spawn a group of more premature wrigglers, which are wrigglers that slowly lose health over time until they die. Strafers can fire flying versions of premature wrigglers at their target. Killing strafers and stompers can summon even more premature wrigglers.

The wrigglers that spawn from the corpses of strafers and stompers will match the size of the larger enemy that was killed. For example, killing a small strafer or stomper will spawn small premature wriggers, while killing a medium strafer or stomper will spawn medium premature wrigglers.

{| class="wikitable"
|-
! Picture !! Name !! Info
|-
| [[File:wriggler_small.png|center]] || Small Wriggler
| The weakest and smallest of all wrigglers.
* Planet: Gleba
* Health: 100
* Damage: 3.75 Physical + 3.75 Poison
* Range: 1.1
* Speed: 34.6km/h

Resistances:
*Laser: 50%
|-
| [[File:wriggler_medium.png|center]] || Medium Wriggler
| Slightly stronger and faster than small wrigglers, and can still pose a threat for weaker players.
* Planet: Gleba
* Health: 150
* Damage: 5 Physical + 5 Poison
* Range: 1.4
* Speed: 38.9km/h

Resistances:
*Laser: 50%
|-
| [[File:wriggler_big.png|center]] || Big Wriggler
| The strongest and fastest of all wrigglers.
* Planet: Gleba
* Health: 250
* Damage: 8 Physical + 8 Poison
* Range: 1.8
* Speed: 43.2km/h

Resistances:
*Laser: 50%
|}

===Strafers===
Native to the planet Gleba, strafers are large yet scrawny five-legged pentapod creatures with the unique behavior of constantly circling around players while attacking them, rather than making a beeline straight for the player, unlike any other type of enemy in the game. They will fire flying premature wrigglers toward the player, essentially adding more enemies to the fight.

{| class="wikitable"
|-
! Picture !! Name !! Info
|-
| [[File:strafer_small.png|center]] || Small Strafer
| The weakest and smallest of all strafers.
* Planet: Gleba
* Health: 800
* Shooting speed: 0.5/s
* Range: 22.0
* Speed: 62.2km/h

Projectile:
*Range: 110
*Area of effect: 1
**Damage: 67.5 Explosive

Resistances:
*Laser: 50%
*Physical: 2/10%
|-
| [[File:strafer_medium.png|center]] || Medium Strafer
| Slightly stronger and faster than the small strafer.
* Planet: Gleba
* Health: 1400
* Shooting speed: 0.5/s
* Range: 25.0
* Speed: 77.8km/h

Projectile:
*Range: 125
*Area of effect: 1
**Damage: 90 Explosive

Resistances:
*Laser: 50%
*Physical: 2/10%
|-
| [[File:strafer_big.png|center]] || Big Strafer
| Strongest, fastest and most resilient of strafers.
* Planet: Gleba
* Health: 2400
* Shooting speed: 0.5/s
* Range: 28.0
* Speed: 98.3km/h

Projectile:
*Range: 140
*Area of effect: 1
**Damage: 144 Explosive

Resistances:
*Laser: 50%
*Physical: 2/10%
|}

===Stompers===
Native to the planet Gleba, stompers are extremely large, five-legged pentapod creatures with limbs that look similar to a starfish, and seem to have natural, jagged exoskeleton armor that provides high resistances to many types of damage. They are very powerful melee enemies that use their brute force to attack players by simply stomping toward them. Their large size and high damage can destroy buildings instantly. They will spawn premature wrigglers upon death.

{| class="wikitable"
|-
! Picture !! Name !! Info
|-
| [[File:stomper_small.png|center]] || Small Stomper
| The weakest and smallest of all stompers, but still powerful.
* Planet: Gleba
* Health: 3500
* Range: 5.8
* Speed: 43.0km/h

Acid splash:
*Lifetime: 32 seconds
*Applied effects (on contact):
**Duration: 2 seconds
**Movement speed: 60% speed
**Vehicle speed: 30% speed
*Damage (on contact): 1.5/s Acid
*Area of effect size: 1.58
**Damage: 0.5 Acid

Resistances:
*Impact: 80%
*Laser: 80%
*Physical: 2/50%
|-
| [[File:stomper_medium.png|center]] || Medium Stomper
| Larger and more dangerous version of a stomper.
* Planet: Gleba
* Health: 8000
* Range: 7.8
* Speed: 54.1km/h

Acid splash:
*Lifetime: 32 seconds
*Applied effects (on contact):
**Duration: 2 seconds
**Movement speed: 60% speed
**Vehicle speed: 30% speed
*Damage (on contact): 6/s Acid
*Area of effect size: 2.1
**Damage: 1 Acid

Resistances:
*Impact: 80%
*Laser: 80%
*Physical: 2/50%
|-
| [[File:stomper_big.png|center]] || Big Stomper
| Larger, fastest and most dangerously aggressive version of a stomper.
* Planet: Gleba
* Health: 15000
* Range: 10.4
* Speed: 68.5km/h

Acid splash:
*Lifetime: 32 seconds
*Applied effects (on contact):
**Duration: 2 seconds
**Movement speed: 60% speed
**Vehicle speed: 30% speed
*Damage (on contact): 15.36/s Acid
*Area of effect size: 2.8
**Damage: 1.6 Acid

Resistances:
*Impact: 80%
*Laser: 80%
*Physical: 2/50%
|}

=== Demolishers ===
Native to the planet Vulcanus, demolishers are horrendously large worm-like creatures that roam across the land and lava. Each individual demolisher patrols a defined territory, and building structures in their territory will disturb them and cause them to attack.

Demolishers have three types of offense. On physical contact they do high damage to the player, and instantly destroy buildings and cliffs. They release a smoke cloud that slows the player and damages any nearby bots. And at range, they cause explosions to erupt from the ground, Due to their high damage resistances and extremely fast health regeneration, killing them requires advanced and upgraded weaponry, or massive quantities of bullets.

Once killed, they leave behind remains similar to that of black volcanic rock, which contain [[tungsten ore]].
{| class="wikitable"
|-
! Picture !! Name !! Info
|-
| [[File:demolisher_small.png|center]] || Small Demolisher
| The weakest and smallest of demolishers, but still very destructive.
* Planet: Vulcanus
* Health: 30000
* Regeneration: 2400/s

Resistances:
*Electric: 20/20%
*Explosion: 60% (head), 99% (body)
*Fire: 100%
*Impact: 100%
*Laser: 100%
*Physical: 50% (head), 5/50% (body)
*Poison: 10% (head), 50% (body)
|-
| [[File:demolisher_medium.png|center]] || Medium Demolisher
| Larger and more dangerous version of a demolisher.
* Planet: Vulcanus
* Health: 100000
* Regeneration: 7800/s

Resistances:
*Electric: 20/20%
*Explosion: 60% (head), 99% (body)
*Fire: 100%
*Impact: 100%
*Laser: 100%
*Physical: 50% (head), 5/50% (body)
*Poison: 10% (head), 50% (body)
|-
| [[File:demolisher_big.png|center]] || Big Demolisher
| The largest and most dangerous creature in the game.
* Planet: Vulcanus
* Health: 300000
* Regeneration: 24000/s

Resistances:
*Electric: 20/20%
*Explosion: 60% (head), 99% (body)
*Fire: 100%
*Impact: 100%
*Laser: 100%
*Physical: 50% (head), 5/50% (body)
*Poison: 10% (head), 50% (body)
|}

=== Nests ===
Nests in the wild will have their max health increase with evolution factor exponentially, up to 10 times their starting health.

Biter and spitter nests can be captured by firing a [[capture bot rocket]] from a [[rocket launcher]] at a nest. After the nest is captured, it must be given [[bioflux]] to maintain and continuously create [[biter egg]]s. If the nest is not maintained, it will slowly lose 1 health per second, but when fed, it will gain 1 health per second.

{| class="wikitable"
|-
! Picture !! Name !! Description
|-
| [[File:biter_nest.png|center]] || Biter's nest
|
* Planet: Nauvis
* Health: 350 (additional health from evolution)

Resistances:
*Explosion: 5/15%
*Fire: 3/60%
*Physical: 2/15%
|-
| [[File:spitter_nest.png|center]] || Spitter's nest
|
* Planet: Nauvis
* Health: 350 (additional health from evolution)

Resistances:
*Explosion: 5/15%
*Fire: 3/60%
*Physical: 2/15%
|-
| [[File:egg_raft.png|center]] || Egg raft
|
* Planet: Gleba
* Spawns a horde of premature wrigglers when destroyed.
* Health: 500 (additional health from evolution)
|-
| [[File:egg_raft_small.png|center]] || Small egg raft
|
* Planet: Gleba
* Spawns a horde of premature wrigglers when destroyed.
* Health: 100 (additional health from evolution)

Resistances:
*Explosive: 5/15%
*Fire: 3/60%
*Physical: 2/15%
|}

=== Expansions ===
Every 4-60 minutes, a group of 5-20 biters/spitters will leave their base to create a new base which will consist of as many worms/nests as there are members in the group. This group will search for a suitable spot that's 3-7 chunks away from existing bases. The interval between enemy expansions is global, and the higher enemy evolution, the shorter the interval is on average. Furthermore, with higher evolution, the groups are bigger on average.

Once they have found a suitable spot, each biter/spitter in the group dies and forms a new nest or worm. Forming a new nest or worm will destroy anything that is in the way, which can include members of the expansion group. There is a delay between each member sacrificing itself for to create a worm/nest, so creating the new base from the expansion group can take quite a long time, depending on the group size. Medium worms are only formed if the current evolution is higher than 0.3, big worms only if the current evolution is higher than 0.5 and behemoth worms are only formed if current evolution is higher than 0.9. The game randomly chooses whether to form a new biter nest, spitter nest, small worm, or bigger worm if the evolution factor is high enough. [https://gist.github.com/Bilka2/aa88490c23124a6f214c02c73a368aa7]

==Defense==
[[File:kills_gui.png|thumb|220px|right|"Kills" tab on the [[production statistics]] screen.]]Nests spawn biters and spitters freely. However, biters and spitters will only aggressively engage the player's factory if the pollution cloud of the factory reaches a nest because pollution is consumed to send biters or spitters to join the next attack. Every 1 to 10 minutes (random) the mustered biters launch an attack. If not all biters have arrived at the rendezvous point by that time, they will wait up to an additional 2 minutes for stragglers. The attack then proceeds to their target over the shortest path possible, accounting for terrain, but not for player entities that could pose an obstacle (like [[wall]]s).

If there is a clear path somewhere around those obstacles, the biters will attempt to go around. If there is no clear passage or a clear passage would mean deviating too far from the original course, the biters will attack whatever is in their way to go through. This can be exploited to an extent; creating mazes at regular intervals along a barrier can direct the biters through a gauntlet not dissimilar to tower defense.

However, if a biter comes in proximity of a [[Military units and structures|military unit or structure]], it will prioritize these and attempt to immediately attack them instead, again trying to reach the new target over the shortest possible path with no too great detours, if possible.

==Evolution==
[[File:Evolution Biters.png|thumb|right|400px|Spawn chances of biters from biter spawners by evolution factor.]]
[[File:Evolution Spitters.png|thumb|right|400px|Spawn chances of spitters from spitter spawners by evolution factor.]]
[[File:Evolution Weights.png|thumb|right|400px|Weight graph of both spawners by evolution factor. The values shown are primarily for indicating when certain types start and stop spawning, for actual chances refer to the tables or other charts.]]
The evolution factor is a global variable that determines what kind of biters will be spawned. You can check the variable in the dev console via the following command (does not disable achievements):

/evolution

The evolution factor goes from 0 (not evolved at all) to 1 (maximal evolution). The evolution factor can only increase.

This command also provides percentages for the three sources; each one is the percent of the (unsquashed) total evolution that is contributed by that source.

Besides choosing what kind of biter will be spawned, the evolution factor also influences the spawning interval. This interval (<code>spawning_cooldown</code> in the <code>enemy-spawner</code> definition) is interpolated between 360 (0 evolution) and 150 (1 evolution) game ticks (= 6 to 2.5 seconds).

=== Methods of increasing ===

The evolution factor is increased by three kinds of events:

* The passage of time very slightly increases the evolution factor.
* The global [[Pollution|pollution production]] increases the evolution factor.
* Destroying [[Enemies#Nests|nests]] significantly increases the evolution factor.

The default settings are:

{| class="wikitable"
!Source per
!Variable in <code>enemy_evolution</code>
!Evolution increase
!Pollution equivalent
|-
| [[Time#Seconds|Second]] || <code>time_factor</code> || 0.000004 || 267/minute
|-
| Destroyed enemy spawner || <code>destroy_factor</code> || 0.002 || 2222
|-
| 1 Pollution unit || <code>pollution_factor</code> || 0.0000009 || 1
|}

These values can be set during [[Map_generator#Enemy|world generation]]: the values in the dialog box are multiplied by 10^-7 for time and pollution, and 10^-5 for spawner destruction. In game, they can be found in <code>game.map_settings.enemy_evolution</code>, though checking or modifying them is considered using cheats.

Pollution production is the total pollution produced by [[Pollution#Polluters|buildings]], not the pollution spreading on the map, so it is not reduced by trees or other absorbers.
e.g. : 10 boilers produce 300 pollution in one minute, raising the evolution factor by around 0.00027 in that minute.

After totaling up all the evolution from these sources, this quantity is squashed to fit in the range <code>[0, 1)</code> by applying <code>evolution_factor = total_evolution / (1 + total_evolution)</code>.

Equivalently, marginal increases in evolution are reduced by multiplying the increase by <code>(1 - evolution_factor)²</code>. So for instance destroying enemy spawners in the beginning of the game results in increase of evolution factor by 0.002 while doing this when the evolution factor is 0.5 the increase is only 0.0005.

This also means that the evolution factor approaches 1 asymptotically - generally, increases past 0.9 or so are ''very'' slow and the number never actually reaches 1.0.

{| class="wikitable"
!Evolution factor
!Pollution equivalent
!Appearance
|-
| 10% || 123k ||
|-
| 20% || 278k || Medium Biter
|-
| 25% || 370k || Small Spitter
|-
| 30% || 476k ||
|-
| 40% || 741k || Medium Spitter
|-
| 50% || 1.111M || Big Biter, Big Spitter
|-
| 60% || 1.667M ||
|-
| 70% || 2.592M ||
|-
| 80% || 4.444M ||
|-
| 90% || 10M || Behemoth Biter, Behemoth Spitter
|-
| 95% || 21M ||
|-
| 99% || 110M ||
|}

=== Spawn chances by evolution factor ===

The probability charts show the chances of each type of biter/spitter for each spawner at all evolution levels.

<div id="evoChecker"></div>

=== Advanced: Evolution factor components and computation ===
<div class="toccolours mw-collapsible mw-collapsed" style="width:calc(100%-400px); overflow:auto;">
This section has charts plotting the individual evolution factor components and discusses possibilities for manually estimating the evolution factor.
<div class="mw-collapsible-content">

[[File:Evolution_factor_by_time.png|400px|thumb|right|1. Single-component evolution factor increase with time]]
[[File:Evolution_factor_by_spawners.png|400px|thumb|right|2. Single-component evolution factor increase with destroyed spawners]]
[[File:Evolution_factor_by_pollution.png|400px|thumb|right|3. Single-component evolution factor increase with pollution]]

'''Notes'''

* Data from version 1.1.50.

* All charts end at approximately an evolution factor of 0.90.

* The calculation steps for time and spawner kills match those used by the game, so these charts should be accurate. The pollution chart assumes a pollution production of 1000 units per second, and due to the recursive nature of the chart values will slightly diverge at different pollution rates. The effect of this is negligible for any reasonable amount pollution production, however.

* Given that the game reports the actual evolution factor (console: <code>/evolution</code>) whenever the player wishes, these charts are intended primarily to help estimate the impact of planned base expansions and similar activities on the evolution factor's future development.

'''Comments'''

These charts (click to enlarge) represent the situation where each evolution factor component (time, pollution, destroyed spawners) is the ''only'' component contributing to the evolution factor in that entire game. They are therefore '''not realistic''', as in a typical game all three components will contribute, some at varying times and intensities.

Because of how contributions to the evolution factor (EF) are calculated (multiplied by <code>(1 - current EF)</code>), it is '''not''' possible to simply add the values indicated by these charts for a game's time passed, pollution generated, and / or spawners destroyed so far to retrieve the total evolution factor.

For example, if 24 hours have passed (single-component EF =~ 0.25), 200,000 pollution units were released (single-component EF =~ 0.15), and 400 spawners were destroyed (single-component EF =~ 0.45), the actual evolution factor will '''not''' be (0.25 + 0.15 + 0.45 =) ~0.85.

However, the evolution factor will always be '''less''' than the sum of all individual components as indicated by these charts, and '''at least''' as high as the highest individual component. Thus, using the values from above, the EF will be ''at least'' 0.35 and ''less than'' 0.85. A smarter approach is required to compute the current evolution factor.

'''Individual components'''

The individual components of evolution can be approximated from <code>/evolution</code>:

Given the evolution factor, the unsquashed evolution is <code>unsquashed = evolution_factor / (1 - evolution_factor)</code>. Multiply this by the percentage for a given component to get its approximate unsquashed contribution. Of course, total pollution and spawner kills can also be found on the [[Production_statistics|production statistics]] screen, and time passed can be found using the <code>/time</code> command, so it's not fully necessary.

The actual factors can be found in <code>game.forces.enemy.evolution_factor_by_time</code>, <code>...evolution_factor_by_killing_spawners</code>, and <code>...evolution_factor_by_pollution</code>, if you don't mind disabling achievements.

</div></div>

== Trivia ==
*Despite their drastically different origins, enemies from different planets will always act as allies against the player. They will even reside around each other's nests when not attacking players, even if the type of nest does not match that of the residing creature. Even demolishers will circle around nests without harming or destroying them. Since enemies only spawn on their respective planets, this is not normally seen in gameplay, unless these creatures are placed near each other in the [[map editor]].

== Gallery ==
<gallery widths=270px heights=140px>
File:player_near_enemy_nests.png|The player near some enemy nests and worms.
File:player_worms_acid.png|The player among acid puddles created by attacking worms.
File:player_attacked_by_biters.png|Both the player and some buildings getting attacked by biters.
File:enemy_nests_mapgen.png|Enemy nests seen in a map generation preview (deathworld setting).
File:turret_wall_biters.png|Line of gun turrets defending against biters.
File:titlescreen_enemies.png|Enemies seen at the title screen.
File:gleba_pentapods_preview.png|Pentapod enemies seen on Gleba.
File:Factorio_Space_Age_Player_Fighting_Stomper.png|A player fighting a stomper
File:demolisher_chases_player.png|A demolisher chases the player on Vulcanus.
</gallery>

== History ==
{{history|2.0.7|
* Wrigglers, strafers, stompers and demolishers have been added with the [[Space Age]]{{SA}} expansion.}}

{{history|0.17.0|
* Behemoth worm added.}}

{{history|0.15.0|
* Increased the damage, range, and health of worms.
* Decreased health and resist of Behemoth biters.}}

{{history|0.13.10|
* Biters and other units won't become aggressive as a result of friendly-fire.}}

{{history|0.13.0|
* Big and behemoth enemies now spawn 50% slower.
* Changed the way evolution factor approaches the maximum (1).
** The addition of evolution factor was changed from addition * (1 - evolution) to addition * (1 - evolution)^2
** This means that the progress gets more slower towards the high values.}}

{{history|0.12.26|
* Running biters over with a vehicle will now anger them in peaceful mode.}}

{{history|0.12.0|
* Updated sounds for enemies.}}

{{history|0.11.17|
* Items dropped by enemies([[Archive:alien artifact|*]]) are now collected automatically and from longer distances.}}

{{history|0.11.6|
* Range of spitters is now 15, less than turrets.}}

{{history|0.11.0|
* Spitters added.
* Drawing of enemies optimised, so adding new colors does not impact VRAM.
* Blood splashes on death are now procedural.}}

{{history|0.9.0|
* Turrets no longer search for enemies when none are near.
* Biters can no longer destroy the shipwreck in the 3rd new hope campaign.}}

{{history|0.8.1|
* Further improvement to enemy AI.}}

{{history|0.8.0|
* Decreased the range of medium worm from 25 to 20.}}

{{history|0.7.2|
* Biter AI improved.}}

{{history|0.7.1|
* Peaceful mode added for freeplay.}}

{{history|0.7.0|
* Enemy creepers were replaced by small, medium and big biters.
* Enemy turrets were replaced by small, medium and big shooting worms.
* Enemies move and attack in groups.
* Enemies wander around their base when they have nothing to do.
* Enemies call for help when attacked.
* Enemies can create new bases.
* Enemies can now destroy all player creations they find.}}

{{history|0.1.0|
* Introduced, called 'creepers'}}

== See also ==
* [[Damage]]
* [[Pollution]]

{{EnvironmentNav}}

Multiplayer

2024-11-14T20:08:17Z

SpeckledFleebeedoo: Clarify that headless build is for Linux servers only

{{Languages}}
[[File:players_colored_preview.png|190px|right]]In addition to being a single-player game, Factorio also supports multiplayer, allowing many [[player]]s to cooperate and assist each other, or work against each other in pvp. This page documents how to set up a multiplayer game, how to join one, and the Multiplayer Admin features for managing other users and the server. By default, multiplayer games run the CO-OP [[Game modes and options|freeplay scenario]] where all players work together to launch a rocket with a satellite into space. Other scenarios, including PvP maps, are available for download from the [https://forums.factorio.com/viewforum.php?f=36&sid=93d1fbe9336d31d6bac60847b6c97985 Maps and Scenarios forum].

== Setting Up a Multiplayer Game ==

[[File:multiplayer_game_night.png|thumb|250px|A multiplayer game.]]Multiplayer games can be joined, hosted while playing, or hosted by a dedicated server. Multiplayer games can be advertised to other players on the same LAN or worldwide.

To start playing a multiplayer game, select the Multiplayer button from the main menu. Then, choose one of these options to host and play:

* '''Host new game''': Specify the desired scenario, adjust the [[Map generator|map generator]] settings, and set the server visibility. The server visibility determines how your game will be advertised to other players. You can choose from:
** '''Public''': Your game will be listed on the public games list.
** '''Steam''': Enables or disables the "Join Game" feature through Steam.
** '''LAN''': Your game will be listed on your local network.
* '''Host saved game''': Pick a saved game from the list and set the server visibility as above.

To join an existing game, choose one of these options:

* '''Browse public games''': Search for and join any public game that meets your criteria.
* '''Browse LAN games''': Join any game that is hosted on your local network.
* '''Connect to address''': Join any game by entering the server’s IP address. This option is useful if the host does not use any server visibility.

Notes and tips:

* All game instances need the installation of ''exactly the same'' game-versions and mods.
* Factorio servers use port '''34197'''. The port can be changed in the [[Application directory|config]] file.
* Factorio uses '''UDP only'''. The game builds its own "reliable delivery" layer built on UDP to deal with packet loss and reordering issues.
** Make sure you configure your router's port forwarding correctly for port '''34197'''.
** Make sure your router does not [https://doc.pfsense.org/index.php/Static_Port randomize the source port] on packets outbound from '''34197'''. Some routers do this and require [https://forum.pfsense.org/index.php?PHPSESSID=3k4h9n5o2tksgqv910fknf7qt7&topic=142188.msg798594#msg798594 additional configuration] to prevent it.
** Make sure there is no firewall or anti-virus blocking the UDP-packets.
* The hard limit for the number of players is [https://forums.factorio.com/viewtopic.php?f=53&t=6481&p=50661#p50586 65,535]. However, practical limit for this is much lower, popular streamers have managed to get well over a hundred players.

=== Dedicated/Headless server ===

A dedicated (or headless) server can be started using the --start-server command line option. You can run factorio --help to get a list of all command-line arguments that Factorio accepts. Any version of the game can be run in headless mode, though for Linux servers it may be preferable to use the Headless version of the game, which does not include graphics to reduce download size. This can be found on the [https://www.factorio.com/download factorio.com Downloads page].

In the headless mode:
* Graphics are not initialized (faster start up, less memory usage, works on completely headless servers)
* Game starts immediately and loads a save given as a parameter to the command
* The server has no character in game
* Game is paused while there are no players connected (though this can be overridden using the no-auto-pause option in the server-settings.json)
* Saves the game on exit (and autosaves normally)

''0.13 onwards expects --start-server to be followed by a path to a save file.''

You will need to create your save file before you start the server, as the dedicated server REQUIRES a save file to be provided. This can easily be done using the --create command-line argument. For example:

<pre>
./bin/x64/factorio --create ./saves/my-save.zip # This creates a new save, as if by clicking the New Game button in the GUI
</pre>

<pre>
./bin/x64/factorio --start-server ./saves/my-save.zip # This starts a server that will host the file created on the previous line
</pre>

There are several JSON configuration files that factorio can make use of to change the server and map settings:
* '''map-gen-settings''' to set parameters used by the [[map generator]] such as width and height, ore patch frequency and size, etc.
* '''map-settings''' to control [[pollution]] spread, [[Enemies#Expansions|biter expansion]] and [[evolution]], and more
* '''server-settings''' which consolidated several command-line options into a single file
Example files for each of these parameters are included in the data subdirectory, and are also visible on Wube's github here: https://github.com/wube/factorio-data

The --map-gen-settings and --map-settings options must be used with the --create option when you create a new map. For example:
<pre>./bin/x64/factorio --create saves/my-save.zip --map-gen-settings my-map-gen-settings.json --map-settings my-map-settings.json</pre>

Starting the factorio server requires you to specify the location of the server-settings.json file. By default this is in the factorio data folder. For example to start factorio using the most recent saved map, you would run:

<pre>./bin/x64/factorio --start-server-load-latest --server-settings ./data/server-settings.json</pre>

On windows, it may be useful to start the server with a .bat file. The bat file should have the following content:

<pre>start /wait .\bin\x64\factorio.exe --start-server-load-latest --server-settings .\data\server-settings.json</pre>

Running a headless Windows server can prevent you from opening another instance of the game to play. This is resolved by running the batch file as an other user (Shift-Right Click the batch file to get that option). This allows you to run a server and a client on the same machine.

''See [[Command_line_parameters]] for more command line parameters.''

=== Setting up a Linux Factorio server ===

'''Note:''' Factorio now requires <tt>glibc</tt> version 2.18, but CentOS/RHEL 7 only ship with version 2.17 so this guide will no longer work without [https://forums.factorio.com/viewtopic.php?t=54654#p324493 manually compiling <tt>glibc</tt> 2.18].

This step-by-step guide has been verified on fresh CentOS 7 and RHEL 7 installs but should be applicable with little to no changes on most distributions.

The guide assumes you will install the headless server under '''/opt/factorio''', adjust paths according to your own setup. We will also suggest that you run the Factorio server as a separate user to harden security of your setup.

Note that there are two distinct packages for Linux that can be used to run a headless server. First is the usual Linux download, that contains the full game. The other is the special [https://www.factorio.com/download headless package]. The headless package does not contain any files irrelevant for a pure server, such as graphics and sounds. It is also not linked against libraries that may not be present on a server machine, such as Xlib, libGL or libasound. This option should be selected if running in a 3rd party hosted server.

This guide does not handle firewall/port forwarding since this can be done in various ways on Linux (make sure to read up how this is done as a Linux admin on your particular distribution)

==== Basic installation ====

* Download the selected package -- either full game or the headless package -- and upload the Linux tar.gz or tar.xz package to your server /tmp
* Extract the package in /tmp to /opt/factorio
<pre>
$cd /opt/

$sudo tar -xzf /tmp/factorio.tar.gz # Use the correct file name. It includes the factorio version number
$sudo tar -xJf /tmp/factorio.tar.xz # if you downloaded a .tar.xz file (ver 0.15.x)</pre>

* Add a new user to your system and assign ownership of the factorio dir to it (please, do not run as the root user, sudo may be needed)
<pre>
$useradd factorio
$chown -R factorio:factorio /opt/factorio</pre>

* Try the binary
<pre>
$su factorio
$/opt/factorio/bin/x64/factorio --start-server savename</pre>

As long as it fails saying it cannot find/open the savename.zip you are set! Just upload a save from your own computer and put it in the /opt/factorio/saves directory, or use the --create ./saves/newgame.zip argument.

=== How to list a server-hosted game on the matching server ===

In order to publish the game to the matching server, Factorio needs to be given some more information than just the save file location. These information are provided in a ''server settings file''.

To create a server settings file, look at the example file located in '''data/server-settings.example.json''' in the Factorio [[Application directory]]. The recommended way is to make a copy of this example file and edit the copy.

The following values can be changed:
; Name: This will be the name under which the server will be listed in the server browser
; Description: A description of your server. May contain up to 5000 characters. [https://factorio.com/blog/post/fff-304 MP server description]
; Tags: A list of game tags
; Max Players: Allows you to limit the number of players that can be connected to the server at the same time. If you want no limit, just set max_players to 0.
* Visibility for server browser: May be either public, LAN or hidden.
** Public: The server will appear in the public server list. This requires the login credentials below to be filled in.
** LAN: The server will not appear in the public server list, but will be available through the Play On LAN button
** Hidden: Clients will have to connect using the server's IP address
* User credentials using a username and password or authentication token (found on the factorio website or in the player-data.json): These are necessary if you wish to make the server public. Otherwise, they can be left empty.
** For security reasons it is recommended to use authentication token as this document is stored as plain text. Though it should be noted that an authentication token is a sensitive piece of information as well, and you are well-advised to keep it secret.
* Server Password
** Field name is game_password
* Whether to verify user identity
(There are additional values in v0.14 of factorio.)

=== Technical Implementation Details ===

Notes about some technical details surrounding multiplayer have been published by the development team in several Friday Facts blog posts:

* [http://www.factorio.com/blog/post/fff-76 Lock step architecture]
* [http://www.factorio.com/blog/post/fff-99 Client-server connections]
* [http://www.factorio.com/blog/post/fff-143 NAT punching, introduced in 0.13]

=== DNS SRV Records ===
Factorio supports [https://www.cloudflare.com/learning/dns/dns-records/dns-srv-record/ DNS SRV records] since 1.1.67.

This makes it easier to have multiple Factorio servers on a single host and allow users to connect to them with distinct subdomains instead of having to enter port numbers.

The service name is <code>_factorio</code> and it only supports <code>_udp</code> protocol.

'''Example:'''

<pre>
Domain: subdomain.domain.tld
IP: 192.0.2.2
Port: 10002

DNS records:
subdomain.domain.tld IN A 192.0.2.2
_factorio._udp.subomain.domain.tld IN SRV 0 0 10002 subomain.domain.tld.
</pre>

Now a Factorio client connecting to <code>subdomain.domain.tld</code> will actually connect to <code>subdomain.domain.tld:10002</code>

'''Example screenshot of config in Cloud Flare:'''

[[File:Screenshot of SRV record settings Cloudflare dashboard.png]]

'''Log Entries:'''

* Factorio will log a "DNS SRV lookup returned [...]" message when it found a SRV record for the given domain
* With verbose logging Factorio will also log "DNS SRV lookup for [domain] didn't return any usable records" when there's no SRV record

=== Miscellaneous Tips ===
* The key for [[Console|console commands]] is also used initiate chat in multiplayer. To execute a command instead of chatting, you need to type ''/c'' before the command. Commands executed are ''visible to all players''. Additionally, the multiplayer game must have been started with commands allowable for commands to work.
* Set the player's color using the command
/color r g b
r, g and b are for red, green and blue respectively (possible values are between 0 and 1, use [https://www.w3schools.com/colors/colors_converter.asp this site] to convert colors to rgb numbers).
* To give yourself admin access, you need to create a server-adminlist.json in the same directory as factorio-current.log. The file should contain a list of admins, like so: <code>[ "user1", "user2" ]</code>

This file will be created if you promote a player through the console.

== Joining a Multiplayer game ==

As of version 0.13, players no longer necessarily have to port-forward to play with others. Players may join each other through Steam, or by just the port-forwarded host.

Players wishing to join a game may do so in multiple ways:

* Joining by directly inputting a public IP and port into Factorio.
* Selecting the server from the active public server menu.
* Joining through Steam's services.
* Playing a local LAN game.

=== Joining by IP ===

To join a multiplayer game by IP, you will need to know the public IP of a valid server. You can find this through social media, websites, or by word of mouth. After acquiring the IP and port, simply go to play -> Multiplayer -> Connect to server, and provide all the information it asks for.

If the server has been set up correctly to accept public connections, you should be able to join the game.

=== Joining via server list ===

Factorio's devs keep a list of all public servers that declare themselves to the service, allowing players to join directly through Factorio. Most of these servers will be password-requiring, but many completely public servers can be connected to. To join via server list, go to Play -> Multiplayer -> Browse public games. Provide your Factorio.com login if asked, and a list of public servers will appear. Simply select one.

=== Joining through Steam ===

Steam provides a "game invite" system, simply use that to join. You can find more info about how to use steam in it's documentation. ''This is the most recommended way for the average player to use multiplayer with their friends, as it allows Steam to handle everything''.

=== Joining a local LAN game ===

If you have some friends on the same internet connection as you (in the same building or network), you may play a LAN game. Simply go to Play -> Multiplayer -> Play on LAN.

=== Connecting to a Server Behind NAT ===

Factorio requires that the server (in client-server mode) have a publicly accessible IP address or that all players are on the same LAN. If you are behind NAT, you must set up port forwarding ([[Multiplayer#Playing_over_LAN_.2F_Internet|see above]] for port number) or use virtual LAN software such as Hamachi or Evolve.

Multiplayer games will be launched in client-server mode (also [http://www.factorio.com/blog/post/fff-99 multiplayer forwarding] mode). In this mode, all clients send their network traffic to the server and the server forwards the traffic to the other clients. The advantage of this is that it allows games where some players are inside a LAN and others are outside. The disadvantage may be slightly more lag as packets must travel an extra hop (through the server).

* [https://forums.factorio.com/viewtopic.php?f=53&t=6393 Forwarding ports without logging into your router]
* [https://forums.factorio.com/viewtopic.php?f=53&t=7714 A guide for connecting with Evolve]
* [http://steamcommunity.com/sharedfiles/filedetails/?id=653628496 A guide for connecting with Hamachi]

== PvP ==

In PvP mode, players can be on different forces. Each force can have one (free-for-all) or more players (teams). Each force has its own independent research progression. Additionally, each force's [[Military units and structures]] will attack other players as enemies, unless a cease fire is set. Note that, depending on the scenario, cease fires may be unidirectional — setting a cease fire with an opposing force does not guarantee a cease fire from them in return.

To start a PvP game, you can select the 'PvP' scenario from the 'Play' menu, or download a custom scenario which also supports PvP.

After downloading a PvP scenario, you need to move it to your application directory, and create the multiplayer game using the scenario.

# Download the scenario and place the scenario directory in the ''scenarios'' directory within your [[user data directory]].
# Launch Factorio
# Click ''Play''
# Click ''Multiplayer''
# Click ''Scenario''
# Choose the PvP scenario you want and click ''Create''
# Choose latency and other settings, then click ''Play''
# Other players can now join the game

=== Forces ===

Forces can be manually created via the console. This allows any map/scenario to be used for PvP. This may not be as convenient as a pre-made PvP scenario, as there will be no way for players to turn on/off cease fires other than through the console.

Each created force has its own research progression and different forces may attack each other.

The console commands for setting up and controlling forces are below:

<pre>
game.create_force("Name")
--Creates the force "Name"

game.players["Player_name"].force = game.forces["Name"]
--Sets this player to the new force

game.forces["Name"].set_cease_fire("Other_force_name", true)
--Sets the new force ceasefire to the "other force"

game.forces["Name"].set_spawn_position({x = 10, y = 20}, game.surfaces[1])
--Sets the spawn position of the force

game.print(#game.forces)
--Prints the number of forces

for name, force in pairs (game.forces) do
game.print(name)
end
--Prints the name of all the forces
</pre>

The ability of players and entities belonging to one force to interact with structures belonging to another, non-friendly force is limited. However, some types of interactions are still possible:

;Manual pickup from belts
: Players can pick up items traveling along a transport belt that belongs to an opposing force. Note however that this can't be automated: Inserters will ''not'' take items from an opposing force's belts.
;Belt network connection
: Belts will connect to each other regardless of force membership, so it's possible to extend an opposing force's belt line, and items will flow to them. It is also possible to side-load into, and place items onto (with inserters) an opposing force's belt line.
;Fluid network connection
: Pipes (and storage tanks, and pumps, &c) will connect to each other regardless of force membership. For example, it's possible to pump fluids out of or into a storage tank belonging to an opposing force.
;Power leeching
: Players can draw power from an opposing force's electric network, by building structures inside the coverage area of a power pole belonging to an opposing force. Power poles that you build next to a power pole belonging to an opposing force will automatically connect to it, but will be impossible to connect or disconnect manually.

== History ==

=== Narrative history ===

Because of the potentially immense amount of activity on a map, the game engine utilizes a [https://www.factorio.com/blog/post/fff-76 lock step architecture]. All instances of the game run full simulations of the entire world and only player actions are transferred across the network.

Multiplayer games were introduced to Factorio with version 0.11.0. The only connection method available was peer-to-peer mode which meant every player had to be able to directly communicate with every other player. In version 0.12.4, a client-server mode of communication was introduced in which the server (either a dedicated one or the player who hosted the game) relays messages to all peers. This means that direct connection between all players is no longer necessary. As of version 0.13, P2P connecting is completely removed.

As of version 0.12.0, the game features "latency hiding" mechanics where the game simulates some of the player's actions locally to make some common interactions (such as moving the player's character) more fluid. Not every action is a part of latency hiding – most notably, car or train driving and shooting are not a part of it.

=== Version history ===

Maintainer note: The following history may not be fully up to date, or comprehensive. Factorio's multiplayer has undergone a great deal of small changes since its inception, however this history will provide a rough overview.

{{history|0.14.14|
* Added multiplayer server option "Autosave only on server".
* Deconstructing/canceling deconstruction sets the "last user" on an entity.
* Decreased the size of connection accept message with lot of mod which could help some people with 50+ mod multiplayer games.
}}

{{history|0.14.13|
* Reconnecting to multiplayer game that the player is already in (due to being dropped, most often) instantly closes the previous connection and connects the player.}}

{{history|0.14.11|
* Multiplayer user names can only consist of letters, and <code> -_. </code> characters.}}

{{history|0.14.10|
* Disabled 32bit (x86) multiplayer. All hosts and members must be running the 64bit (x86_64) version of the game.}}

{{history|0.14.8|
* More than 10 players in one game will reduce the rate the game is saved to the server.}}

{{history|0.14.6|
* Username is now set to username setting, not email.}}

{{history|0.14.5|
* Added AFK Auto kick interval to multiplayer host settings (with never as default).}}

{{history|0.14.3|
* When save of scenario is loaded in multiplayer, it's scenario is saved in user scenarios.
* Added <code>/time</code> command to print the current map age.
* Added option to host multiplayer game with scenario (it only had new game/load game there).
}}

{{history|0.14.2|
* Can specify limit of upload speed when hosting.}}

{{history|0.14.0|
* Server doesn't stop/slow down the game when some client is too slow, stops communicating or saves the game longer than the server.
* Players automatically quit game after 3 desyncs.
* Removed the option to enable/disable latency hiding, it is always on on clients (and off on the server).
}}

{{history|0.13.10|
* Server stdout messages now contain time stamps and message-type tags}}

{{history|0.13.2|
* Limit multiplayer player name to 60 characters.}}

{{history|0.13.0|
* Improved Multiplayer game UX
* Server games are published to the server and clients can browse existing games.
* Removed multiplayer peer-to-peer mode.
* Building sound is played also for other players in multiplayer.
}}

{{history|0.12.31|
* Human readable error notice when multiplayer connection wasn't successful. (https://forums.factorio.com/23132)
* Improved map download speed when connecting to multiplayer game.}}

{{history|0.12.30|
* Mod checksums are calculated when the game starts and are compared with other peers when joining a multiplayer game. This is to ensure everyone has exactly the same mod in order to prevent desyncs caused by local changes made to mod files.}}

{{history|0.12.28|
* Added --port to specify which network port the game should use, when hosting with --start-server or --mp-load-game.}}

{{history|0.12.27|
* The report of different mods when trying to connect to multiplayer game is now scroll-able when needed.
* Better message when the server leaves a multiplayer game}}

{{history|0.12.11|
* Added --no-auto-pause: When running as a server, --no-auto-pause will prevent stopping the game when no players are connected.}}

{{history|0.12.9|
* Added resume button to multiplayer game menu}}

{{history|0.12.7|
*New command line options for the headless server: --disallow-commands and --peer-to-peer}}

{{history|0.12.5|
* Multiplayer broadcast (heartbeats) is done via a single message when not using peer2peer.
* Further optimizations in size of the Multiplayer heartbeat (message sent every tick).
* LatencyState is suspended when player is killed (and waiting for respawn) in Multiplayer.
}}

{{history|0.12.4|
* Simple mechanism for multiplayer relaying via the server.
* Less annoying glitches when running and shooting in multiplayer with latency hiding.}}

{{history|0.12.0|
* Multiplayer latency hiding (gives impression that some common tasks are performed immediately)
* Factorio can run as a dedicated server without graphics.
* Basic PvP: New forces can now be created and merged back together; a cease-fire can be agreed upon between forces
* IPv6 support for multiplayer.
* DNS names can be used when connecting to multiplayer game.
* Player's logistic filters are now remembered after respawn in multiplayer
* Smaller multiplayer heartbeat packet size.
}}

{{history|0.11.19|
* Multiplayer dropping threshold is doubled during map upload / download.}}

{{history|0.11.17|
* Autosaves in multiplayer are performed at the same time by all clients (interval is set by hosting player).
* Progress bar is shown when non-responsive peers are about to be dropped from the game in the Multiplayer.
* Progress bar is shown when other peers in multiplayer are saving map.}}

{{history|0.11.16|
* Revived character (after dying in multiplayer) are placed on the spawn point instead of the center of the map.}}

{{history|0.11.2|
* Mods that don't affect game state are not needed to be synchronized when playing multiplayer game or replaying game.}}

{{history|0.11.0|
* Introduced}}

{{C|Main}}

Uranium cannon shell

2024-11-03T17:05:44Z

SpeckledFleebeedoo: /* History */ Add 2.0 stat changes

{{Languages}}{{:Infobox:Uranium cannon shell}}
The '''uranium cannon shells''' are an advanced ammunition type for the [[Tank]] along with [[explosive uranium cannon shell]]s. Once they are made available, they surpass their [[cannon shell|regular]] variant; their damage and [[Damage#Piercing_Power|piercing power]] is increased twofold. Since regular shells are still specifically required to manufacture uranium variants, any previously manufactured stockpile can be "upgraded" without waste.

While uranium cannon shells still deal an amount of explosive damage, it is only dealt on the directly hit target and it is also a much lower amount than what explosive shells deal; its primary damage outlet is physical and therefore better suited against [[Enemies#Worms|worms]], [[Enemies#Spawners|nests]] and large [[Enemies#Spitters|spitters]] for their lesser resistances against it. These shells also feature the greatest piercing power in the game that is reliable for anything but the largest enemies, even capable of destroying two nests in one shot.

== History ==
{{history|2.0.7|
* Lowered stack size of ammo from 200 to 100.
* Increased physical damage from 400 to 2000.
* Increased piercing power from 600 to 2200.
}}

{{History|0.15.0|
* Introduced}}

== See also ==
* [[Cannon shell]]
* [[Explosive uranium cannon shell]]
* [[Enemies]]
* [[Damage]]

{{CombatNav}}
{{C|Ammo}}

Infobox:Uranium cannon shell

2024-11-03T17:02:56Z

SpeckledFleebeedoo: Fix piercing power

{{Infobox
|used-as-ammo-by = Tank
|prototype-type = ammo
|internal-name = uranium-cannon-shell
|category = Combat
|image = uranium cannon shell explosion.png
|range = 30
|damage =2000 {{Translation|physical}}<br> 200 {{Translation|explosion}}
|damage-bonus ={{Translation|Piercing Power}}: 2200
|stack-size = 100
|recipe = Time, 12 + Cannon shell, 1 + Uranium-238, 1
|total-raw = Time, 20 + Explosives, 1 + Plastic bar, 2 + Steel plate, 2 + Uranium-238, 1
|required-technologies = Uranium ammo
|boosting-technologies = Physical projectile damage + Weapon shooting speed
|producers = Assembling machine + Player
}}<noinclude>
[[Category:Infobox page]]
</noinclude>

Infobox:Uranium cannon shell

2024-11-03T17:02:00Z

SpeckledFleebeedoo: Update stats for 2.0

{{Infobox
|used-as-ammo-by = Tank
|prototype-type = ammo
|internal-name = uranium-cannon-shell
|category = Combat
|image = uranium cannon shell explosion.png
|range = 30
|damage =2000 {{Translation|physical}}<br> 200 {{Translation|explosion}}
|damage-bonus ={{Translation|Piercing Power}}: 600
|stack-size = 100
|recipe = Time, 12 + Cannon shell, 1 + Uranium-238, 1
|total-raw = Time, 20 + Explosives, 1 + Plastic bar, 2 + Steel plate, 2 + Uranium-238, 1
|required-technologies = Uranium ammo
|boosting-technologies = Physical projectile damage + Weapon shooting speed
|producers = Assembling machine + Player
}}<noinclude>
[[Category:Infobox page]]
</noinclude>

Time

2024-10-26T12:14:28Z

SpeckledFleebeedoo: Specify planet this data is for

{{Languages}}__NOTOC__
[[File:clock_hi_res.png|80px|left]]
The concept of '''Time''' in Factorio is used for many different implements, most notably crafting time and game time.

== Crafting time and speed ==
When hovering over an item recipe, the player may see a clock symbol and a number. This is the amount of time needed to craft the item in seconds at crafting speed 1. The player always crafts at speed 1 while [[assembling machine]]s have different crafting speeds. [[Module]]s may also affect crafting time, either speeding it up or slowing it down for some other benefit. The player, when handcrafting, crafts with a multiplier of 1, so items that claim to take 10 seconds to craft will take 10 seconds, but an [[assembling machine 1]] with a multiplier of 0.5 will take 20 seconds. It is important to take this into consideration when creating setups with proper ratios.{{clear}}

== Ticks ==
The base unit of all time inside Factorio. When running at game speed 1, there should always be 60 ticks in every real-time second leading to the figure of 60 updates per second, short UPS. This means that 1 tick should ideally always take 1/60th of a real-time second (0.01667 seconds). However, it is possible to change the [http://lua-api.factorio.com/latest/LuaGameScript.html#LuaGameScript.speed game speed] using mods or console commands, so it is possible that ticks don't take 0.01667 real-time seconds. Furthermore, game speed will automatically slow down when the computer that is running the game is unable to do all needed calculations in the wanted 0.01667 real-time seconds. The "show-fps" [[debug mode|debug option]] allows to see the current UPS which can be used to estimate how long a tick currently takes.

== Seconds ==
As stated above, there should always be 60 ticks in every second, so 1 in-game second equals 60 in-game ticks. The 60 to 1 ratio is also applied when the game runs at lower speeds, so an in-game second can take longer than a real-time second.

== Days ==
[[File:day_night_comparison.png|thumb|270px|right|Juxtaposition of day and night.]]

An in-game day on [[Nauvis]] lasts 25200 ticks or 7 in-game minutes.

The light varies throughout the day in a cycle consisting of 4 phases:
{| class="wikitable"
! Phase Name !! Internal name !! Behaviour !! Time of day at start !! Time of day at end !! Duration (in ticks) || Duration (in seconds)
|-
|day || dawn ||fully light ||0.75 ||0.25 ||112600 ||210
|-
|sunset|| dusk ||darkening ||0.25 ||0.45 ||5040 ||84
|-
|night || evening ||fully dark ||0.45 ||0.55 ||2520 ||42
|-
|sunrise || morning ||lightening ||0.55 ||0.75 ||5040 ||84
|}

------------- day -------><----- sunset ----->< night -><----- sunrise ----><-------- day ------------

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

During sunset, the light level decreases linearly from fully light to fully dark. During sunrise, it increases linearly from dark to light. This linear slope does not necessarily apply to the values returned by [https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.darkness LuaSurface.darkness]. During night time, [[player]]s will passively activate their flashlights (or headlights if in a [[vehicle]]), and placed [[lamp]]s will turn on automatically if powered.

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

{{C|Main}}

Time

2024-10-26T12:11:40Z

SpeckledFleebeedoo: Update daytime duration for 2.0

{{Languages}}__NOTOC__
[[File:clock_hi_res.png|80px|left]]
The concept of '''Time''' in Factorio is used for many different implements, most notably crafting time and game time.

== Crafting time and speed ==
When hovering over an item recipe, the player may see a clock symbol and a number. This is the amount of time needed to craft the item in seconds at crafting speed 1. The player always crafts at speed 1 while [[assembling machine]]s have different crafting speeds. [[Module]]s may also affect crafting time, either speeding it up or slowing it down for some other benefit. The player, when handcrafting, crafts with a multiplier of 1, so items that claim to take 10 seconds to craft will take 10 seconds, but an [[assembling machine 1]] with a multiplier of 0.5 will take 20 seconds. It is important to take this into consideration when creating setups with proper ratios.{{clear}}

== Ticks ==
The base unit of all time inside Factorio. When running at game speed 1, there should always be 60 ticks in every real-time second leading to the figure of 60 updates per second, short UPS. This means that 1 tick should ideally always take 1/60th of a real-time second (0.01667 seconds). However, it is possible to change the [http://lua-api.factorio.com/latest/LuaGameScript.html#LuaGameScript.speed game speed] using mods or console commands, so it is possible that ticks don't take 0.01667 real-time seconds. Furthermore, game speed will automatically slow down when the computer that is running the game is unable to do all needed calculations in the wanted 0.01667 real-time seconds. The "show-fps" [[debug mode|debug option]] allows to see the current UPS which can be used to estimate how long a tick currently takes.

== Seconds ==
As stated above, there should always be 60 ticks in every second, so 1 in-game second equals 60 in-game ticks. The 60 to 1 ratio is also applied when the game runs at lower speeds, so an in-game second can take longer than a real-time second.

== Days ==
[[File:day_night_comparison.png|thumb|270px|right|Juxtaposition of day and night.]]

An in-game day lasts 25200 ticks or 7 in-game minutes.

The light varies throughout the day in a cycle consisting of 4 phases:
{| class="wikitable"
! Phase Name !! Internal name !! Behaviour !! Time of day at start !! Time of day at end !! Duration (in ticks) || Duration (in seconds)
|-
|day || dawn ||fully light ||0.75 ||0.25 ||112600 ||210
|-
|sunset|| dusk ||darkening ||0.25 ||0.45 ||5040 ||84
|-
|night || evening ||fully dark ||0.45 ||0.55 ||2520 ||42
|-
|sunrise || morning ||lightening ||0.55 ||0.75 ||5040 ||84
|}

------------- day -------><----- sunset ----->< night -><----- sunrise ----><-------- day ------------

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

During sunset, the light level decreases linearly from fully light to fully dark. During sunrise, it increases linearly from dark to light. This linear slope does not necessarily apply to the values returned by [https://lua-api.factorio.com/latest/LuaSurface.html#LuaSurface.darkness LuaSurface.darkness]. During night time, [[player]]s will passively activate their flashlights (or headlights if in a [[vehicle]]), and placed [[lamp]]s will turn on automatically if powered.

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

{{C|Main}}

Permissions

2024-08-29T18:59:18Z

SpeckledFleebeedoo: Add description for set behaviour mode

The permissions system provides control over what players are allowed to do while in a specific game. This system is most useful in [[multiplayer]], but may also be used in singleplayer. The permissions menu can be opened using the /permissions command. It is important to note that the permissions system is based on input actions, which are what gets sent from clients to the host. This means that some permissions don't prevent you from changing things that are client side, only that changing those things won't be reflected from the server's perspective.

== Overview ==
{| class="wikitable"
! Permission !! Description
|-
| Activate copy || Get a copy tool by pressing Ctrl + C or the copy button on the shortcut bar.
|-
| Activate cut || Get a cut tool by pressing Ctrl + X or the cut button on the shortcut bar.
|-
| Activate paste || Get a paste tool by pressing Ctrl + V or the paste button on the shortcut bar.
|-
| Add permission group || Create a new permission group in the permissions settings.
|-
| Add train station || Add a train station to a train schedule.
|-
| Admin action || Do anything that requires admin permissions, such as using commands like /ban or opening other players.
|-
| Alt reverse select area || Right click and hold Shift while using a selection tool.
|-
| Alt select area || Hold Shift when using a selection tool.
|-
| Alt select blueprint entities || Select blueprint while holding shift to skip the blueprint edit window.
|-
| Alternative copy || Copy while holding Shift to open a blueprint edit window.
|-
| Begin mining || Mine an entity
|-
| Begin mining terrain || Mine any tile (removing paving)
|-
| Build || Place an entity.
|-
| Build rail || Use the rail planner
|-
| Build terrain || Place any tile.
|-
| Cancel craft || Cancel items in the handcrafting queue
|-
| Cancel deconstruct || Cancel deconstruction plans by selecting entities/tiles marked for deconstruction with a deconstruction planner while holding Shift.
|-
| Cancel new blueprint || Exit out of the blueprint editing menu by pressing escape (X button still works).
|-
| Cancel research || Cancel ongoing research (Does not correctly show in research gui in singleplayer, research will appear cancelled but resumes as soon as window is closed)
|-
| Cancel upgrade || Cancel an entity upgrade created with the upgrade planner.
|-
| Change active character tab || ? (Switching between the crafting and logistics tabs when flat gui is enabled still works as normal)
|-
| Change active item group for crafting || ? (supposed to be the different recipe tabs in crafting menus)
|-
| Change active item group for filters || ? (supposed to be the different tabs in filter menus)
|-
| Change active quick bar || Change which quick bar row is selected (only affects server)
|-
| Change arithmetic combinator parameters || Make changes to any of the settings of arithmetic combinators.
|-
| Change decider combinator parameters || Make changes to any of the settings of decider combinators.
|-
| Change entity label || ?
|-
| Change item description || ?
|-
| Change item label || ?
|-
| Change multiplayer config || Use /config to edit the multiplayer settings.
|-
| Change picking state || Pick up items from the floor by holding F.
|-
| Change programmable speaker alert parameters || Change any of the programmable speaker's alert settings.
|-
| Change programmable speaker circuit parameters || Change the programmable speaker's "signal value is pitch" setting.
|-
| Change programmable speaker parameters || Change the programmable speaker's "Volume", "Global playback" and "Allow polyphony" settings.
|-
| Change riding state || Control any vehicle (getting in and out is still possible).
|-
| Change shooting state || Shoot at anything.
|-
| Change train stop station || Change the name of a train stop.
|-
| Change train wait condition || Add or remove wait conditions in a train schedule.
|-
| Change train wait condition data || Edit the contents of wait conditions in a train schedule.
|-
| Clear cursor || Clear the cursor by pressing Q.
|-
| Connect rolling stock || Connect multiple trains together using the "connect rolling stock" keybind.
|-
| Copy || Copy entities using the copy tool.
|-
| Copy entity settings || Copy the settings of an entity with Shift + RMB.
|-
| Copy opened blueprint || Make a copy of an opened blueprint using the "create copy of this" button.
|-
| Copy opened item || Make a copy of an opened item that is not a blueprint (i.e. planners) using the "create copy of this" button.
|-
| Craft || Handcraft recipes from your inventory.
|-
| Cursor split || Pick up half a stack of items from an inventory by right clicking it.
|-
| Cursor transfer || Pick up a stack of items from an inventory by clicking it.
|-
| Custom input || Use custom inputs defined by mods.
|-
| Cycle blueprint book backwards || Cycle through the blueprints in a blueprint book in reverse order with Shift + Scroll.
|-
| Cycle blueprint book || Cycle through the blueprints in a blueprint book by scrolling.
|-
| Deconstruct || Mark items for deconstruction using a deconstruction planner.
|-
| Delete blueprint library || Delete a blueprint that is placed in the player's personal blueprint library. (Taking the blueprint out and then deleting it still works.)
|-
| Delete blueprint record || Delete a blueprint that is placed in the Game blueprints menu. (Taking the blueprint out and then deleting it still works.)
|-
| Delete custom tag || Delete a custom tag that has been placed on the map.
|-
| Delete permission group || Delete a permission group in the permission setting.
|-
| Destroy item || Ctrl + MMB in the editor to delete an item.
|-
| Destroy opened item || Destroy a blueprint or planner that is opened using the Destroy button.
|-
| Disconnect rolling stock || Disconnect wagons using the "disconnect rolling stock" keybind.
|-
| Drag train schedule || Rearrange stations in a train schedule by dragging them.
|-
| Drag train wait condition || Rearrange wait conditions in a train schedule by dragging them.
|-
| Drop blueprint record || Drop a blueprint from your blueprint library onto the ground by pressing Z.
|-
| Drop item || Drop an item onto the floor by pressing Z.
|-
| Edit blueprint tool preview || Edit the name, icon or description fields of a blueprint.
|-
| Edit custom tag || Edit a custom tag that has been placed on the map.
|-
| Edit permission group || Edit the settings for an existing permission group in the permissions settings.
|-
| Export blueprint || Export a blueprint to a blueprint string.
|-
| Fast entity split || Fast transfer half a stack of items to an entity by holding a stack and pressing Ctrl + RMB.
|-
| Fast entity transfer || Fast transfer a stack of items to an entity by holding a stack and pressing Ctrl + LMB.
|-
| Flush opened entity fluid || Flush fluids from a specific entity.
|-
| Flush opened entity specific fluid || Flush fluids from a connected fluid network.
|-
| Go to train station || Send a train to a specific station in its schedule. (Temporary stops still work)
|-
| Grab blueprint record || Take blueprints out of the blueprint library. (Copying still works)
|-
| Gui checked state changed || Toggle check boxes in modded GUIs
|-
| Gui click || Click elements in modded GUIs.
|-
| Gui confirmed || Press E to confirm modded GUIs.
|-
| Gui elem changed || Change a button's selected element in modded GUIs.
|-
| Gui hover || Hover over elements in modded GUIs.
|-
| Gui leave || Stop hovering over elements in modded GUIs.
|-
| Gui location changed || Drag modded GUIs around the screen.
|-
| Gui selected tab changed || Select tabs of tabbed panes in modded GUIs.
|-
| Gui selection state changed || Change dropdowns or list boxes in modded GUIs.
|-
| Gui switch state changed || Toggle switches in modded GUIs.
|-
| Gui text changed || Edit textboxes or textfields in modded GUIs.
|-
| Gui value changed || Change sliders in modded GUIs.
|-
| Import blueprint || ? (May only work in multiplayer?)
|-
| Import blueprint string || Import blueprints using the import blueprint string menu.
|-
| Import blueprints filtered || ? (multiplayer importing blueprints by getting them from the library as client?)
|-
| Import permissions string || Import a permissions string in the permissions settings.
|-
| Inventory split || Quick transfer half of all items or all items of a specific kind to another inventory with Ctrl + RMB
|-
| Inventory transfer || Quick transfer all items or all items of a specific kind from one inventory to another with Ctrl + LMB
|-
| Launch rocket || Launch a rocket from the rocket silo
|-
| Lua shortcut || Use a modded shortcut from the bottom right buttons.
|-
| Map editor action || Use any of the features of the map editor (opening it is still possible).
|-
| Market offer || Interact with the market entity.
|-
| Mod settings changed || Change any mod settings.
|-
| Open achievements gui || Open the Achievements menu.
|-
| Open blueprint library gui || Open the blueprint library.
|-
| Open blueprint record || Open the blueprint edit menu for any blueprint in the blueprint library.
|-
| Open bonus gui || Open the bonuses menu.
|-
| Open character gui || Open the character inventory/crafting menu
|-
| Open current vehicle gui || Open the gui of the currently driven vehicle with the button at the bottom-left of the screen.
|-
| Open equipment || Open the menus of individual personal equipment items. (No openable equipment exists in vanilla)
|-
| Open gui || Open any entity menus.
|-
| Open item || Open the editing menus of blueprints and planners.
|-
| Open logistic gui || Open the logistic networks menu.
|-
| Open mod item || ?
|-
| Open parent of opened item || Directly open the parent inventory of items such as blueprint books.
|-
| Open production gui || Open the production statistics menu.
|-
| Open technology gui || Open the tech tree menu.
|-
| Open tips and tricks gui || Open the tips and tricks menu.
|-
| Open train gui || Open the trains overview menu.
|-
| Paste entity settings || Paste the settings of an entity with Shift + LMB.
|-
| Place equipment || Place personal equipment into equipment grids.
|-
| Quick bar pick slot || Select items placed on the quick bar.
|-
| Quick bar set selected page || Change the selected quick bar page.
|-
| Quick bar set slot || Reassign a quick bar slot to hold a new item. (Assigning items to empty slots is still possible)
|-
| Reassign blueprint || Select new contents for a blueprint.
|-
| Remove cables || Remove cables from power boles using Shift + LMB.
|-
| Remove train station || Remove stations from train schedules.
|-
| Reset assembling machine || Remove the recipe from an assembling machine.
|-
| Reset item || Reset items such as spidertron remotes.
|-
| Reverse select area || Right click while using a selection tool.
|-
| Rotate entity || Rotate already placed entities.
|-
| Select area || Left click while using a selection tool.
|-
| Select blueprint entities || Select entities to include in a blueprint.
|-
| Select entity slot || Set entity filters in deconstruction planners.
|-
| Select item || ? (something to do with spidertrons)
|-
| Select mapper slot || Set upgrade filters in upgrade planners.
|-
| Select next valid gun || Switch between weapons by pressing Tab.
|-
| Select tile slot || Set tile filters in deconstruction planners.
|-
| Send spidertron || Use the remote control to send a spidertron somewhere.
|-
| Set auto launch rocket || Set a rocket silo to automatically launch rockets.
|-
| Set autosort inventory || Change the "always keep the player's main inventory sorted" setting. (Setting will still change, but the change has no effect.)
|-
| Set behaviour mode || Change the "read hand mode" or "read content mode" on inserters and belts.
|-
| Set car weapons control || Change who has control of the weapons in a car when there are multiple people on board.
|-
| Set circuit condition || Change the enabled condition settings on any circuit connected entities.
|-
| Set circuit mode of operation || Change the mode of operation settings on any circuit controlled entities.
|-
| Set controller logistic trash filter item || Change the maximum count for a personal logistic request.
|-
| Set deconstruction item trees and rocks only || Change the deconstruction planner's "trees/rocks only" checkbox.
|-
| Set entity color || Change the color of any entity that supports this.
|-
| Set entity energy property || Change the settings on an electric energy interface (editor only item).
|-
| Set entity logistic trash filter item || Change the maximum count for an entity's logistic request.
|-
| Set filter || Filter inventory slots to a specific item.
|-
| Set flat controller gui || ? (does not affect changing to/from flat character gui)
|-
| Set heat interface mode || Set the mode of a heat interface (editor only item).
|-
| Set heat interface temperature || Set the temperature on a heat interface (editor only item).
|-
| Set infinity container filter item || Change the filters on infinity chests (editor only item)
|-
| Set infinity container remove unfiltered items || Change the remove unfiltered items setting on infinity chests (editor only item).
|-
| Set infinity pipe filter || Set the fluid type on an infinity pipe (editor only item).
|-
| Set inserter max stack size || Change the stack size limit on inserters.
|-
| Set inventory bar || Set the inventory limit in chests or other inventories.
|-
| Set linked container link ID || Change which network linked chests are connected to (editor only item).
|-
| Set logistic filter item || Change any personal logistics request filters.
|-
| Set logistic filter signal || Change output signals on constant combinators.
|-
| Set player color || Change the color of the player's character.
|-
| Set recipe notifications || Change whether new recipes are marked as new in the crafting menu.
|-
| Set request from buffers || Change the "request from buffer chests" setting on requester chests.
|-
| Set research finished stops game || Set whether the technology tree opens automatically after finishing a research.
|-
| Set signal || ? (not setting signals in circuit connected entities)
|-
| Set splitter priority || Change the priority settings on splitters.
|-
| Set train stopped || Toggle trains between manual and automatic modes.
|-
| Set trains limit || Change the train limit setting on train stops.
|-
| Set vehicle automatic targeting parameters || Change the automatic targeting settings on autonomous vehicles such as the spidertron.
|-
| Setup assembling machine || Set the recipe on assembling machines that do not have a recipe set.
|-
| Setup blueprint || Create a blueprint from the blueprint edit menu.
|-
| Setup single blueprint record || ?
|-
| Smart pipette || Smart pipette functions such as selecting a miner when using the pipette on ore.
|-
| Spawn item || ? (something to do with modded shortcuts that spawn items?)
|-
| Stack split || Transfer half a stack of items to another inventory with Shift + RMB.
|-
| Stack transfer || Transfer a stack of items to another inventory with Shift + LMB.
|-
| Start repair || Repair entities using a repair pack.
|-
| Start research || Start new research in the tech tree menu.
|-
| Start walking || Walk around.
|-
| Stop building by moving || ?
|-
| Switch connect to logistic network || Connect or disconnect machines from the logistic network.
|-
| Switch constant combinator state || Toggle constant combinators on or off.
|-
| Switch inserter filter mode state || Switch between blacklist and whitelist on filter inserters.
|-
| Switch power switch state || Toggle power switches on or off.
|-
| Switch to rename stop gui || Open the rename train stop menu by clicking the pencil icon next to the stop name.
|-
| Take equipment || Remove equipment from an equipment grid.
|-
| Toggle deconstruction item entity filter mode || Toggle the "entities only" switch on deconstruction planners.
|-
| Toggle deconstruction item tile filter mode || Toggle the "tiles only" switch on deconstruction planners.
|-
| Toggle driving || Enter or exit vehicles.
|-
| Toggle enable vehicle logistic requests || Toggle logistic requests of vehicles on or off.
|-
| Toggle entity logistic requests || Toggle personal logistics and auto-trash on or off for entities.
|-
| Toggle equipment movement bonus || Toggle exoskeletons on or off.
|-
| Toggle map editor || Open or close the map editor.
|-
| Toggle personal logistic requests. || Toggle personal logistic requests on or off.
|-
| Toggle personal roboport || Toggle personal roboports on or off.
|-
| Toggle show entity info || Toggle "alt mode".
|-
| Translate string || ? (possibly something to do with the API translating for mods)
|-
| Undo || Undo the previous action with Ctrl + Z.
|-
| Upgrade || Apply an upgrade using the upgrade planner.
|-
| Upgrade opened blueprint by item || Apply a pre-existing upgrade planner to an open blueprint.
|-
| Upgrade opened blueprint by record || Apply a default upgrade planner to an open blueprint.
|-
| Use artillery remote || Use the artillery remote to target artillery.
|-
| Use item || Use consumable items such as capsules.
|-
| Wire dragging || Manually place circuit network wires.
|-
| Write to console || Allow use of chat/console.
|}

Permissions

2024-08-15T18:03:05Z

SpeckledFleebeedoo: Fix table

The permissions system provides control over what players are allowed to do while in a specific game. This system is most useful in [[multiplayer]], but may also be used in singleplayer. The permissions menu can be opened using the /permissions command.

== Overview ==
{| class="wikitable"
! Permission !! Description
|-
| Activate copy || Get a copy tool by pressing Ctrl + C or the copy button on the shortcut bar.
|-
| Activate cut || Get a cut tool by pressing Ctrl + X or the cut button on the shortcut bar.
|-
| Activate paste || Get a paste tool by pressing Ctrl + V or the paste button on the shortcut bar.
|-
| Add permission group || Create a new permission group in the permissions settings.
|-
| Add train station || Add a train station to a train schedule.
|-
| Admin action || ? (Presumably execute /c commands or player management?)
|-
| Alt reverse select area || ?
|-
| Alt select area || ?
|-
| Alt select blueprint entities || Select blueprint while holding shift to skip the blueprint edit window.
|-
| Alternative copy || Copy while holding Shift to open a blueprint edit window.
|-
| Begin mining || Mine an entity
|-
| Begin mining terrain || Mine any tile (removing paving)
|-
| Build || Place an entity.
|-
| Build rail || Use the rail planner
|-
| Build terrain || Place any tile.
|-
| Cancel craft || Cancel items in the handcrafting queue
|-
| Cancel deconstruct || Cancel deconstruction plans by selecting entities/tiles marked for deconstruction with a deconstruction planner while holding Shift.
|-
| Cancel new blueprint || Exit out of the blueprint editing menu by pressing escape (X button still works).
|-
| Cancel research || Cancel ongoing research (Does not correctly show in research gui in singleplayer, research will appear cancelled but resumes as soon as window is closed)
|-
| Cancel upgrade || Cancel an entity upgrade created with the upgrade planner.
|-
| Change active character tab || ? (Switching between the crafting and logistics tabs when flat gui is enabled still works as normal)
|-
| Change active item group for crafting || ?
|-
| Change active item group for filters || ?
|-
| Change active quick bar || ? (Editing quickbars, cycling through them and switching them still works as normal)
|-
| Change arithmetic combinator parameters || Make changes to any of the settings of arithmetic combinators.
|-
| Change decider combinator parameters || Make changes to any of the settings of decider combinators.
|-
| Change entity label || ?
|-
| Change item description || ?
|-
| Change item label || ?
|-
| Change multiplayer config || ?
|-
| Change picking state || Pick up items from the floor by holding F.
|-
| Change programmable speaker alert parameters || Change any of the programmable speaker's alert settings.
|-
| Change programmable speaker circuit parameters || Change the programmable speaker's "signal value is pitch" setting.
|-
| Change programmable speaker parameters || Change the programmable speaker's "Volume", "Global playback" and "Allow polyphony" settings.
|-
| Change riding state || Control any vehicle (getting in and out is still possible).
|-
| Change shooting state || Shoot at anything.
|-
| Change train stop station || Change the name of a train stop.
|-
| Change train wait condition || Add or remove wait conditions in a train schedule.
|-
| Change train wait condition data || Edit the contents of wait conditions in a train schedule.
|-
| Clear cursor || Clear the cursor by pressing Q.
|-
| Connect rolling stock || Connect multiple trains together using the "connect rolling stock" keybind.
|-
| Copy || Copy entities using the copy tool.
|-
| Copy entity settings || Copy the settings of an entity with Shift + RMB.
|-
| Copy opened blueprint || Make a copy of an opened blueprint using the "create copy of this" button.
|-
| Copy opened item || Make a copy of an opened item that is not a blueprint (i.e. planners) using the "create copy of this" button.
|-
| Craft || Handcraft items.
|-
| Cursor split || Pick up half a stack of items from an inventory by right clicking it.
|-
| Cursor transfer || Pick up a stack of items from an inventory by clicking it.
|-
| Custom input || Use custom inputs defined by mods.
|-
| Cycle blueprint book backwards || Cycle through the blueprints in a blueprint book in reverse order with Shift + Scroll.
|-
| Cycle blueprint book || Cycle through the blueprints in a blueprint book by scrolling.
|-
| Deconstruct || Mark items for deconstruction using a deconstruction planner.
|-
| Delete blueprint library || Delete a blueprint that is placed in the player's personal blueprint library. (Taking the blueprint out and then deleting it still works.)
|-
| Delete blueprint record || Delete a blueprint that is placed in the Game blueprints menu. (Taking the blueprint out and then deleting it still works.)
|-
| Delete custom tag || Delete a custom tag that has been placed on the map.
|-
| Delete permission group || Delete a permission group in the permission setting.
|-
| Destroy item || ?
|-
| Destroy opened item || Destroy a blueprint or planner that is opened using the Destroy button.
|-
| Disconnect rolling stock || Disconnect wagons using the "disconnect rolling stock" keybind.
|-
| Drag train schedule || Rearrange stations in a train schedule by dragging them.
|-
| Drag train wait condition || Rearrange wait conditions in a train schedule by dragging them.
|-
| Drop blueprint record || ?
|-
| Drop item || Drop an item onto the floor by pressing Z.
|-
| Edit blueprint tool preview || Edit the name, icon or description fields of a blueprint.
|-
| Edit custom tag || Edit a custom tag that has been placed on the map.
|-
| Edit permission group || Edit the settings for an existing permission group in the permissions settings.
|-
| Export blueprint || Export a blueprint to a blueprint string.
|-
| Fast entity split || Fast transfer half a stack of items to an entity by holding a stack and pressing Ctrl + RMB.
|-
| Fast entity transfer || Fast transfer a stack of items to an entity by holding a stack and pressing Ctrl + LMB.
|-
| Flush opened entity fluid || Flush fluids from a specific entity.
|-
| Flush opened entity specific fluid || Flush fluids from a connected fluid network.
|-
| Go to train station || Send a train to a specific station in its schedule. (Temporary stops still work)
|-
| Grab blueprint record || Take blueprints out of the blueprint library. (Copying still works)
|-
| Gui checked state changed || ?
|-
| Gui click || ?
|-
| Gui confirmed || ?
|-
| Gui elem changed || ?
|-
| Gui hover || ?
|-
| Gui leave || ?
|-
| Gui location changed || ?
|-
| Gui selected tab changed || ?
|-
| Gui selection state changed || ?
|-
| Gui switch state changed || ?
|-
| Gui text changed || ?
|-
| Gui value changed || ?
|-
| Import blueprint || ? (May only work in multiplayer?)
|-
| Import blueprint string || Import blueprints using the import blueprint string menu.
|-
| Import blueprints filtered || ?
|-
| Import permissions string || Import a permissions string in the permissions settings.
|-
| Inventory split || Quick transfer half of all items or all items of a specific kind to another inventory with Ctrl + RMB
|-
| Inventory transfer || Quick transfer all items or all items of a specific kind from one inventory to another with Ctrl + LMB
|-
| Launch rocket || Launch a rocket from the rocket silo
|-
| Lua shortcut || ?
|-
| Map editor action || Use any of the features of the map editor (opening it is still possible).
|-
| Market offer || Interact with the market entity.
|-
| Mod settings changed || Change any mod settings.
|-
| Open achievements gui || Open the Achievements menu.
|-
| Open blueprint library gui || Open the blueprint library.
|-
| Open blueprint record || Open the blueprint edit menu for any blueprint in the blueprint library.
|-
| Open bonus gui || Open the bonuses menu.
|-
| Open character gui || Open the character inventory/crafting menu
|-
| Open current vehicle gui || Open the gui of the currently driven vehicle with the button at the bottom-left of the screen.
|-
| Open equipment || Open the menus of individual personal equipment items. (No openable equipment exists in vanilla)
|-
| Open gui || Open any entity menus.
|-
| Open item || Open the editing menus of blueprints and planners.
|-
| Open logistic gui || Open the logistic networks menu.
|-
| Open mod item || ?
|-
| Open parent of opened item || Directly open the parent inventory of items such as blueprint books.
|-
| Open production gui || Open the production statistics menu.
|-
| Open technology gui || Open the tech tree menu.
|-
| Open tips and tricks gui || Open the tips and tricks menu.
|-
| Open train gui || Open the trains overview menu.
|-
| Paste entity settings || Paste the settings of an entity with Shift + LMB.
|-
| Place equipment || Place personal equipment into equipment grids.
|-
| Quick bar pick slot || Select items placed on the quick bar.
|-
| Quick bar set selected page || ?
|-
| Quick bar set slot || Reassign a quickbar slot to hold a new item. (Assigning items to empty slots is still possible)
|-
| Reassign blueprint || Select new contents for a blueprint.
|-
| Remove cables || Remove cables from power boles using Shift + LMB.
|-
| Remove train station || Remove stations from train schedules.
|-
| Reset assembling machine || Remove the recipe from an assembling machine.
|-
| Reset item || Reset items such as spidertron remotes.
|-
| Reverse select area || ?
|-
| Rotate entity || Rotate already placed entities.
|-
| Select area || ?
|-
| Select blueprint entities || Select entities to include in a blueprint.
|-
| Select entity slot || Set entity filters in deconstruction planners.
|-
| Select item || ?
|-
| Select mapper slot || ?
|-
| Select next valid gun || Switch between weapons by pressing Tab.
|-
| Select tile slot || Set tile filters in deconstruction planners.
|-
| Send spidertron || Use the remote control to send a spidertron somewhere.
|-
| Set auto launch rocket || Set a rocket silo to automatically launch rockets.
|-
| Set autosort inventory || Change the "always keep the player's main inventory sorted" setting. (Setting will still change, but the change has no effect.)
|-
| Set behaviour mode || ?
|-
| Set car weapons control || Change who has control of the weapons in a car when there are multiple people on board.
|-
| Set circuit condition || Change the enabled condition settings on any circuit connected entities.
|-
| Set circuit mode of operation || Change the mode of operation settings on any circuit controlled entities.
|-
| Set controller logistic trash filter item || Change the maximum count for a personal logistic request.
|-
| Set deconstruction item trees and rocks only || Change the deconstruction planner's "trees/rocks only" checkbox.
|-
| Set entity color || Change the color of any entity that supports this.
|-
| Set entity energy property || Change the settings on an electric energy interface (editor only item).
|-
| Set entity logistic trash filter item || Change the maximum count for an entity's logistic request.
|-
| Set filter || Filter inventory slots to a specific item.
|-
| Set flat controller gui || ? (does not affect changing to/from flat character gui)
|-
| Set heat interface mode || Set the mode of a heat interface (editor only item).
|-
| Set heat interface temperature || Set the temperature on a heat interface (editor only item).
|-
| Set infinity container filter item || Change the filters on infinity chests (editor only item)
|-
| Set infinity container remove unfiltered items || Change the remove unfiltered items setting on infinity chests (editor only item).
|-
| Set infinity pipe filter || Set the fluid type on an infinity pipe (editor only item).
|-
| Set inserter max stack size || Change the stack size limit on inserters.
|-
| Set inventory bar || ?
|-
| Set linked container link ID || Change which network linked chests are connected to (editor only item).
|-
| Set logistic filter item || Change any personal logistics request filters.
|-
| Set logistic filter signal || Change output signals on constant combinators.
|-
| Set player color || Change the color of the player's character.
|-
| Set recipe notifications || Change whether new recipes are marked as new in the crafting menu.
|-
| Set request from buffers || Change the "request from buffer chests" setting on requester chests.
|-
| Set research finished stops game || ?
|-
| Set signal || ?
|-
| Set splitter priority || Change the priority settings on splitters.
|-
| Set train stopped || Toggle trains between manual and automatic modes.
|-
| Set trains limit || Change the train limit setting on train stops.
|-
| Set vehicle automatic targeting parameters || Change the automatic targeting settings on autonomous vehicles such as the spidertron.
|-
| Setup assembling machine || Set the recipe on assembling machines that do not have a recipe set.
|-
| Setup blueprint || Create a blueprint from the blueprint edit menu.
|-
| Setup single blueprint record || ?
|-
| Smart pipette || Smart pipette functions such as selecting a miner when using the pipette on ore.
|-
| Spawn item || ?
|-
| Stack split || Transfer half a stack of items to another inventory with Shift + RMB.
|-
| Stack transfer || Transfer a stack of items to another inventory with Shift + LMB.
|-
| Start repair || Repair entities using a repair pack.
|-
| Start research || Start new research in the tech tree menu.
|-
| Start walking || Walk around.
|-
| Stop building by moving || ?
|-
| Switch connect to logistic network || Connect or disconnect machines from the logistic network.
|-
| Switch constant combinator state || Toggle constant combinators on or off.
|-
| Switch inserter filter mode state || Switch between blacklist and whitelist on filter inserters.
|-
| Switch power switch state || Toggle power switches on or off.
|-
| Switch to rename stop gui || Open the rename train stop menu by clicking the pencil icon next to the stop name.
|-
| Take equipment || Remove equipment from an equipment grid.
|-
| Toggle deconstruction item entity filter mode || Toggle the "entities only" switch on deconstruction planners.
|-
| Toggle deconstruction item tile filter mode || Toggle the "tiles only" switch on deconstruction planners.
|-
| Toggle driving || Enter or exit vehicles.
|-
| Toggle enable vehicle logistic requests || Toggle logistic requests of vehicles on or off.
|-
| Toggle entity logistic requests || Toggle personal logistics and auto-trash on or off for entities.
|-
| Toggle equipment movement bonus || Toggle exoskeletons on or off.
|-
| Toggle map editor || Open or close the map editor.
|-
| Toggle personal logistic requests. || Toggle personal logistic requests on or off.
|-
| Toggle personal roboport || Toggle personal roboports on or off.
|-
| Toggle show entity info || ?
|-
| Translate string || ?
|-
| Undo || Undo the previous action with Ctrl + Z.
|-
| Upgrade || Apply an upgrade using the upgrade planner.
|-
| Upgrade opened blueprint by item || Apply a pre-existing upgrade planner to an open blueprint.
|-
| Upgrade opened blueprint by record || Apply a default upgrade planner to an open blueprint.
|-
| Use artillery remote || Use the artillery remote to target artillery.
|-
| Use item || Use consumable items such as capsules.
|-
| Wire dragging || Manually place circuit network wires.
|-
| Write to console || Allow use of chat/console.
|}

Permissions

2024-08-15T17:56:46Z

SpeckledFleebeedoo: Add info on how to open menu

The permissions system provides control over what players are allowed to do while in a specific game. This system is most useful in [[multiplayer]], but may also be used in singleplayer. The permissions menu can be opened using the /permissions command.

== Overview ==
{| class="wikitable"
! Permission !! Description
|-
| Activate copy || Get a copy tool by pressing Ctrl + C or the copy button on the shortcut bar.
|-
| Activate cut || Get a cut tool by pressing Ctrl + X or the cut button on the shortcut bar.
|-
| Activate paste || Get a paste tool by pressing Ctrl + V or the paste button on the shortcut bar.
|-
| Add permission group || Create a new permission group in the permissions settings.
|-
| Add train station || Add a train station to a train schedule.
|-
| Admin action || ? (Presumably execute /c commands or player management?)
|-
| Alt reverse select area || ?
|-
| Alt select area || ?
|-
| Alt select blueprint entities || Select blueprint while holding shift to skip the blueprint edit window.
|-
| Alternative copy || Copy while holding Shift to open a blueprint edit window.
|-
| Begin mining || Mine an entity
|-
| Begin mining terrain || Mine any tile (removing paving)
|-
| Build || Place an entity.
|-
| Build rail || Use the rail planner
|-
| Build terrain || Place any tile.
|-
| Cancel craft || Cancel items in the handcrafting queue
|-
| Cancel deconstruct || Cancel deconstruction plans by selecting entities/tiles marked for deconstruction with a deconstruction planner while holding Shift.
|-
| Cancel new blueprint || Exit out of the blueprint editing menu by pressing escape (X button still works).
|-
| Cancel research || Cancel ongoing research (Does not correctly show in research gui in singleplayer, research will appear cancelled but resumes as soon as window is closed)
|-
| Cancel upgrade || Cancel an entity upgrade created with the upgrade planner.
|-
| Change active character tab || ? (Switching between the crafting and logistics tabs when flat gui is enabled still works as normal)
|-
| Change active item group for crafting || ?
|-
| Change active item group for filters || ?
|-
| Change active quick bar || ? (Editing quickbars, cycling through them and switching them still works as normal)
|-
| Change arithmetic combinator parameters || Make changes to any of the settings of arithmetic combinators.
|-
| Change decider combinator parameters || Make changes to any of the settings of decider combinators.
|-
| Change entity label || ?
|-
| Change item description || ?
|-
| Change item label || ?
|-
| Change multiplayer config || ?
|-
| Change picking state || Pick up items from the floor by holding F.
|-
| Change programmable speaker alert parameters || Change any of the programmable speaker's alert settings.
|-
| Change programmable speaker circuit parameters || Change the programmable speaker's "signal value is pitch" setting.
|-
| Change programmable speaker parameters || Change the programmable speaker's "Volume", "Global playback" and "Allow polyphony" settings.
|-
| Change riding state || Control any vehicle (getting in and out is still possible).
|-
| Change shooting state || Shoot at anything.
|-
| Change train stop station || Change the name of a train stop.
|-
| Change train wait condition || Add or remove wait conditions in a train schedule.
|-
| Change train wait condition data || Edit the contents of wait conditions in a train schedule.
|-
| Clear cursor || Clear the cursor by pressing Q.
|-
| Connect rolling stock || Connect multiple trains together using the "connect rolling stock" keybind.
|-
| Copy || Copy entities using the copy tool.
|-
| Copy entity settings || Copy the settings of an entity with Shift + RMB.
|-
| Copy opened blueprint || Make a copy of an opened blueprint using the "create copy of this" button.
|-
| Copy opened item || Make a copy of an opened item that is not a blueprint (i.e. planners) using the "create copy of this" button.
|-
| Craft || Handcraft items.
|-
| Cursor split || Pick up half a stack of items from an inventory by right clicking it.
|-
| Cursor transfer || Pick up a stack of items from an inventory by clicking it.
|-
| Custom input || Use custom inputs defined by mods.
|-
| Cycle blueprint book backwards || Cycle through the blueprints in a blueprint book in reverse order with Shift + Scroll.
|-
| Cycle blueprint book || Cycle through the blueprints in a blueprint book by scrolling.
|-
| Deconstruct || Mark items for deconstruction using a deconstruction planner.
|-
| Delete blueprint library || Delete a blueprint that is placed in the player's personal blueprint library. (Taking the blueprint out and then deleting it still works.)
|-
| Delete blueprint record || Delete a blueprint that is placed in the Game blueprints menu. (Taking the blueprint out and then deleting it still works.)
|-
| Delete custom tag || Delete a custom tag that has been placed on the map.
|-
| Delete permission group || Delete a permission group in the permission setting.
|-
| Destroy item || ?
|-
| Destroy opened item || Destroy a blueprint or planner that is opened using the Destroy button.
|-
| Disconnect rolling stock || Disconnect wagons using the "disconnect rolling stock" keybind.
|-
| Drag train schedule || Rearrange stations in a train schedule by dragging them.
|-
| Drag train wait condition || Rearrange wait conditions in a train schedule by dragging them.
|-
| Drop blueprint record || ?
|-
| Drop item || Drop an item onto the floor by pressing Z.
|-
| Edit blueprint tool preview || Edit the name, icon or description fields of a blueprint.
|-
| Edit custom tag || Edit a custom tag that has been placed on the map.
|-
| Edit permission group || Edit the settings for an existing permission group in the permissions settings.
|-
| Export blueprint || Export a blueprint to a blueprint string.
|-
| Fast entity split || Fast transfer half a stack of items to an entity by holding a stack and pressing Ctrl + RMB.
|-
| Fast entity transfer || Fast transfer a stack of items to an entity by holding a stack and pressing Ctrl + LMB.
|-
| Flush opened entity fluid || Flush fluids from a specific entity.
|-
| Flush opened entity specific fluid || Flush fluids from a connected fluid network.
|-
| Go to train station || Send a train to a specific station in its schedule. (Temporary stops still work)
|-
| Grab blueprint record || Take blueprints out of the blueprint library. (Copying still works)
|-
| Gui checked state changed || ?
|-
| Gui click || ?
|-
| Gui confirmed || ?
|-
| Gui elem changed || ?
|-
| Gui hover || ?
|-
| Gui leave || ?
|-
| Gui location changed || ?
|-
| Gui selected tab changed || ?
|-
| Gui selection state changed || ?
|-
| Gui switch state changed || ?
|-
| Gui text changed || ?
|-
| Gui value changed || ?
|-
| Import blueprint || ? (May only work in multiplayer?)
|-
| Import blueprint string || Import blueprints using the import blueprint string menu.
|-
| Import blueprints filtered || ?
|-
| Import permissions string || Import a permissions string in the permissions settings.
|-
| Inventory split || Quick transfer half of all items or all items of a specific kind to another inventory with Ctrl + RMB
|-
| Inventory transfer || Quick transfer all items or all items of a specific kind from one inventory to another with Ctrl + LMB
|-
| Launch rocket || Launch a rocket from the rocket silo
|-
| Lua shortcut || ?
|-
| Map editor action || Use any of the features of the map editor (opening it is still possible).
|-
| Market offer || Interact with the market entity.
|-
| Mod settings changed || Change any mod settings.
|-
| Open achievements gui || Open the Achievements menu.
|-
| Open blueprint library gui || Open the blueprint library.
|-
| Open blueprint record || Open the blueprint edit menu for any blueprint in the blueprint library.
|-
| Open bonus gui || Open the bonuses menu.
|-
| Open character gui || Open the character inventory/crafting menu
|-
| Open current vehicle gui || Open the gui of the currently driven vehicle with the button at the bottom-left of the screen.
|-
| Open equipment || Open the menus of individual personal equipment items. (No openable equipment exists in vanilla)
|-
| Open gui || Open any entity menus.
|-
| Open item || Open the editing menus of blueprints and planners.
|-
| Open logistic gui || Open the logistic networks menu.
|-
| Open mod item || ?
|-
| Open parent of opened item || Directly open the parent inventory of items such as blueprint books.
|-
| Open production gui || Open the production statistics menu.
|-
| Open technology gui || Open the tech tree menu.
|-
| Open tips and tricks gui || Open the tips and tricks menu.
|-
| Open train gui || Open the trains overview menu.
|-
| Paste entity settings || Paste the settings of an entity with Shift + LMB.
|-
| Place equipment || Place personal equipment into equipment grids.
|-
| Quick bar pick slot || Select items placed on the quick bar.
|-
| Quick bar set selected page || ?
|-
| Quick bar set slot || Reassign a quickbar slot to hold a new item. (Assigning items to empty slots is still possible)
|-
| Reassign blueprint || Select new contents for a blueprint.
|-
| Remove cables || Remove cables from power boles using Shift + LMB.
|-
| Remove train station || Remove stations from train schedules.
|-
| Reset assembling machine || Remove the recipe from an assembling machine.
|-
| Reset item || Reset items such as spidertron remotes.
|-
| Reverse select area || ?
|-
| Rotate entity || Rotate already placed entities.
|-
| Select area || ?
|-
| Select blueprint entities || Select entities to include in a blueprint.
|-
| Select entity slot || Set entity filters in deconstruction planners.
|-
| Select item || ?
|-
| Select mapper slot || ?
|-
| Select next valid gun || Switch between weapons by pressing Tab.
|-
| Select tile slot || Set tile filters in deconstruction planners.
|-
| Send spidertron || Use the remote control to send a spidertron somewhere.
|-
| Set auto launch rocket || Set a rocket silo to automatically launch rockets.
|-
| Set autosort inventory || Change the "always keep the player's main inventory sorted" setting. (Setting will still change, but the change has no effect.)
|-
| Set behaviour mode || ?
|-
| Set car weapons control || Change who has control of the weapons in a car when there are multiple people on board.
|-
| Set circuit condition || Change the enabled condition settings on any circuit connected entities.
|-
| Set circuit mode of operation || Change the mode of operation settings on any circuit controlled entities.
|-
| Set controller logistic trash filter item || Change the maximum count for a personal logistic request.
|-
| Set deconstruction item trees and rocks only || Change the deconstruction planner's "trees/rocks only" checkbox.
|-
| Set entity color || Change the color of any entity that supports this.
|-
| Set entity energy property || Change the settings on an electric energy interface (editor only item).
|-
| Set entity logistic trash filter item || Change the maximum count for an entity's logistic request.
|-
| Set filter || Filter inventory slots to a specific item.
|-
| Set flat controller gui || ? (does not affect changing to/from flat character gui)
|-
| Set heat interface mode || Set the mode of a heat interface (editor only item).
|-
| Set heat interface temperature || Set the temperature on a heat interface (editor only item).
|-
| Set infinity container filter item || Change the filters on infinity chests (editor only item)
|-
| Set infinity container remove unfiltered items || Change the remove unfiltered items setting on infinity chests (editor only item).
|-
| Set infinity pipe filter || Set the fluid type on an infinity pipe (editor only item).
|-
| Set inserter max stack size || Change the stack size limit on inserters.
|-
| Set inventory bar || ?
|-
| Set linked container link ID || Change which network linked chests are connected to (editor only item).
|-
| Set logistic filter item || Change any personal logistics request filters.
|-
| Set logistic filter signal || Change output signals on constant combinators.
|-
| Set player color || Change the color of the player's character.
|-
| Set recipe notifications || Change whether new recipes are marked as new in the crafting menu.
|-
| Set request from buffers || Change the "request from buffer chests" setting on requester chests.
|-
| Set research finished stops game || ?
|-
| Set signal || ?
|-
| Set splitter priority || Change the priority settings on splitters.
|-
| Set train stopped || Toggle trains between manual and automatic modes.
|-
| Set trains limit || Change the train limit setting on train stops.
|-
| Set vehicle automatic targeting parameters || Change the automatic targeting settings on autonomous vehicles such as the spidertron.
|-
| Setup assembling machine || Set the recipe on assembling machines that do not have a recipe set.
|-
| Setup blueprint || Create a blueprint from the blueprint edit menu.
|-
| Setup single blueprint record || ?
|-
| Smart pipette || Smart pipette functions such as selecting a miner when using the pipette on ore.
|-
| Spawn item || ?
|-
| Stack split || Transfer half a stack of items to another inventory with Shift + RMB.
|-
| Stack transfer || Transfer a stack of items to another inventory with Shift + LMB.
|-
| Start repair || Repair entities using a repair pack.
|-
| Start research || Start new research in the tech tree menu.
|-
| Start walking || Walk around.
|-
| Stop building by moving || ?
|-
| Switch connect to logistic network || Connect or disconnect machines from the logistic network.
|-
| Switch constant combinator state || Toggle constant combinators on or off.
|-
| Switch inserter filter mode state || Switch between blacklist and whitelist on filter inserters.
|-
| Switch power switch state || Toggle power switches on or off.
|-
| Switch to rename stop gui || Open the rename train stop menu by clicking the pencil icon next to the stop name.
|-
| Take equipment || Remove equipment from an equipment grid.
|-
| Toggle deconstruction item entity filter mode || Toggle the "entities only" switch on deconstruction planners.
|-
| Toggle deconstruction item tile filter mode || Toggle the "tiles only" switch on deconstruction planners.
|-
| Toggle driving || Enter or exit vehicles.
|-
| Toggle enable vehicle logistic requests || Toggle logistic requests of vehicles on or off.
|-
| Toggle entity logistic requests || Toggle personal logistics and auto-trash on or off for entities.
|-
| Toggle equipment movement bonus || Toggle exoskeletons on or off.
|-
| Toggle map editor || Open or close the map editor.
|-
| Toggle personal logistic requests. Toggle personal logistic requests on or off.
|-
| Toggle personal roboport || Toggle personal roboports on or off.
|-
| Toggle show entity info || ?
|-
| Translate string || ?
|-
| Undo || Undo the previous action with Ctrl + Z.
|-
| Upgrade || Apply an upgrade using the upgrade planner.
|-
| Upgrade opened blueprint by item || Apply a pre-existing upgrade planner to an open blueprint.
|-
| Upgrade opened blueprint by record || Apply a default upgrade planner to an open blueprint.
|-
| Use artillery remote || Use the artillery remote to target artillery.
|-
| Use item || Use consumable items such as capsules.
|-
| Wire dragging || Manually place circuit network wires.
|-
| Write to console || Allow use of chat/console.
|}

Permissions

2024-08-15T17:52:44Z

SpeckledFleebeedoo: Create page

The permissions system provides control over what players are allowed to do while in a specific game. This system is most useful in [[multiplayer]], but may also be used in singleplayer.

== Overview ==
{| class="wikitable"
! Permission !! Description
|-
| Activate copy || Get a copy tool by pressing Ctrl + C or the copy button on the shortcut bar.
|-
| Activate cut || Get a cut tool by pressing Ctrl + X or the cut button on the shortcut bar.
|-
| Activate paste || Get a paste tool by pressing Ctrl + V or the paste button on the shortcut bar.
|-
| Add permission group || Create a new permission group in the permissions settings.
|-
| Add train station || Add a train station to a train schedule.
|-
| Admin action || ? (Presumably execute /c commands or player management?)
|-
| Alt reverse select area || ?
|-
| Alt select area || ?
|-
| Alt select blueprint entities || Select blueprint while holding shift to skip the blueprint edit window.
|-
| Alternative copy || Copy while holding Shift to open a blueprint edit window.
|-
| Begin mining || Mine an entity
|-
| Begin mining terrain || Mine any tile (removing paving)
|-
| Build || Place an entity.
|-
| Build rail || Use the rail planner
|-
| Build terrain || Place any tile.
|-
| Cancel craft || Cancel items in the handcrafting queue
|-
| Cancel deconstruct || Cancel deconstruction plans by selecting entities/tiles marked for deconstruction with a deconstruction planner while holding Shift.
|-
| Cancel new blueprint || Exit out of the blueprint editing menu by pressing escape (X button still works).
|-
| Cancel research || Cancel ongoing research (Does not correctly show in research gui in singleplayer, research will appear cancelled but resumes as soon as window is closed)
|-
| Cancel upgrade || Cancel an entity upgrade created with the upgrade planner.
|-
| Change active character tab || ? (Switching between the crafting and logistics tabs when flat gui is enabled still works as normal)
|-
| Change active item group for crafting || ?
|-
| Change active item group for filters || ?
|-
| Change active quick bar || ? (Editing quickbars, cycling through them and switching them still works as normal)
|-
| Change arithmetic combinator parameters || Make changes to any of the settings of arithmetic combinators.
|-
| Change decider combinator parameters || Make changes to any of the settings of decider combinators.
|-
| Change entity label || ?
|-
| Change item description || ?
|-
| Change item label || ?
|-
| Change multiplayer config || ?
|-
| Change picking state || Pick up items from the floor by holding F.
|-
| Change programmable speaker alert parameters || Change any of the programmable speaker's alert settings.
|-
| Change programmable speaker circuit parameters || Change the programmable speaker's "signal value is pitch" setting.
|-
| Change programmable speaker parameters || Change the programmable speaker's "Volume", "Global playback" and "Allow polyphony" settings.
|-
| Change riding state || Control any vehicle (getting in and out is still possible).
|-
| Change shooting state || Shoot at anything.
|-
| Change train stop station || Change the name of a train stop.
|-
| Change train wait condition || Add or remove wait conditions in a train schedule.
|-
| Change train wait condition data || Edit the contents of wait conditions in a train schedule.
|-
| Clear cursor || Clear the cursor by pressing Q.
|-
| Connect rolling stock || Connect multiple trains together using the "connect rolling stock" keybind.
|-
| Copy || Copy entities using the copy tool.
|-
| Copy entity settings || Copy the settings of an entity with Shift + RMB.
|-
| Copy opened blueprint || Make a copy of an opened blueprint using the "create copy of this" button.
|-
| Copy opened item || Make a copy of an opened item that is not a blueprint (i.e. planners) using the "create copy of this" button.
|-
| Craft || Handcraft items.
|-
| Cursor split || Pick up half a stack of items from an inventory by right clicking it.
|-
| Cursor transfer || Pick up a stack of items from an inventory by clicking it.
|-
| Custom input || Use custom inputs defined by mods.
|-
| Cycle blueprint book backwards || Cycle through the blueprints in a blueprint book in reverse order with Shift + Scroll.
|-
| Cycle blueprint book || Cycle through the blueprints in a blueprint book by scrolling.
|-
| Deconstruct || Mark items for deconstruction using a deconstruction planner.
|-
| Delete blueprint library || Delete a blueprint that is placed in the player's personal blueprint library. (Taking the blueprint out and then deleting it still works.)
|-
| Delete blueprint record || Delete a blueprint that is placed in the Game blueprints menu. (Taking the blueprint out and then deleting it still works.)
|-
| Delete custom tag || Delete a custom tag that has been placed on the map.
|-
| Delete permission group || Delete a permission group in the permission setting.
|-
| Destroy item || ?
|-
| Destroy opened item || Destroy a blueprint or planner that is opened using the Destroy button.
|-
| Disconnect rolling stock || Disconnect wagons using the "disconnect rolling stock" keybind.
|-
| Drag train schedule || Rearrange stations in a train schedule by dragging them.
|-
| Drag train wait condition || Rearrange wait conditions in a train schedule by dragging them.
|-
| Drop blueprint record || ?
|-
| Drop item || Drop an item onto the floor by pressing Z.
|-
| Edit blueprint tool preview || Edit the name, icon or description fields of a blueprint.
|-
| Edit custom tag || Edit a custom tag that has been placed on the map.
|-
| Edit permission group || Edit the settings for an existing permission group in the permissions settings.
|-
| Export blueprint || Export a blueprint to a blueprint string.
|-
| Fast entity split || Fast transfer half a stack of items to an entity by holding a stack and pressing Ctrl + RMB.
|-
| Fast entity transfer || Fast transfer a stack of items to an entity by holding a stack and pressing Ctrl + LMB.
|-
| Flush opened entity fluid || Flush fluids from a specific entity.
|-
| Flush opened entity specific fluid || Flush fluids from a connected fluid network.
|-
| Go to train station || Send a train to a specific station in its schedule. (Temporary stops still work)
|-
| Grab blueprint record || Take blueprints out of the blueprint library. (Copying still works)
|-
| Gui checked state changed || ?
|-
| Gui click || ?
|-
| Gui confirmed || ?
|-
| Gui elem changed || ?
|-
| Gui hover || ?
|-
| Gui leave || ?
|-
| Gui location changed || ?
|-
| Gui selected tab changed || ?
|-
| Gui selection state changed || ?
|-
| Gui switch state changed || ?
|-
| Gui text changed || ?
|-
| Gui value changed || ?
|-
| Import blueprint || ? (May only work in multiplayer?)
|-
| Import blueprint string || Import blueprints using the import blueprint string menu.
|-
| Import blueprints filtered || ?
|-
| Import permissions string || Import a permissions string in the permissions settings.
|-
| Inventory split || Quick transfer half of all items or all items of a specific kind to another inventory with Ctrl + RMB
|-
| Inventory transfer || Quick transfer all items or all items of a specific kind from one inventory to another with Ctrl + LMB
|-
| Launch rocket || Launch a rocket from the rocket silo
|-
| Lua shortcut || ?
|-
| Map editor action || Use any of the features of the map editor (opening it is still possible).
|-
| Market offer || Interact with the market entity.
|-
| Mod settings changed || Change any mod settings.
|-
| Open achievements gui || Open the Achievements menu.
|-
| Open blueprint library gui || Open the blueprint library.
|-
| Open blueprint record || Open the blueprint edit menu for any blueprint in the blueprint library.
|-
| Open bonus gui || Open the bonuses menu.
|-
| Open character gui || Open the character inventory/crafting menu
|-
| Open current vehicle gui || Open the gui of the currently driven vehicle with the button at the bottom-left of the screen.
|-
| Open equipment || Open the menus of individual personal equipment items. (No openable equipment exists in vanilla)
|-
| Open gui || Open any entity menus.
|-
| Open item || Open the editing menus of blueprints and planners.
|-
| Open logistic gui || Open the logistic networks menu.
|-
| Open mod item || ?
|-
| Open parent of opened item || Directly open the parent inventory of items such as blueprint books.
|-
| Open production gui || Open the production statistics menu.
|-
| Open technology gui || Open the tech tree menu.
|-
| Open tips and tricks gui || Open the tips and tricks menu.
|-
| Open train gui || Open the trains overview menu.
|-
| Paste entity settings || Paste the settings of an entity with Shift + LMB.
|-
| Place equipment || Place personal equipment into equipment grids.
|-
| Quick bar pick slot || Select items placed on the quick bar.
|-
| Quick bar set selected page || ?
|-
| Quick bar set slot || Reassign a quickbar slot to hold a new item. (Assigning items to empty slots is still possible)
|-
| Reassign blueprint || Select new contents for a blueprint.
|-
| Remove cables || Remove cables from power boles using Shift + LMB.
|-
| Remove train station || Remove stations from train schedules.
|-
| Reset assembling machine || Remove the recipe from an assembling machine.
|-
| Reset item || Reset items such as spidertron remotes.
|-
| Reverse select area || ?
|-
| Rotate entity || Rotate already placed entities.
|-
| Select area || ?
|-
| Select blueprint entities || Select entities to include in a blueprint.
|-
| Select entity slot || Set entity filters in deconstruction planners.
|-
| Select item || ?
|-
| Select mapper slot || ?
|-
| Select next valid gun || Switch between weapons by pressing Tab.
|-
| Select tile slot || Set tile filters in deconstruction planners.
|-
| Send spidertron || Use the remote control to send a spidertron somewhere.
|-
| Set auto launch rocket || Set a rocket silo to automatically launch rockets.
|-
| Set autosort inventory || Change the "always keep the player's main inventory sorted" setting. (Setting will still change, but the change has no effect.)
|-
| Set behaviour mode || ?
|-
| Set car weapons control || Change who has control of the weapons in a car when there are multiple people on board.
|-
| Set circuit condition || Change the enabled condition settings on any circuit connected entities.
|-
| Set circuit mode of operation || Change the mode of operation settings on any circuit controlled entities.
|-
| Set controller logistic trash filter item || Change the maximum count for a personal logistic request.
|-
| Set deconstruction item trees and rocks only || Change the deconstruction planner's "trees/rocks only" checkbox.
|-
| Set entity color || Change the color of any entity that supports this.
|-
| Set entity energy property || Change the settings on an electric energy interface (editor only item).
|-
| Set entity logistic trash filter item || Change the maximum count for an entity's logistic request.
|-
| Set filter || Filter inventory slots to a specific item.
|-
| Set flat controller gui || ? (does not affect changing to/from flat character gui)
|-
| Set heat interface mode || Set the mode of a heat interface (editor only item).
|-
| Set heat interface temperature || Set the temperature on a heat interface (editor only item).
|-
| Set infinity container filter item || Change the filters on infinity chests (editor only item)
|-
| Set infinity container remove unfiltered items || Change the remove unfiltered items setting on infinity chests (editor only item).
|-
| Set infinity pipe filter || Set the fluid type on an infinity pipe (editor only item).
|-
| Set inserter max stack size || Change the stack size limit on inserters.
|-
| Set inventory bar || ?
|-
| Set linked container link ID || Change which network linked chests are connected to (editor only item).
|-
| Set logistic filter item || Change any personal logistics request filters.
|-
| Set logistic filter signal || Change output signals on constant combinators.
|-
| Set player color || Change the color of the player's character.
|-
| Set recipe notifications || Change whether new recipes are marked as new in the crafting menu.
|-
| Set request from buffers || Change the "request from buffer chests" setting on requester chests.
|-
| Set research finished stops game || ?
|-
| Set signal || ?
|-
| Set splitter priority || Change the priority settings on splitters.
|-
| Set train stopped || Toggle trains between manual and automatic modes.
|-
| Set trains limit || Change the train limit setting on train stops.
|-
| Set vehicle automatic targeting parameters || Change the automatic targeting settings on autonomous vehicles such as the spidertron.
|-
| Setup assembling machine || Set the recipe on assembling machines that do not have a recipe set.
|-
| Setup blueprint || Create a blueprint from the blueprint edit menu.
|-
| Setup single blueprint record || ?
|-
| Smart pipette || Smart pipette functions such as selecting a miner when using the pipette on ore.
|-
| Spawn item || ?
|-
| Stack split || Transfer half a stack of items to another inventory with Shift + RMB.
|-
| Stack transfer || Transfer a stack of items to another inventory with Shift + LMB.
|-
| Start repair || Repair entities using a repair pack.
|-
| Start research || Start new research in the tech tree menu.
|-
| Start walking || Walk around.
|-
| Stop building by moving || ?
|-
| Switch connect to logistic network || Connect or disconnect machines from the logistic network.
|-
| Switch constant combinator state || Toggle constant combinators on or off.
|-
| Switch inserter filter mode state || Switch between blacklist and whitelist on filter inserters.
|-
| Switch power switch state || Toggle power switches on or off.
|-
| Switch to rename stop gui || Open the rename train stop menu by clicking the pencil icon next to the stop name.
|-
| Take equipment || Remove equipment from an equipment grid.
|-
| Toggle deconstruction item entity filter mode || Toggle the "entities only" switch on deconstruction planners.
|-
| Toggle deconstruction item tile filter mode || Toggle the "tiles only" switch on deconstruction planners.
|-
| Toggle driving || Enter or exit vehicles.
|-
| Toggle enable vehicle logistic requests || Toggle logistic requests of vehicles on or off.
|-
| Toggle entity logistic requests || Toggle personal logistics and auto-trash on or off for entities.
|-
| Toggle equipment movement bonus || Toggle exoskeletons on or off.
|-
| Toggle map editor || Open or close the map editor.
|-
| Toggle personal logistic requests. Toggle personal logistic requests on or off.
|-
| Toggle personal roboport || Toggle personal roboports on or off.
|-
| Toggle show entity info || ?
|-
| Translate string || ?
|-
| Undo || Undo the previous action with Ctrl + Z.
|-
| Upgrade || Apply an upgrade using the upgrade planner.
|-
| Upgrade opened blueprint by item || Apply a pre-existing upgrade planner to an open blueprint.
|-
| Upgrade opened blueprint by record || Apply a default upgrade planner to an open blueprint.
|-
| Use artillery remote || Use the artillery remote to target artillery.
|-
| Use item || Use consumable items such as capsules.
|-
| Wire dragging || Manually place circuit network wires.
|-
| Write to console || Allow use of chat/console.
|}

Application directory

2024-07-05T21:32:12Z

SpeckledFleebeedoo: Improved formatting

{{Languages}}
== Overview ==
Depending on your installation method and OS, you will have one or two directories that contain Factorio assets, and one that contains user data, such as saves and mods.

== User data directory ==
The user data directory is where personal files are stored:
* Save files <code>./saves</code>
* Mods <code>./mods</code>
* Script-output, e.g. from /screenshot <code>./script-output</code>
* Local [[scenario system|scenarios]] <code>./scenarios</code>
* Local settings <code>./config/config.ini</code>
* [[log file]]s <code>factorio-*.log</code>
* Crash dump files <code>factorio-dump-*.dmp</code>

=== Locations ===
Search your computer for the directory location, or type the path into your file manager address bar.

Windows:

%appdata%\Factorio

:The <code>%appdata%</code> shorthand translates to your local version of <code>C:\Users\[user name]\AppData\Roaming</code>

MacOSX:

~/Library/Application Support/factorio

Linux distributions:

~/.factorio

:When using the Flatpak version of steam, all paths start from <code>~/.var/app/com.valvesoftware.Steam/</code> instead.

When using Steam on Windows, the config.ini, achievements.dat, modded-achievements.dat and player-data.json can also be found in

C:\Program Files (x86)\Steam\userdata\[user number]\427520\remote

== Application directory ==
The application directory stores three things:
* Factorio executables <code>./bin</code>
* Data for vanilla Factorio <code>./data</code>
* API documentation <code>./doc-html</code>

=== Locations ===

Windows:

C:\Program Files (x86)\Steam\steamapps\common\Factorio
C:\Program Files\Factorio

MacOSX:

~/Library/Application Support/Steam/steamapps/common/Factorio/factorio.app/Contents
/Applications/factorio.app/Contents

Linux:

~/.factorio

== Changing the user data directory ==

You can create a file <code>config-path.cfg</code> to configure Factorio to any directory.

In order to change the user data directory, user must edit the location of the "write-data" entry in the file <code>(Game install directory)/config/config.ini</code>. This affects the location of mods, scenario and temp.

==== macOS ====
Create <code>factorio.app/config-path.cfg</code> with the following contents:

config-path=__PATH__executable__/../config
use-system-read-write-data-directories=false

Update <code>factorio.app/Contents/config/config.ini</code>

[path]
read-data=__PATH__executable__/../data
write-data=__PATH__executable__/..

'''[http://www.factorioforums.com/forum/viewtopic.php?f=49&t=12819&p=87281#p87281 Please see this discussion]''' (for older versions of macOS, but may work on any other OS).

==== Linux ====
Update <code>__Game_Install_directory/config-path.cfg</code>

use-system-read-write-data-directories=true

Update <code>__Game_Install_directory/config/config.ini</code>

[path]
read-data=__PATH__executable__/../../data
write-data=.local/share/factorio

You could set the <code>write-data</code> value to '''<code>.factorio</code>''' if you prefer.

Once you have done this, you can remove write permissions to the entire game installation directory '''except''' for <code>config/config.ini</code>, which '''must''' be writable by all people who wish to play the game.

Note that if someone changes any options, in-game, those option changes will apply to everyone who plays on the same computer.

== Installation from Zip File ==
The unzipped Factorio directory.

A list of all things found here:

* Save games (as zip files)
* User-installed/created [[Mods]].
* User-installed/created scenarios.
* User configuration and settings storage
* [[Log file]] (factorio-*.log)
* Player data (player-data.json)

Note: Deleting the configuration file will result in a default replacement being generated upon the next Factorio launch.

It is recommended to create backups from this directory (of saves, config, etc) before installing a new version.

== See also ==
* [[Install guide]]
* [[Installing Mods]]
* [http://www.factorioforums.com/forum/viewtopic.php?f=5&t=8294 Linux Version - Save games in $HOME somewhere]

{{C|Main}}

Application directory

2024-07-05T21:25:50Z

SpeckledFleebeedoo: Add path for Steam Flatpak

{{Languages}}
== Overview ==
Depending on your installation method and OS, you will have one or two directories that contain Factorio assets, and one that contains user data, such as saves and mods.

== User data directory ==
The user data directory is where personal files are stored:
* Save files <code>./saves</code>
* Mods <code>./mods</code>
* Script-output, e.g. from /screenshot <code>./script-output</code>
* Local [[scenario system|scenarios]] <code>./scenarios</code>
* Local settings <code>./config/config.ini</code>
* [[log file]]s <code>factorio-*.log</code>
* Crash dump files <code>factorio-dump-*.dmp</code>

=== Locations ===
Search your computer for the directory location, or type the path into your file manager address bar.

Windows:

%appdata%\Factorio

:The <code>%appdata%</code> shorthand translates to your local version of <code>C:\Users\[user name]\AppData\Roaming</code>

MacOSX:

~/Library/Application Support/factorio

Linux distributions:

~/.factorio
~/.var/app/com.valvesoftware.Steam/.factorio (for Steam Flatpak)

When using Steam on Windows, the config.ini, achievements.dat, modded-achievements.dat and player-data.json can also be found in

C:\Program Files (x86)\Steam\userdata\[user number]\427520\remote

== Application directory ==
The application directory stores three things:
* Factorio executables <code>./bin</code>
* Data for vanilla Factorio <code>./data</code>
* API documentation <code>./doc-html</code>

=== Locations ===

Windows:

C:\Program Files (x86)\Steam\steamapps\common\Factorio
C:\Program Files\Factorio

MacOSX:

~/Library/Application Support/Steam/steamapps/common/Factorio/factorio.app/Contents
/Applications/factorio.app/Contents

Linux:

~/.factorio

== Changing the user data directory ==

You can create a file <code>config-path.cfg</code> to configure Factorio to any directory.

In order to change the user data directory, user must edit the location of the "write-data" entry in the file <code>(Game install directory)/config/config.ini</code>. This affects the location of mods, scenario and temp.

==== macOS ====
Create <code>factorio.app/config-path.cfg</code> with the following contents:

config-path=__PATH__executable__/../config
use-system-read-write-data-directories=false

Update <code>factorio.app/Contents/config/config.ini</code>

[path]
read-data=__PATH__executable__/../data
write-data=__PATH__executable__/..

'''[http://www.factorioforums.com/forum/viewtopic.php?f=49&t=12819&p=87281#p87281 Please see this discussion]''' (for older versions of macOS, but may work on any other OS).

==== Linux ====
Update <code>__Game_Install_directory/config-path.cfg</code>

use-system-read-write-data-directories=true

Update <code>__Game_Install_directory/config/config.ini</code>

[path]
read-data=__PATH__executable__/../../data
write-data=.local/share/factorio

You could set the <code>write-data</code> value to '''<code>.factorio</code>''' if you prefer.

Once you have done this, you can remove write permissions to the entire game installation directory '''except''' for <code>config/config.ini</code>, which '''must''' be writable by all people who wish to play the game.

Note that if someone changes any options, in-game, those option changes will apply to everyone who plays on the same computer.

== Installation from Zip File ==
The unzipped Factorio directory.

A list of all things found here:

* Save games (as zip files)
* User-installed/created [[Mods]].
* User-installed/created scenarios.
* User configuration and settings storage
* [[Log file]] (factorio-*.log)
* Player data (player-data.json)

Note: Deleting the configuration file will result in a default replacement being generated upon the next Factorio launch.

It is recommended to create backups from this directory (of saves, config, etc) before installing a new version.

== See also ==
* [[Install guide]]
* [[Installing Mods]]
* [http://www.factorioforums.com/forum/viewtopic.php?f=5&t=8294 Linux Version - Save games in $HOME somewhere]

{{C|Main}}

Mod portal API

2024-06-15T13:18:43Z

SpeckledFleebeedoo: Add deprecated variable for full mod result entries

<div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Internal|Internal API]]</div>

The Mod Portal API is used to both browse and download all mods available on the [https://mods.factorio.com/ official Factorio mod portal]. Using the API does not require any kind of authentication or account information and can be viewed simply by following the URLs below in any web browser.

<code>https://mods.factorio.com/api/mods</code>

More detailed information about a particular mod can be obtained by retrieving the following URL, where {name} is the mod's name field in the result object.

<code>https://mods.factorio.com/api/mods/{name}</code>

To get even more information about a mod, you can use the following URL.

<code>https://mods.factorio.com/api/mods/{name}/full</code>

== Endpoints ==

=== /api/mods ===

GET Parameters (sent as query parameters):

{| class="wikitable"
! Key !! Values !! Description
|-
| hide_deprecated || {boolean} || Only return non-deprecated mods.
|-
| page ||{an integer}||Page number you would like to show. Makes it so you can see a certain part of the list without getting detail on all
|-
| page_size ||{an integer or 'max'}||The amount of results to show in your search
|-
| sort || {enum, one of name, created_at or updated_at} || Sort results by this property. Defaults to name when not defined. Ignored for <code>page_size=max</code> queries.
|-
| sort_order || {enum, one of asc or desc} || Sort results ascending or descending. Defaults to descending when not defined. Ignored for <code>page_size=max</code> queries.
|-
| namelist || {array of strings} || Return only mods that match the given names. Either comma-separated names or supply the namelist parameter more than once. Response will include <code>releases</code> instead of <code>latest_release</code>.
|-
| version || {enum, one of 0.13, 0.14, 0.15, 0.16, 0.17, 0.18, 1.0 or 1.1} || Only return non-deprecated mods compatible with this Factorio version
|}

Returns [[#Mod List Response]]

=== /api/mods/{mod_name} ===

Return short information of a specific mod.

See [[#Result Entry]], "Short" column.

=== /api/mods/{mod_name}/full ===

Returns more information of a mod.

See [[#Result Entry]], "Full" column.

== JSON Object Types ==

=== Mod List Response ===

{| class="wikitable"
! Key !! Type !! Description
|-
| pagination || [[#Pagination|Pagination]] || See [[#Pagination]]
|-
| results || [[#Result Entry|Result]][] || A list of mods, matching any filters you specified.
|}

=== Pagination ===

{| class="wikitable"
! Key !! Type !! Description
|-
| count || Integer || Total number of mods that match your specified filters.
|-
| links || [[#Pagination_Links|Links]] || Utility links to mod portal api requests, preserving all filters and search queries.
|-
| page || Integer || The current page number.
|-
| page_count || Integer || The total number of pages returned.
|-
| page_size || Integer || The number of results per page.
|}

=== Pagination Links ===

{| class="wikitable"
! Key !! Type !! Description
|-
| first || String(URL) || URL to the first page of the results, or null if you're already on the first page.
|-
| prev || String(URL) || URL to the previous page of the results, or null if you're already on the first page.
|-
| next || String(URL) || URL to the next page of the results, or null if you're already on the last page.
|-
| last || String(URL) || URL to the last page of the results, or null if you're already on the last page.
|}

=== Result Entry ===

Fields returned by the api/mods endpoint are marked with a check (✓) in the "api/mods endpoint" column, those returned by the api/mods/{name} endpoint are marked with a check in the "Short" column and those returned by the api/mods/{name}/full endpoint are marked in the "Full" column. Fields may be absent if there is no data.

{| class="wikitable"
! Key !! Type !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' | api/mods endpoint !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' | Short !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' | Full !! Description
|-
| latest_release || [[#Releases|Release]]? || ✓ || ||
| The latest version of the mod available for download. Absent when the <code>namelist</code> [[#/api/mods|parameter]] is used.
|-
| downloads_count || Integer || ✓ || ✓ || ✓
| Number of downloads.
|-
| name || String || ✓ || ✓ || ✓
| The mod's machine-readable ID string.
|-
| owner || String || ✓ || ✓ || ✓
| The Factorio username of the mod's author.
|-
| releases || [[#Releases|Release]][] || ✓* || ✓ || ✓
| A list of different versions of the mod available for download. See [[#Releases]]. *Only when using <code>namelist</code> [[#/api/mods|parameter]].
|-
| summary || String || ✓ || ✓ || ✓
| A shorter mod description.
|-
| title || String || ✓ || ✓ || ✓
| The mod's human-readable name.
|-
| category || [[Mod_details_API#Category|Category]]? || ✓ || ✓ || ✓
| A single category describing the mod. See [[Mod_details_API#Category]].
|-
| thumbnail || String(relative URL) || || ✓ || ✓
| The relative path to the thumbnail of the mod. For mods that have no thumbnail it may be absent or default to <code>"/assets/.thumb.png"</code>. Prepend "assets-mod.factorio.com".
|-
| changelog || String || || || ✓
| A string describing the recent changes to a mod.
|-
| created_at || String(ISO 8601) || || || ✓
| ISO 8601 for when the mod was created.
|-
| description || String || || || ✓
| A longer description of the mod, in text only format.
|-
| source_url || String || || || ✓
| A URL to the mod's source code.
|-
| github_path || String || || || ✓
| Deprecated: Use <code>source_url</code> instead. A link to the mod's github project page, just prepend "github.com/". Can be blank ("").
|-
| homepage || String || || || ✓
| Usually a URL to the mod's main project page, but can be any string.
|-
| tags || [[#Tags|Tag]][] || || || ✓
| A list of tag names that categorize the mod. See [[#Tags]].
|-
| license || [[#License]][] || || || ✓
| The license that applies to the mod. See [[#License]].
|-
| deprecated || Boolean? || || || ✓
| <ref></ref>True if the mod is marked as deprecated by its owner. Absent when false.
|-
|}

=== Releases ===

Only difference here between the api/mods/{name} endpoint and the api/mods/{name}/full endpoint is that the full one includes an array of dependencies in the info_json object.

{| class="wikitable"
! Key !! Type !! Description
|-
| download_url || String
| Path to download for a mod. starts with "/download" and does not include a full url. See [[#Downloading Mods]]
|-
| file_name || String
| The file name of the release. Always seems to follow the pattern "{name}_{version}.zip"
|-
| info_json || Object
| A copy of the mod's info.json file, only contains factorio_version in short version, also contains an array of dependencies in full version
|-
| released_at || String(ISO 8601)
| ISO 8601 for when the mod was released.
|-
| version || String
| The version string of this mod release. Used to determine dependencies.
|-
| sha1 || String
| The sha1 key for the file
|-
|}

=== Tags ===

Currently, there are only a fixed number of tags available, these include:

{| class="wikitable"
! id !! type !! name !! title !! description
|-
| 12 || t || transportation || Transportation || Transportation of the player, be it vehicles or teleporters.
|-
| 13 || t || logistics || Logistics || Augmented or new ways of transporting materials - belts, inserters, pipes!
|-
| ?? || t || combat || Combat || New ways to deal with enemies, be it attack or defense.
|-
| 17 || t || enemies || Enemies || Changes to enemies or entirely new enemies to deal with.
|-
| 18 || t || armor || Armor || Armors or armor equipment.
|-
| ?? || t || environment || Environment || Map generation and terrain modification.
|-
| 20 || t || logistic-network || Logistics Network || Related to roboports and logistic robots
|-
| ?? || t || circuit-network || Circuit network || Entities which interact with the circuit network.
|-
| 21 || t || storage || Storage || More than just chests.
|-
| 22 || t || power || Power Production || Changes to power production and distribution.
|-
| 23 || t || manufacturing || Manufacture || Furnaces, assembling machines, production chains
|-
| 24 || t || blueprints || Blueprints || Change blueprint behavior.
|-
| 25 || t || cheats || Cheats || Play it your way.
|-
| 27 || t || mining || Mining || New ores and resources as well as machines.
|-
| ?? || t || fluids || Fluids || Things related to oil and other fluids.
|-
| 29 || t || trains || Trains || Trains are great, but what if they could do even more?
|}

=== License ===

{| class="wikitable"
! Key !! Type !! Description
|-
| description || String || A short description of the license.
|-
| id || String || The unique id of the license.
|-
| name || String || The internal name of the license.
|-
| title || String || The human-readable title of the license.
|-
| url || String || Usually a URL to the full license text, but can be any string.
|}

=== Error ===

{| class="wikitable"
! Key !! Type !! Description
|-
| message || String ||
|}

== Downloading Mods ==

You can get the full url by appending the download_url to mods.factorio.com, but if you're not authenticated, you will be redirected to mods.factorio.com/login. Logging in to that would give you access to the file. Fortunately, there's a better way to do this. Simply adding username and token parameters to the download url will prevent the redirecting and let you download the file immediately. The token can be acquired from a json file called "player-data.json", located in the User Data directory (see [[Application_directory#User_data_directory]]). You can also get the token by using the [[Web_authentication_API | Web Authentication API]].

Example usage:
https://mods.factorio.com/{download_url}?username={username}&token={token}

[[Category:Technical]]

Storage chest

2024-05-15T17:55:39Z

SpeckledFleebeedoo: fix typo

{{Languages}}
{{:Infobox:Storage chest}}

The '''storage chest''' is a large advanced storage item that is part of the [[logistic network]]. [[Logistic robot]]s store any items taken out of the [[Player|player's]] logistic trash slots here, as well as items picked up from [[active provider chest]]s. [[Construction robot]]s will use stored items to repair damaged entities and construct [[ghost]]s, as well as storing items picked up as a result of a [[deconstruction planner|deconstruction order]]; this includes the [[wood]]/[[stone]]/[[coal]] from [[tree]]s & [[rock]]s which were in the way of a ghost placement, and any items in other chests or on belts or inside buildings such as [[assembling machine]]s when they are marked for deconstruction. Storage chests can be filtered to only accept one type of item from the logistic network.

=== Notes ===
* Logistic robots will pick up items in the following priority: [[active provider chest]]s > storage chests, [[buffer chest]]s > [[passive provider chest]]s
* Logistic robots will begin to fill storage chests from active provider chests if there are no other tasks available.
* Logistic robots, and construction robots fulfilling deconstruction orders, will fill storage chests in the following priority:
*# Storage chests with a matching inventory
*# Storage chests with a matching filter
*# Storage chests with no filter and no inventory
*# Storage chests with no filter and a mismatched inventory
* The filter that can be set on the storage chest is respected even if items that are actively being pushed to the network can not be stored anywhere else.
* If a logistic robot carrying an item is unable to deliver its cargo (e.g. if the player moves out of range), it will drop its cargo in a storage chest before moving to other tasks.

[[File:storage_logistic_robots_anim.gif|frame|none|Logistic robots placing items in storage chests.]]

== Gallery ==
[[File:Storage chest gui.png|thumb|none|400px|Storage chest GUI.]]

== History ==
{{history|0.17.0|
* New, animated graphics.}}

{{history|0.16.8|
* Storage chests can be filtered.}}

{{history|0.15.28|
* Warning icon for logistic chests that are not in a reach of roboport.}}

{{history|0.13.0|
* All types of chests can be connected to the circuit network.}}

{{history|0.10.1|
* Changed the priority of resupplying source of logistic robots. Provider has biggest priority, then storage, and the last one is passive provider.}}

{{history|0.8.1|
* Keep the inventory limit of chests when fast rebuilding.}}

{{history|0.8.0|
* Chests inventory size can be limited.}}

{{history|0.7.0|
* Logistic robots try to not mix different items in storage chests if possible.}}

{{history|0.2.0|
* Introduced}}

== See also ==
* [[Circuit network]]
* [[Logistic network]]

{{LogisticsNav}}
{{C|Logistic network}}

Multiplayer

2024-05-01T20:34:21Z

SpeckledFleebeedoo: /* Dedicated/Headless server */ Add link to downloads page

{{Languages}}
[[File:players_colored_preview.png|190px|right]]In addition to being a single-player game, Factorio also supports multiplayer, allowing many [[player]]s to cooperate and assist each other, or work against each other in pvp. This page documents how to set up a multiplayer game, how to join one, and the Multiplayer Admin features for managing other users and the server. By default, multiplayer games run the CO-OP [[Game modes and options|freeplay scenario]] where all players work together to launch a rocket with a satellite into space. Other scenarios, including PvP maps, are available for download from the [https://forums.factorio.com/viewforum.php?f=36&sid=93d1fbe9336d31d6bac60847b6c97985 Maps and Scenarios forum].

== Setting Up a Multiplayer Game ==

[[File:multiplayer_game_night.png|thumb|250px|A multiplayer game.]]Multiplayer games can be joined, hosted while playing, or hosted by a dedicated server. Multiplayer games can be advertised to other players on the same LAN or worldwide.

To start playing a multiplayer game, select the Multiplayer button from the main menu. Then, choose one of these options to host and play:

* '''Host new game''': Specify the desired scenario, adjust the [[Map generator|map generator]] settings, and set the server visibility. The server visibility determines how your game will be advertised to other players. You can choose from:
** '''Public''': Your game will be listed on the public games list.
** '''Steam''': Enables or disables the "Join Game" feature through Steam.
** '''LAN''': Your game will be listed on your local network.
* '''Host saved game''': Pick a saved game from the list and set the server visibility as above.

To join an existing game, choose one of these options:

* '''Browse public games''': Search for and join any public game that meets your criteria.
* '''Browse LAN games''': Join any game that is hosted on your local network.
* '''Connect to address''': Join any game by entering the server’s IP address. This option is useful if the host does not use any server visibility.

Notes and tips:

* All game instances need the installation of ''exactly the same'' game-versions and mods.
* Factorio servers use port '''34197'''. The port can be changed in the [[Application directory|config]] file.
* Factorio uses '''UDP only'''. The game builds its own "reliable delivery" layer built on UDP to deal with packet loss and reordering issues.
** Make sure you configure your router's port forwarding correctly for port '''34197'''.
** Make sure your router does not [https://doc.pfsense.org/index.php/Static_Port randomize the source port] on packets outbound from '''34197'''. Some routers do this and require [https://forum.pfsense.org/index.php?PHPSESSID=3k4h9n5o2tksgqv910fknf7qt7&topic=142188.msg798594#msg798594 additional configuration] to prevent it.
** Make sure there is no firewall or anti-virus blocking the UDP-packets.
* The hard limit for the number of players is [https://forums.factorio.com/viewtopic.php?f=53&t=6481&p=50661#p50586 65,535]. However, practical limit for this is much lower, popular streamers have managed to get well over a hundred players.

=== Dedicated/Headless server ===

A dedicated (or headless) server can be started using the --start-server command line option. You can run factorio --help to get a list of all command-line arguments that Factorio accepts. Any version of the game can be run in headless mode, though for servers it may be preferable to use the Headless version of the game, which does not include graphics to reduce download size. This can be found on the [https://www.factorio.com/download factorio.com Downloads page].

In the headless mode:
* Graphics are not initialized (faster start up, less memory usage, works on completely headless servers)
* Game starts immediately and loads a save given as a parameter to the command
* The server has no character in game
* Game is paused while there are no players connected (though this can be overridden using the no-auto-pause option in the server-settings.json)
* Saves the game on exit (and autosaves normally)

''0.13 onwards expects --start-server to be followed by a path to a save file.''

You will need to create your save file before you start the server, as the dedicated server REQUIRES a save file to be provided. This can easily be done using the --create command-line argument. For example:

<pre>
./bin/x64/factorio --create ./saves/my-save.zip # This creates a new save, as if by clicking the New Game button in the GUI
</pre>

<pre>
./bin/x64/factorio --start-server ./saves/my-save.zip # This starts a server that will host the file created on the previous line
</pre>

There are several JSON configuration files that factorio can make use of to change the server and map settings:
* '''map-gen-settings''' to set parameters used by the [[map generator]] such as width and height, ore patch frequency and size, etc.
* '''map-settings''' to control [[pollution]] spread, [[Enemies#Expansions|biter expansion]] and [[evolution]], and more
* '''server-settings''' which consolidated several command-line options into a single file
Example files for each of these parameters are included in the data subdirectory, and are also visible on Wube's github here: https://github.com/wube/factorio-data

The --map-gen-settings and --map-settings options must be used with the --create option when you create a new map. For example:
<pre>./bin/x64/factorio --create saves/my-save.zip --map-gen-settings my-map-gen-settings.json --map-settings my-map-settings.json</pre>

Starting the factorio server requires you to specify the location of the server-settings.json file. By default this is in the factorio data folder. For example to start factorio using the most recent saved map, you would run:

<pre>./bin/x64/factorio --start-server-load-latest --server-settings ./data/server-settings.json</pre>

On windows, it may be useful to start the server with a .bat file. The bat file should have the following content:

<pre>start /wait .\bin\x64\factorio.exe --start-server-load-latest --server-settings .\data\server-settings.json</pre>

''See [[Command_line_parameters]] for more command line parameters.''

=== Setting up a Linux Factorio server ===

'''Note:''' Factorio now requires <tt>glibc</tt> version 2.18, but CentOS/RHEL 7 only ship with version 2.17 so this guide will no longer work without [https://forums.factorio.com/viewtopic.php?t=54654#p324493 manually compiling <tt>glibc</tt> 2.18].

This step-by-step guide has been verified on fresh CentOS 7 and RHEL 7 installs but should be applicable with little to no changes on most distributions.

The guide assumes you will install the headless server under '''/opt/factorio''', adjust paths according to your own setup. We will also suggest that you run the Factorio server as a separate user to harden security of your setup.

Note that there are two distinct packages for Linux that can be used to run a headless server. First is the usual Linux download, that contains the full game. The other is the special [https://www.factorio.com/download headless package]. The headless package does not contain any files irrelevant for a pure server, such as graphics and sounds. It is also not linked against libraries that may not be present on a server machine, such as Xlib, libGL or libasound. This option should be selected if running in a 3rd party hosted server.

This guide does not handle firewall/port forwarding since this can be done in various ways on Linux (make sure to read up how this is done as a Linux admin on your particular distribution)

==== Basic installation ====

* Download the selected package -- either full game or the headless package -- and upload the Linux tar.gz or tar.xz package to your server /tmp
* Extract the package in /tmp to /opt/factorio
<pre>
$cd /opt/

$sudo tar -xzf /tmp/factorio.tar.gz # Use the correct file name. It includes the factorio version number
$sudo tar -xJf /tmp/factorio.tar.xz # if you downloaded a .tar.xz file (ver 0.15.x)</pre>

* Add a new user to your system and assign ownership of the factorio dir to it (please, do not run as the root user, sudo may be needed)
<pre>
$useradd factorio
$chown -R factorio:factorio /opt/factorio</pre>

* Try the binary
<pre>
$su factorio
$/opt/factorio/bin/x64/factorio --start-server savename</pre>

As long as it fails saying it cannot find/open the savename.zip you are set! Just upload a save from your own computer and put it in the /opt/factorio/saves directory, or use the --create ./saves/newgame.zip argument.

=== How to list a server-hosted game on the matching server ===

In order to publish the game to the matching server, Factorio needs to be given some more information than just the save file location. These information are provided in a ''server settings file''.

To create a server settings file, look at the example file located in '''data/server-settings.example.json''' in the Factorio [[Application directory]]. The recommended way is to make a copy of this example file and edit the copy.

The following values can be changed:
; Name: This will be the name under which the server will be listed in the server browser
; Description: A description of your server. May contain up to 5000 characters. [https://factorio.com/blog/post/fff-304 MP server description]
; Tags: A list of game tags
; Max Players: Allows you to limit the number of players that can be connected to the server at the same time. If you want no limit, just set max_players to 0.
* Visibility for server browser: May be either public, LAN or hidden.
** Public: The server will appear in the public server list. This requires the login credentials below to be filled in.
** LAN: The server will not appear in the public server list, but will be available through the Play On LAN button
** Hidden: Clients will have to connect using the server's IP address
* User credentials using a username and password or authentication token (found on the factorio website or in the player-data.json): These are necessary if you wish to make the server public. Otherwise, they can be left empty.
** For security reasons it is recommended to use authentication token as this document is stored as plain text. Though it should be noted that an authentication token is a sensitive piece of information as well, and you are well-advised to keep it secret.
* Server Password
** Field name is game_password
* Whether to verify user identity
(There are additional values in v0.14 of factorio.)

=== Technical Implementation Details ===

Notes about some technical details surrounding multiplayer have been published by the development team in several Friday Facts blog posts:

* [http://www.factorio.com/blog/post/fff-76 Lock step architecture]
* [http://www.factorio.com/blog/post/fff-99 Client-server connections]
* [http://www.factorio.com/blog/post/fff-143 NAT punching, introduced in 0.13]

=== DNS SRV Records ===
Factorio supports [https://www.cloudflare.com/learning/dns/dns-records/dns-srv-record/ DNS SRV records] since 1.1.67.

This makes it easier to have multiple Factorio servers on a single host and allow users to connect to them with distinct subdomains instead of having to enter port numbers.

The service name is <code>_factorio</code> and it only supports <code>_udp</code> protocol.

'''Example:'''

<pre>
Domain: wube.software
IP: 192.0.2.2
Port: 34197

DNS records:
srv-target IN A 192.0.2.2
_factorio._udp IN SRV 0 0 34197 srv-target.wube.software.
</pre>

Now a Factorio client connecting to wube.software will actually connect to srv-target.wube.software:34197

'''Example screenshot:'''

[[File:Screenshot of SRV record settings Cloudflare dashboard.png]]

'''Log Entries:'''

* Factorio will log a "DNS SRV lookup returned [...]" message when it found a SRV record for the given domain
* With verbose logging Factorio will also log "DNS SRV lookup for [domain] didn't return any usable records" when there's no SRV record

=== Miscellaneous Tips ===
* The key for [[Console|console commands]] is also used initiate chat in multiplayer. To execute a command instead of chatting, you need to type ''/c'' before the command. Commands executed are ''visible to all players''. Additionally, the multiplayer game must have been started with commands allowable for commands to work.
* Set the player's color using the command
/color r g b
r, g and b are for red, green and blue respectively (possible values are between 0 and 1, use [https://www.w3schools.com/colors/colors_converter.asp this site] to convert colors to rgb numbers).
* To give yourself admin access, you need to create a server-adminlist.json in the same directory as factorio-current.log. The file should contain a list of admins, like so: <code>[ "user1", "user2" ]</code>

This file will be created if you promote a player through the console.

== Joining a Multiplayer game ==

As of version 0.13, players no longer necessarily have to port-forward to play with others. Players may join each other through Steam, or by just the port-forwarded host.

Players wishing to join a game may do so in multiple ways:

* Joining by directly inputting a public IP and port into Factorio.
* Selecting the server from the active public server menu.
* Joining through Steam's services.
* Playing a local LAN game.

=== Joining by IP ===

To join a multiplayer game by IP, you will need to know the public IP of a valid server. You can find this through social media, websites, or by word of mouth. After acquiring the IP and port, simply go to play -> Multiplayer -> Connect to server, and provide all the information it asks for.

If the server has been set up correctly to accept public connections, you should be able to join the game.

=== Joining via server list ===

Factorio's devs keep a list of all public servers that declare themselves to the service, allowing players to join directly through Factorio. Most of these servers will be password-requiring, but many completely public servers can be connected to. To join via server list, go to Play -> Multiplayer -> Browse public games. Provide your Factorio.com login if asked, and a list of public servers will appear. Simply select one.

=== Joining through Steam ===

Steam provides a "game invite" system, simply use that to join. You can find more info about how to use steam in it's documentation. ''This is the most recommended way for the average player to use multiplayer with their friends, as it allows Steam to handle everything''.

=== Joining a local LAN game ===

If you have some friends on the same internet connection as you (in the same building or network), you may play a LAN game. Simply go to Play -> Multiplayer -> Play on LAN.

=== Connecting to a Server Behind NAT ===

Factorio requires that the server (in client-server mode) have a publicly accessible IP address or that all players are on the same LAN. If you are behind NAT, you must set up port forwarding ([[Multiplayer#Playing_over_LAN_.2F_Internet|see above]] for port number) or use virtual LAN software such as Hamachi or Evolve.

Multiplayer games will be launched in client-server mode (also [http://www.factorio.com/blog/post/fff-99 multiplayer forwarding] mode). In this mode, all clients send their network traffic to the server and the server forwards the traffic to the other clients. The advantage of this is that it allows games where some players are inside a LAN and others are outside. The disadvantage may be slightly more lag as packets must travel an extra hop (through the server).

* [https://forums.factorio.com/viewtopic.php?f=53&t=6393 Forwarding ports without logging into your router]
* [https://forums.factorio.com/viewtopic.php?f=53&t=7714 A guide for connecting with Evolve]
* [http://steamcommunity.com/sharedfiles/filedetails/?id=653628496 A guide for connecting with Hamachi]

== PvP ==

In PvP mode, players can be on different forces. Each force can have one (free-for-all) or more players (teams). Each force has its own independent research progression. Additionally, each force's [[Military units and structures]] will attack other players as enemies, unless a cease fire is set. Note that, depending on the scenario, cease fires may be unidirectional — setting a cease fire with an opposing force does not guarantee a cease fire from them in return.

To start a PvP game, you can select the 'PvP' scenario from the 'Play' menu, or download a custom scenario which also supports PvP.

After downloading a PvP scenario, you need to move it to your application directory, and create the multiplayer game using the scenario.

# Download the scenario and place the scenario directory in the ''scenarios'' directory within your [[user data directory]].
# Launch Factorio
# Click ''Play''
# Click ''Multiplayer''
# Click ''Scenario''
# Choose the PvP scenario you want and click ''Create''
# Choose latency and other settings, then click ''Play''
# Other players can now join the game

=== Forces ===

Forces can be manually created via the console. This allows any map/scenario to be used for PvP. This may not be as convenient as a pre-made PvP scenario, as there will be no way for players to turn on/off cease fires other than through the console.

Each created force has its own research progression and different forces may attack each other.

The console commands for setting up and controlling forces are below:

<pre>
game.create_force("Name")
--Creates the force "Name"

game.players["Player_name"].force = game.forces["Name"]
--Sets this player to the new force

game.forces["Name"].set_cease_fire("Other_force_name", true)
--Sets the new force ceasefire to the "other force"

game.forces["Name"].set_spawn_position({x = 10, y = 20}, game.surfaces[1])
--Sets the spawn position of the force

game.print(#game.forces)
--Prints the number of forces

for name, force in pairs (game.forces) do
game.print(name)
end
--Prints the name of all the forces
</pre>

The ability of players and entities belonging to one force to interact with structures belonging to another, non-friendly force is limited. However, some types of interactions are still possible:

;Manual pickup from belts
: Players can pick up items traveling along a transport belt that belongs to an opposing force. Note however that this can't be automated: Inserters will ''not'' take items from an opposing force's belts.
;Belt network connection
: Belts will connect to each other regardless of force membership, so it's possible to extend an opposing force's belt line, and items will flow to them. It is also possible to side-load into, and place items onto (with inserters) an opposing force's belt line.
;Fluid network connection
: Pipes (and storage tanks, and pumps, &c) will connect to each other regardless of force membership. For example, it's possible to pump fluids out of or into a storage tank belonging to an opposing force.
;Power leeching
: Players can draw power from an opposing force's electric network, by building structures inside the coverage area of a power pole belonging to an opposing force. Power poles that you build next to a power pole belonging to an opposing force will automatically connect to it, but will be impossible to connect or disconnect manually.

== History ==

=== Narrative history ===

Because of the potentially immense amount of activity on a map, the game engine utilizes a [https://www.factorio.com/blog/post/fff-76 lock step architecture]. All instances of the game run full simulations of the entire world and only player actions are transferred across the network.

Multiplayer games were introduced to Factorio with version 0.11.0. The only connection method available was peer-to-peer mode which meant every player had to be able to directly communicate with every other player. In version 0.12.4, a client-server mode of communication was introduced in which the server (either a dedicated one or the player who hosted the game) relays messages to all peers. This means that direct connection between all players is no longer necessary. As of version 0.13, P2P connecting is completely removed.

As of version 0.12.0, the game features "latency hiding" mechanics where the game simulates some of the player's actions locally to make some common interactions (such as moving the player's character) more fluid. Not every action is a part of latency hiding – most notably, car or train driving and shooting are not a part of it.

=== Version history ===

Maintainer note: The following history may not be fully up to date, or comprehensive. Factorio's multiplayer has undergone a great deal of small changes since its inception, however this history will provide a rough overview.

{{history|0.14.14|
* Added multiplayer server option "Autosave only on server".
* Deconstructing/canceling deconstruction sets the "last user" on an entity.
* Decreased the size of connection accept message with lot of mod which could help some people with 50+ mod multiplayer games.
}}

{{history|0.14.13|
* Reconnecting to multiplayer game that the player is already in (due to being dropped, most often) instantly closes the previous connection and connects the player.}}

{{history|0.14.11|
* Multiplayer user names can only consist of letters, and <code> -_. </code> characters.}}

{{history|0.14.10|
* Disabled 32bit (x86) multiplayer. All hosts and members must be running the 64bit (x86_64) version of the game.}}

{{history|0.14.8|
* More than 10 players in one game will reduce the rate the game is saved to the server.}}

{{history|0.14.6|
* Username is now set to username setting, not email.}}

{{history|0.14.5|
* Added AFK Auto kick interval to multiplayer host settings (with never as default).}}

{{history|0.14.3|
* When save of scenario is loaded in multiplayer, it's scenario is saved in user scenarios.
* Added <code>/time</code> command to print the current map age.
* Added option to host multiplayer game with scenario (it only had new game/load game there).
}}

{{history|0.14.2|
* Can specify limit of upload speed when hosting.}}

{{history|0.14.0|
* Server doesn't stop/slow down the game when some client is too slow, stops communicating or saves the game longer than the server.
* Players automatically quit game after 3 desyncs.
* Removed the option to enable/disable latency hiding, it is always on on clients (and off on the server).
}}

{{history|0.13.10|
* Server stdout messages now contain time stamps and message-type tags}}

{{history|0.13.2|
* Limit multiplayer player name to 60 characters.}}

{{history|0.13.0|
* Improved Multiplayer game UX
* Server games are published to the server and clients can browse existing games.
* Removed multiplayer peer-to-peer mode.
* Building sound is played also for other players in multiplayer.
}}

{{history|0.12.31|
* Human readable error notice when multiplayer connection wasn't successful. (https://forums.factorio.com/23132)
* Improved map download speed when connecting to multiplayer game.}}

{{history|0.12.30|
* Mod checksums are calculated when the game starts and are compared with other peers when joining a multiplayer game. This is to ensure everyone has exactly the same mod in order to prevent desyncs caused by local changes made to mod files.}}

{{history|0.12.28|
* Added --port to specify which network port the game should use, when hosting with --start-server or --mp-load-game.}}

{{history|0.12.27|
* The report of different mods when trying to connect to multiplayer game is now scroll-able when needed.
* Better message when the server leaves a multiplayer game}}

{{history|0.12.11|
* Added --no-auto-pause: When running as a server, --no-auto-pause will prevent stopping the game when no players are connected.}}

{{history|0.12.9|
* Added resume button to multiplayer game menu}}

{{history|0.12.7|
*New command line options for the headless server: --disallow-commands and --peer-to-peer}}

{{history|0.12.5|
* Multiplayer broadcast (heartbeats) is done via a single message when not using peer2peer.
* Further optimizations in size of the Multiplayer heartbeat (message sent every tick).
* LatencyState is suspended when player is killed (and waiting for respawn) in Multiplayer.
}}

{{history|0.12.4|
* Simple mechanism for multiplayer relaying via the server.
* Less annoying glitches when running and shooting in multiplayer with latency hiding.}}

{{history|0.12.0|
* Multiplayer latency hiding (gives impression that some common tasks are performed immediately)
* Factorio can run as a dedicated server without graphics.
* Basic PvP: New forces can now be created and merged back together; a cease-fire can be agreed upon between forces
* IPv6 support for multiplayer.
* DNS names can be used when connecting to multiplayer game.
* Player's logistic filters are now remembered after respawn in multiplayer
* Smaller multiplayer heartbeat packet size.
}}

{{history|0.11.19|
* Multiplayer dropping threshold is doubled during map upload / download.}}

{{history|0.11.17|
* Autosaves in multiplayer are performed at the same time by all clients (interval is set by hosting player).
* Progress bar is shown when non-responsive peers are about to be dropped from the game in the Multiplayer.
* Progress bar is shown when other peers in multiplayer are saving map.}}

{{history|0.11.16|
* Revived character (after dying in multiplayer) are placed on the spawn point instead of the center of the map.}}

{{history|0.11.2|
* Mods that don't affect game state are not needed to be synchronized when playing multiplayer game or replaying game.}}

{{history|0.11.0|
* Introduced}}

{{C|Main}}

Talk:Main Page

2024-04-17T08:56:18Z

SpeckledFleebeedoo: fix signature

== Visual Reconstruction ==
I think this wiki looks boring as is. It should have more attractive colors instead of black text on a white screen...
[[User:Zippy|Zippy]] ([[User talk:Zippy|talk]]) 18:10, 3 May 2017 (UTC)

== Adding Languages ==

I'd like to see the other languages added to the Main Page. --[[User:Badg0n|Badg0n]] ([[User talk:Badg0n|talk]]) 14:25, 11 May 2016 (UTC)
:+1 --[[User:Bannert|Bannert]] ([[User talk:Bannert|talk]]) 11:32, 18 May 2016 (UTC)

==Main Page Overhaul==
The Wiki Page needs to be reorganized. It currently is a confusing mess and should be more organized for easier navigation. As i do not have access to edit this page i'll continue to add to other pages but i believe the real fixing of this WIKI would need to start at the root.
--[[User:ACryInShame|ACryInShame]] ([[User talk:ACryInShame|Talk]]) -12 Feb 2015 10:15 (EST) -5hr

:I read your forum-article and answered there http://factorioforums.com/forum/viewtopic.php?f=50&t=20029 [[User:Ssilk|Ssilk]] ([[User talk:Ssilk|talk]]) 17:18, 12 February 2016 (UTC)

==Adding Changelogs==
Shouldn't we add a changelog page and link it to the main one ?--[[User:Staxxy|Staxxy]] ([[User talk:Staxxy|talk]]) 22:53, 4 March 2013 (CET)
:It is actually linked on the main page as "Version History" under the "get the game" section. Not sure what the preference is on that name comparged to "Change Log". - [[User:BenWo|BenWo]] ([[User talk:BenWo|talk]]) 12:46, 16 May 2014 (CEST)

==Pages blueprint==
We would need to set up conventional presentations for pages depending of their topic.
For example, all pages covering weapons should be presented the same way, with the same organisation, ect...--[[User:Staxxy|Staxxy]] ([[User talk:Staxxy|talk]]) 23:14, 4 March 2013 (CET)
:I like this idea! We need standard templates for the big categories to make navigating easier. I'll certainly start work on this as time allows. [[User:BenWo|BenWo]] ([[User talk:BenWo|talk]]) 08:11, 15 May 2014 (CEST)
::Putting updates on my navbox work over on <nowiki>[[Talk:Wiki_To-do_List]]</nowiki> to save this for talk about the main page. - [[User:BenWo|BenWo]] ([[User talk:BenWo|talk]]) 12:35, 16 May 2014 (CEST)

==More content==

I started doing a bit of tweaking on the Main page over on [[User:BenWo/Main_Page]] to try and fit some more of these items. I've also moved all of the HTML off into some templates to keep it cleaner. Feel free to go over there and move bits around with whatever ideas you've got. :) - [[User:BenWo|BenWo]] ([[User talk:BenWo|talk]]) 12:44, 16 May 2014 (CEST)
:Moved over the new version of the Main page I worked on, cleaning up the source a ton using some templates. There's empty space in the center cell for the GUIDES section (see To-Do talk page, now linked in lower-right main page cell). Any suggestions or whatnot, please discuss!! [[User:BenWo|BenWo]] ([[User talk:BenWo|talk]]) 13:54, 25 May 2014 (CEST)

=== Top right box ===

* Link to the list of News (Friday Facts, Random Ramblings...)

=== Left box ===

* What it is (short explanation)

* [[Let's play]] page
http://www.factorioforums.com/forum/viewtopic.php?f=19&t=829

* Beginners Guide
(Sub-pages:
** Joseki (Good starting moves)
** The first day
** Exploring the map
** Electric Power
** Crafting
** Research
** Red&Green Potion
** Weapons&Armour
** Blue Potion
** Car
** Logistic Bots
** Train
** And bejond?)

=== Center + right Box ===

(Items, Networks, Special, Concept) is one big point in the center.

=== Left lower box ===

* FAQ

* Map-Editor
** Convert map to Scenario

* Game-Options
** Key-Defaults

* Contributing
(
** For this wiki
** Link to mods
)

...

== "Before you play" ==

The main page has "Console" under "Before you play". I don't think it's appropriate for that section. --[[User:Glyph|Glyph]] ([[User talk:Glyph|talk]]) 15:27, 13 August 2014 (CEST)

: Fixed. You are allowed to make such changes. This is a wiki. :) [[User:Ssilk|Ssilk]] ([[User talk:Ssilk|talk]]) 23:40, 13 August 2014 (CEST)

:: Thanks! I am hesitant to edit the main page because I would start to move everything around and couldn't stop! --[[User:Glyph|Glyph]] ([[User talk:Glyph|talk]]) 09:55, 14 August 2014 (CEST)

::: There is the "restore previous version"-button. :) Currrently I think the amount of links to other pages has reached a limit, the lower, the better. [[User:Ssilk|Ssilk]] ([[User talk:Ssilk|talk]]) 19:39, 15 August 2014 (CEST)

== Contributors ==

Suggestion: Remove the contributors (currently only the translators) from the main page and move it to "Contributors"-page.

Anything against?
:Support - I indeed think this should not be on the main page, but also not on another page. A wiki is for people to work together, so everyone contributes to it, why only display a few names? [[User:TheWombatGuru|TheWombatGuru]] ([[User talk:TheWombatGuru|talk]]) 07:54, 29 August 2014 (CEST)
:: Indeed. I think removing the names is logical for a wiki, cause the changes can be seen in the history. I will put this into the forum, too and wait and if nobody has anything against I'll remove that... [[User:Ssilk|Ssilk]] ([[User talk:Ssilk|talk]]) 13:12, 31 August 2014 (CEST)
::: I made a change to this section, is this a good alternative? [[User:TheWombatGuru|TheWombatGuru]] ([[User talk:TheWombatGuru|talk]]) 00:14, 4 October 2014 (CEST)
:::: I think yes, but now I have a question — how is it works? And what should I do to insert local names of the languages to the list? E.g. Czech lang is "Чеська", English lang is "Англійська", French is "Французька", etc (by Ukrainian language). I was trying to use the new template in [[Main_Page/uk]] but the brackets after a language's self-name are empty... --[[User:Vitduo|Vitduo]] ([[User talk:Vitduo|talk]]) 16:16, 4 October 2014 (CEST)
::::: I saw you already figured out how, thanks for extending the template :) [[User:TheWombatGuru|TheWombatGuru]] ([[User talk:TheWombatGuru|talk]]) 16:35, 4 October 2014 (CEST)

== New "Around the game" introduced ==

I'm not so sure, if that was a good idea. My normal way would be to change it and then look at it in some days/weeks, but with more wikianers I could just ask. So maybe, this Main page gets a little bit to big now? If so, please make suggestions or change it. :) [[User:Ssilk|Ssilk]] ([[User talk:Ssilk|talk]]) 23:37, 18 October 2014 (CEST)
: I think it's good like this, good editing :) [[User:TheWombatGuru|TheWombatGuru]] ([[User talk:TheWombatGuru|talk]]) 00:50, 19 October 2014 (CEST)

== Old News Showing If Not Logged In ==

Users who are not logged in to the wiki are not seeing the latest news in the News block. You can confirm this by logging out and going to the [[Main Page]]. The latest piece of news visible is "Mar 18 FFF #130: Steam release side effects."

As soon as you log in, the current news from the [[News]] page is shown instead. Does anyone have any idea what needs to be fixed so that people aren't seeing out-of-date news?

--[[User:CyberPhantom|CyberPhantom]] ([[User talk:CyberPhantom|talk]]) 16:32, 19 June 2016 (UTC)

::For the admins: this looks like it's being caused by the MediaWiki file cache. This cache only applies to anonymous (not logged in) users. According to [https://www.mediawiki.org/wiki/Manual:File_cache#Expiration the MediaWiki documentation], running the [https://wiki.factorio.com/index.php?title=Main_Page&action=purge purge action] should expire the cache and fix the problem. I tried that, and it didn't help. Maybe an admin needs to do it for it to work on the Main Page? Or maybe something else is preventing the file cache from clearing? --[[User:CyberPhantom|CyberPhantom]] ([[User talk:CyberPhantom|talk]])

== Change icons' image file names ==

Change icons' image file names from "fast-inserter.png" to "Fast inserter icon.png". (for obvious reasons)

Steps:
* This topic gets 5 +1 (so it's approved)
* Generate the renamed files (already done [https://drive.google.com/open?id=0B86I6c-Ld37oWjUtaGlGU1padVU]) and upload
* Change the code at the [[Template:Icon]] (I can make it backward compatible)
* Done

== Link to preorderpage no more active http://www.factorio.com/preorder ==

Should be changed to http://www.factorio.com

== Wrong link ==
On the Community-spitter there is a mistake, it says "ink=" so there ist missing the letter "l" to set no link. As I'm just a normal user I'm not allowed to fix this, so somebody else has to do this. -- [[User:RobbiRobb|RobbiRobb]] ([[User talk:RobbiRobb|talk]]) 13:45, 20 April 2017 (UTC)
:Thanks, I fixed it :) --[[User:Bilka|Bilka]] ([[User talk:Bilka|talk]]) 13:51, 20 April 2017 (UTC)
::Thanks :D -- [[User:RobbiRobb|RobbiRobb]] ([[User talk:RobbiRobb|talk]]) 14:38, 20 April 2017 (UTC)

== Items and Recipes (Are they the same or different?) ==

I think the heading label "Items and Recipes" should be a link to the Items page ([https://wiki.factorio.com/Items]). Also, either "Recipes" needs to redirect to that page or it needs its own. Personally, I think "Recipes" and "Items" are functionally the same from a user standpoint, so I would use a redirect. For obvious (and good!) reasons, I cannot make the link edit myself. As for the redirect, I will wait for an OK from an admin, primarily so they don't have to delete it.

--[[User:Sonicthe|Sonicthe]] ([[User talk:Sonicthe|talk]]) 17:56, 26 July 2020 (UTC)
: Items and recipes are very different things, since the one is produced by the other. The icons that are currently shown on the main page and on [[items]] are items, fluids and recipes. This makes both the main page heading and the items page somewhat misleading. It may be better to find heading that fits properly and move all the content there (e.g. "Materials and recipes"). Could you explain why we need a recipes page/redirect? I'd also like to hear your reasoning for linking to the items page from the main page, since it contains a direct subset of the main page content. -- [[User:Bilka|Bilka]] ([[User talk:Bilka|talk]]) - <span style="color:#FF0000">Admin</span> 08:33, 27 July 2020 (UTC)

:: To respond in reverse order of your questions, maybe a better question is "Why is there an items page?" rather than having the search result in the bottom of the main page. I like your idea of renaming the section, although if an infobox appeared on mouse-over (like on the right-hand side of the page, NOT alt-text/tooltip) with just the Normal recipe for the highlighted item (which would be really cool, but a pain to do!) the "Items and Recipes" would make sense. You would have icons for items and a box with the corresponding recipe in it. I'm not suggesting putting all of the information contained on the individual item pages here (duplicating work is silly), and it's not something I expect to see any time soon (if ever). It would just be cool.

:: And perhaps it would be better to change the section on the main page to a link to [[items]] and provide the recipe infobox (or not) there instead. I assumed there was a reason to have the entire set of icons on the main page, but maybe that assumption is false.

:: My reasoning for a "Recipe" redirect is as much error trapping as anything else. Searching for "Items" returns [[items]], but searching for "Recipes" returns a generic search results page. While I agree that you and I know there is a real difference between an item and a recipe, I'm not sure the average user will really understand (or care about!) that distinction, especially after release. Ultimately, I guess the real question is what you think the average user is looking for when they search for "Recipes" vs. "Items". That's it. A simple page that describes what a recipe is and has a link to [[items]] would be better if you think the distinction is important. Or a single page with every recipe on it might be something to think about. Which one depends on your opinion, I think.

:: As something of a side note, I mention the infobox idea because the first time I used the wiki, that's kind of what I was looking for. I wanted just the recipes for several items, and having to click each one, and then back, and then the next, and back, and so on is a pain. At the time, I wasn't looking for all the other information that each page contained, just the ingredients I needed to make each item. I realize that all of this information is available in-game and on individual pages here, which is why I would call it "Nice to have" and "Cool" but not "High priority" or even "Medium priority," and certainly not "Needed." And I think a "Recipes" page with all the recipes listed might be better (and definitely easier) than a changing infobox. -- [[User:Sonicthe|Sonicthe]] ([[User talk:Sonicthe|talk]]) 18:43, 27 July 2020 (UTC)

::: Good question :) The 'real' reason is that the page existed when I started on the wiki, so it keep existing even as most of its content moved to other pages. I would not remove it now, because sometimes having an external link to just the crafting overview is great and the main page does not work very well for that. I like your idea with the infoboxes, it should be doable.

::: Having all items/recipes/fluids on the main page is a great entry-point for the wiki, so I think it will stay there unless an even better way to display all items/recipes/fluids is found.

::: I think you have a good point with the search. We even used have a "liquid" redirect going to the "fluid system" page (which I deleted at some point), which in the same search term 'group' as "recipes" and "items". I have an idea how to solve the naming problem: Move the current "items" to "materials and recipes". Redirect "recipes" and "items" to "materials and recipes" and also link there from the main page. Redirect "fluids" to "fluid system" or make it a disambiguation page linking both "fluid system" and "material and recipes". What do you think about this?

::: Just wanting the recipes is a common theme. We have had the idea to make the tooltips of the item icons list their recipes for a pretty long time now, however, I think your infobox idea is better and may also be easier to implement. However, currently just getting the wiki up-to-date for 1.0 is taking priority over extra features.

::: Thank you for detailed feedback, it is always useful to hear such a well reasoned opinion about parts of the wiki. -- [[User:Bilka|Bilka]] ([[User talk:Bilka|talk]]) - <span style="color:#FF0000">Admin</span> 11:48, 6 August 2020 (UTC)

:::: I like disambiguation pages in general because they always give me what I'm looking for and other related things, too. Anything that increases my knowledge and understanding is great! And I think "Materials and Recipes" more accurately captures what we are talking about than "Items" does, too.

:::: I would use whichever method is the easiest to implement, if you're thinking about doing it now. Especially with the focus appropriately on accuracy for 1.0. Personally, I would probably wait until after 1.0 regardless of which method is ultimately chosen. Accuracy should always be more important than features. Information that ''might'' be mislabeled or "hard to find" is much better than information that is '''wrong'''. I am about to start Graduate School, so unfortunately, I won't have time to do much myself. -- [[User:Sonicthe|Sonicthe]] ([[User talk:Sonicthe|talk]]) 18:16, 6 August 2020 (UTC)
::::: I have created the new organization that I suggested, I hope it works out. The further recipe details on the main page will be a future feature :) -- [[User:Bilka|Bilka]] ([[User talk:Bilka|talk]]) - <span style="color:#FF0000">Admin</span> 10:36, 17 August 2020 (UTC)

== Adding other unofficial communities ==

Suggestion: Under the "Unofficial Communities" links, would it be appropriate to add more communities? Specifically, I would like to add a link to [https://alt-f4.blog/ Alt-F4] the community-driven blog. I have not been able to find previous discussions about this. --[[User:Sir Fendi|Sir Fendi]] ([[User talk:Sir Fendi|talk]]) 14:41, 10 May 2022 (UTC)
: Hey, we only link to unofficial communities that are also linked on the [https://factorio.com/ factorio.com main page] (section in the bottom right of the page). The Alt-F4 blog is not linked there. -- [[User:Bilka|Bilka]] ([[User talk:Bilka|talk]]) - <span style="color:#FF0000">Admin</span> 15:34, 12 May 2022 (UTC)

== Update new content section ==

The New content section at the bottom of the page could probably use an update to add some of the features 1.1 has added to the game since the 1.0 release. -- [[User:SpeckledFleebeedoo|SpeckledFleebeedoo]] ([[User talk:SpeckledFleebeedoo|talk]]) 08:55, 17 April 2024 (UTC)

Talk:Main Page

2024-04-17T08:55:33Z

SpeckledFleebeedoo: /* Update new content section */ new section

== Visual Reconstruction ==
I think this wiki looks boring as is. It should have more attractive colors instead of black text on a white screen...
[[User:Zippy|Zippy]] ([[User talk:Zippy|talk]]) 18:10, 3 May 2017 (UTC)

== Adding Languages ==

I'd like to see the other languages added to the Main Page. --[[User:Badg0n|Badg0n]] ([[User talk:Badg0n|talk]]) 14:25, 11 May 2016 (UTC)
:+1 --[[User:Bannert|Bannert]] ([[User talk:Bannert|talk]]) 11:32, 18 May 2016 (UTC)

==Main Page Overhaul==
The Wiki Page needs to be reorganized. It currently is a confusing mess and should be more organized for easier navigation. As i do not have access to edit this page i'll continue to add to other pages but i believe the real fixing of this WIKI would need to start at the root.
--[[User:ACryInShame|ACryInShame]] ([[User talk:ACryInShame|Talk]]) -12 Feb 2015 10:15 (EST) -5hr

:I read your forum-article and answered there http://factorioforums.com/forum/viewtopic.php?f=50&t=20029 [[User:Ssilk|Ssilk]] ([[User talk:Ssilk|talk]]) 17:18, 12 February 2016 (UTC)

==Adding Changelogs==
Shouldn't we add a changelog page and link it to the main one ?--[[User:Staxxy|Staxxy]] ([[User talk:Staxxy|talk]]) 22:53, 4 March 2013 (CET)
:It is actually linked on the main page as "Version History" under the "get the game" section. Not sure what the preference is on that name comparged to "Change Log". - [[User:BenWo|BenWo]] ([[User talk:BenWo|talk]]) 12:46, 16 May 2014 (CEST)

==Pages blueprint==
We would need to set up conventional presentations for pages depending of their topic.
For example, all pages covering weapons should be presented the same way, with the same organisation, ect...--[[User:Staxxy|Staxxy]] ([[User talk:Staxxy|talk]]) 23:14, 4 March 2013 (CET)
:I like this idea! We need standard templates for the big categories to make navigating easier. I'll certainly start work on this as time allows. [[User:BenWo|BenWo]] ([[User talk:BenWo|talk]]) 08:11, 15 May 2014 (CEST)
::Putting updates on my navbox work over on <nowiki>[[Talk:Wiki_To-do_List]]</nowiki> to save this for talk about the main page. - [[User:BenWo|BenWo]] ([[User talk:BenWo|talk]]) 12:35, 16 May 2014 (CEST)

==More content==

I started doing a bit of tweaking on the Main page over on [[User:BenWo/Main_Page]] to try and fit some more of these items. I've also moved all of the HTML off into some templates to keep it cleaner. Feel free to go over there and move bits around with whatever ideas you've got. :) - [[User:BenWo|BenWo]] ([[User talk:BenWo|talk]]) 12:44, 16 May 2014 (CEST)
:Moved over the new version of the Main page I worked on, cleaning up the source a ton using some templates. There's empty space in the center cell for the GUIDES section (see To-Do talk page, now linked in lower-right main page cell). Any suggestions or whatnot, please discuss!! [[User:BenWo|BenWo]] ([[User talk:BenWo|talk]]) 13:54, 25 May 2014 (CEST)

=== Top right box ===

* Link to the list of News (Friday Facts, Random Ramblings...)

=== Left box ===

* What it is (short explanation)

* [[Let's play]] page
http://www.factorioforums.com/forum/viewtopic.php?f=19&t=829

* Beginners Guide
(Sub-pages:
** Joseki (Good starting moves)
** The first day
** Exploring the map
** Electric Power
** Crafting
** Research
** Red&Green Potion
** Weapons&Armour
** Blue Potion
** Car
** Logistic Bots
** Train
** And bejond?)

=== Center + right Box ===

(Items, Networks, Special, Concept) is one big point in the center.

=== Left lower box ===

* FAQ

* Map-Editor
** Convert map to Scenario

* Game-Options
** Key-Defaults

* Contributing
(
** For this wiki
** Link to mods
)

...

== "Before you play" ==

The main page has "Console" under "Before you play". I don't think it's appropriate for that section. --[[User:Glyph|Glyph]] ([[User talk:Glyph|talk]]) 15:27, 13 August 2014 (CEST)

: Fixed. You are allowed to make such changes. This is a wiki. :) [[User:Ssilk|Ssilk]] ([[User talk:Ssilk|talk]]) 23:40, 13 August 2014 (CEST)

:: Thanks! I am hesitant to edit the main page because I would start to move everything around and couldn't stop! --[[User:Glyph|Glyph]] ([[User talk:Glyph|talk]]) 09:55, 14 August 2014 (CEST)

::: There is the "restore previous version"-button. :) Currrently I think the amount of links to other pages has reached a limit, the lower, the better. [[User:Ssilk|Ssilk]] ([[User talk:Ssilk|talk]]) 19:39, 15 August 2014 (CEST)

== Contributors ==

Suggestion: Remove the contributors (currently only the translators) from the main page and move it to "Contributors"-page.

Anything against?
:Support - I indeed think this should not be on the main page, but also not on another page. A wiki is for people to work together, so everyone contributes to it, why only display a few names? [[User:TheWombatGuru|TheWombatGuru]] ([[User talk:TheWombatGuru|talk]]) 07:54, 29 August 2014 (CEST)
:: Indeed. I think removing the names is logical for a wiki, cause the changes can be seen in the history. I will put this into the forum, too and wait and if nobody has anything against I'll remove that... [[User:Ssilk|Ssilk]] ([[User talk:Ssilk|talk]]) 13:12, 31 August 2014 (CEST)
::: I made a change to this section, is this a good alternative? [[User:TheWombatGuru|TheWombatGuru]] ([[User talk:TheWombatGuru|talk]]) 00:14, 4 October 2014 (CEST)
:::: I think yes, but now I have a question — how is it works? And what should I do to insert local names of the languages to the list? E.g. Czech lang is "Чеська", English lang is "Англійська", French is "Французька", etc (by Ukrainian language). I was trying to use the new template in [[Main_Page/uk]] but the brackets after a language's self-name are empty... --[[User:Vitduo|Vitduo]] ([[User talk:Vitduo|talk]]) 16:16, 4 October 2014 (CEST)
::::: I saw you already figured out how, thanks for extending the template :) [[User:TheWombatGuru|TheWombatGuru]] ([[User talk:TheWombatGuru|talk]]) 16:35, 4 October 2014 (CEST)

== New "Around the game" introduced ==

I'm not so sure, if that was a good idea. My normal way would be to change it and then look at it in some days/weeks, but with more wikianers I could just ask. So maybe, this Main page gets a little bit to big now? If so, please make suggestions or change it. :) [[User:Ssilk|Ssilk]] ([[User talk:Ssilk|talk]]) 23:37, 18 October 2014 (CEST)
: I think it's good like this, good editing :) [[User:TheWombatGuru|TheWombatGuru]] ([[User talk:TheWombatGuru|talk]]) 00:50, 19 October 2014 (CEST)

== Old News Showing If Not Logged In ==

Users who are not logged in to the wiki are not seeing the latest news in the News block. You can confirm this by logging out and going to the [[Main Page]]. The latest piece of news visible is "Mar 18 FFF #130: Steam release side effects."

As soon as you log in, the current news from the [[News]] page is shown instead. Does anyone have any idea what needs to be fixed so that people aren't seeing out-of-date news?

--[[User:CyberPhantom|CyberPhantom]] ([[User talk:CyberPhantom|talk]]) 16:32, 19 June 2016 (UTC)

::For the admins: this looks like it's being caused by the MediaWiki file cache. This cache only applies to anonymous (not logged in) users. According to [https://www.mediawiki.org/wiki/Manual:File_cache#Expiration the MediaWiki documentation], running the [https://wiki.factorio.com/index.php?title=Main_Page&action=purge purge action] should expire the cache and fix the problem. I tried that, and it didn't help. Maybe an admin needs to do it for it to work on the Main Page? Or maybe something else is preventing the file cache from clearing? --[[User:CyberPhantom|CyberPhantom]] ([[User talk:CyberPhantom|talk]])

== Change icons' image file names ==

Change icons' image file names from "fast-inserter.png" to "Fast inserter icon.png". (for obvious reasons)

Steps:
* This topic gets 5 +1 (so it's approved)
* Generate the renamed files (already done [https://drive.google.com/open?id=0B86I6c-Ld37oWjUtaGlGU1padVU]) and upload
* Change the code at the [[Template:Icon]] (I can make it backward compatible)
* Done

== Link to preorderpage no more active http://www.factorio.com/preorder ==

Should be changed to http://www.factorio.com

== Wrong link ==
On the Community-spitter there is a mistake, it says "ink=" so there ist missing the letter "l" to set no link. As I'm just a normal user I'm not allowed to fix this, so somebody else has to do this. -- [[User:RobbiRobb|RobbiRobb]] ([[User talk:RobbiRobb|talk]]) 13:45, 20 April 2017 (UTC)
:Thanks, I fixed it :) --[[User:Bilka|Bilka]] ([[User talk:Bilka|talk]]) 13:51, 20 April 2017 (UTC)
::Thanks :D -- [[User:RobbiRobb|RobbiRobb]] ([[User talk:RobbiRobb|talk]]) 14:38, 20 April 2017 (UTC)

== Items and Recipes (Are they the same or different?) ==

I think the heading label "Items and Recipes" should be a link to the Items page ([https://wiki.factorio.com/Items]). Also, either "Recipes" needs to redirect to that page or it needs its own. Personally, I think "Recipes" and "Items" are functionally the same from a user standpoint, so I would use a redirect. For obvious (and good!) reasons, I cannot make the link edit myself. As for the redirect, I will wait for an OK from an admin, primarily so they don't have to delete it.

--[[User:Sonicthe|Sonicthe]] ([[User talk:Sonicthe|talk]]) 17:56, 26 July 2020 (UTC)
: Items and recipes are very different things, since the one is produced by the other. The icons that are currently shown on the main page and on [[items]] are items, fluids and recipes. This makes both the main page heading and the items page somewhat misleading. It may be better to find heading that fits properly and move all the content there (e.g. "Materials and recipes"). Could you explain why we need a recipes page/redirect? I'd also like to hear your reasoning for linking to the items page from the main page, since it contains a direct subset of the main page content. -- [[User:Bilka|Bilka]] ([[User talk:Bilka|talk]]) - <span style="color:#FF0000">Admin</span> 08:33, 27 July 2020 (UTC)

:: To respond in reverse order of your questions, maybe a better question is "Why is there an items page?" rather than having the search result in the bottom of the main page. I like your idea of renaming the section, although if an infobox appeared on mouse-over (like on the right-hand side of the page, NOT alt-text/tooltip) with just the Normal recipe for the highlighted item (which would be really cool, but a pain to do!) the "Items and Recipes" would make sense. You would have icons for items and a box with the corresponding recipe in it. I'm not suggesting putting all of the information contained on the individual item pages here (duplicating work is silly), and it's not something I expect to see any time soon (if ever). It would just be cool.

:: And perhaps it would be better to change the section on the main page to a link to [[items]] and provide the recipe infobox (or not) there instead. I assumed there was a reason to have the entire set of icons on the main page, but maybe that assumption is false.

:: My reasoning for a "Recipe" redirect is as much error trapping as anything else. Searching for "Items" returns [[items]], but searching for "Recipes" returns a generic search results page. While I agree that you and I know there is a real difference between an item and a recipe, I'm not sure the average user will really understand (or care about!) that distinction, especially after release. Ultimately, I guess the real question is what you think the average user is looking for when they search for "Recipes" vs. "Items". That's it. A simple page that describes what a recipe is and has a link to [[items]] would be better if you think the distinction is important. Or a single page with every recipe on it might be something to think about. Which one depends on your opinion, I think.

:: As something of a side note, I mention the infobox idea because the first time I used the wiki, that's kind of what I was looking for. I wanted just the recipes for several items, and having to click each one, and then back, and then the next, and back, and so on is a pain. At the time, I wasn't looking for all the other information that each page contained, just the ingredients I needed to make each item. I realize that all of this information is available in-game and on individual pages here, which is why I would call it "Nice to have" and "Cool" but not "High priority" or even "Medium priority," and certainly not "Needed." And I think a "Recipes" page with all the recipes listed might be better (and definitely easier) than a changing infobox. -- [[User:Sonicthe|Sonicthe]] ([[User talk:Sonicthe|talk]]) 18:43, 27 July 2020 (UTC)

::: Good question :) The 'real' reason is that the page existed when I started on the wiki, so it keep existing even as most of its content moved to other pages. I would not remove it now, because sometimes having an external link to just the crafting overview is great and the main page does not work very well for that. I like your idea with the infoboxes, it should be doable.

::: Having all items/recipes/fluids on the main page is a great entry-point for the wiki, so I think it will stay there unless an even better way to display all items/recipes/fluids is found.

::: I think you have a good point with the search. We even used have a "liquid" redirect going to the "fluid system" page (which I deleted at some point), which in the same search term 'group' as "recipes" and "items". I have an idea how to solve the naming problem: Move the current "items" to "materials and recipes". Redirect "recipes" and "items" to "materials and recipes" and also link there from the main page. Redirect "fluids" to "fluid system" or make it a disambiguation page linking both "fluid system" and "material and recipes". What do you think about this?

::: Just wanting the recipes is a common theme. We have had the idea to make the tooltips of the item icons list their recipes for a pretty long time now, however, I think your infobox idea is better and may also be easier to implement. However, currently just getting the wiki up-to-date for 1.0 is taking priority over extra features.

::: Thank you for detailed feedback, it is always useful to hear such a well reasoned opinion about parts of the wiki. -- [[User:Bilka|Bilka]] ([[User talk:Bilka|talk]]) - <span style="color:#FF0000">Admin</span> 11:48, 6 August 2020 (UTC)

:::: I like disambiguation pages in general because they always give me what I'm looking for and other related things, too. Anything that increases my knowledge and understanding is great! And I think "Materials and Recipes" more accurately captures what we are talking about than "Items" does, too.

:::: I would use whichever method is the easiest to implement, if you're thinking about doing it now. Especially with the focus appropriately on accuracy for 1.0. Personally, I would probably wait until after 1.0 regardless of which method is ultimately chosen. Accuracy should always be more important than features. Information that ''might'' be mislabeled or "hard to find" is much better than information that is '''wrong'''. I am about to start Graduate School, so unfortunately, I won't have time to do much myself. -- [[User:Sonicthe|Sonicthe]] ([[User talk:Sonicthe|talk]]) 18:16, 6 August 2020 (UTC)
::::: I have created the new organization that I suggested, I hope it works out. The further recipe details on the main page will be a future feature :) -- [[User:Bilka|Bilka]] ([[User talk:Bilka|talk]]) - <span style="color:#FF0000">Admin</span> 10:36, 17 August 2020 (UTC)

== Adding other unofficial communities ==

Suggestion: Under the "Unofficial Communities" links, would it be appropriate to add more communities? Specifically, I would like to add a link to [https://alt-f4.blog/ Alt-F4] the community-driven blog. I have not been able to find previous discussions about this. --[[User:Sir Fendi|Sir Fendi]] ([[User talk:Sir Fendi|talk]]) 14:41, 10 May 2022 (UTC)
: Hey, we only link to unofficial communities that are also linked on the [https://factorio.com/ factorio.com main page] (section in the bottom right of the page). The Alt-F4 blog is not linked there. -- [[User:Bilka|Bilka]] ([[User talk:Bilka|talk]]) - <span style="color:#FF0000">Admin</span> 15:34, 12 May 2022 (UTC)

== Update new content section ==

The New content section at the bottom of the page could probably use an update to add some of the features 1.1 has added to the game since the 1.0 release. [[User:SpeckledFleebeedoo|SpeckledFleebeedoo]] ([[User talk:SpeckledFleebeedoo|talk]]) 08:55, 17 April 2024 (UTC)

Stack

2024-01-26T19:33:22Z

SpeckledFleebeedoo: Add LDS to stack size table

{{Languages}}
[[File:inventory_stacks.png|thumb|408px|right|Many stacks in the player's inventory.]]A stack is the basic element in Factorio to store items. One space in an inventory can hold one stack.

== Examples of stacks ==

* The [[player|player's]] inventory
** Main inventory
** Armor, weapon, and ammunition stacks
** Logistic trash slots
** The player's hand (is also a stack)
* [[Vehicle]]s
** [[Car]] (fuel, ammunition, inventory)
** [[Tank]] (fuel, ammunition, inventory)
** [[Spidertron]] (ammunition, inventory)
** [[Railway|Train]] (wagons, engines for fuel)
* [[Chests]]: The archetypal example of stacks outside the player's inventory; a chest is basically just a group of stacks.
* Devices
** [[Furnace]]: Burner stack ([[Stone furnace|stone]] and [[Steel furnace|steel]] furnace only), input and output stack
** [[Assembling machine]]s and [[chemical plant]]s: 1 or more output and 1-6 input stacks, depending on item type being assembled
** [[Lab|Labs]]
** Burner-based: [[Boiler]], [[burner mining drill]], [[burner inserter]]
** [[Roboport]] (filtered for robots and repair packs only)
** [[Gun turret]]
* Special
** [[Inserters]] and [[Robots|worker robots]] (Small, variable-size stacks allow these entities to move items between other stacks. See also the [[Inserter capacity bonus (research)|inserter]] and [[Worker robot cargo size (research)|robot]] stack size bonus research topics.)

== How do stacks work? ==

A stack can store a number of identical items.

The first inserted item determines which item types can be stored. This also indirectly determines how many items can be stored in the stack, as this depends on the item type's maximum stack size.

Only items can be stored within stacks; stacks cannot hold [[Fluid system|liquids]] or other entity types.

=== Stack size ===

The number of items a stack can store. Stack size depends on the item; existing stack sizes and (non-exhaustive) examples include (click to expand):

{| class="wikitable mw-collapsible mw-collapsed"
!style="width: 100px;" |Stack size
!Examples 
|-
| 1 || [[Nuclear fuel]], [[artillery shell]], [[satellite]], [[modular armor]], [[blueprint]].
|-
| 5 || [[Locomotive]], all [[Wagon|wagons]].
|-
| 10 || [[Roboport]], [[rocket fuel]], [[artillery turret]], [[atomic bomb]], [[low density structure]].
|-
| 20 || Some [[equipment modules]], [[pumpjack]]s.
|-
| 50 || All ores, [[stone]], [[coal]], all [[Module|modules]], [[electric mining drill]], [[electric furnace]], all [[Assembling machine|assemblers]], all [[chests]], all [[inserters]], [[gun turret]], [[laser turret]], all [[Electric_system#Distribution|power poles]] including [[substation]], both types of [[Robots|worker robots]], [[solid fuel]].
|-
| 100 || [[Iron plate]], [[copper plate]], [[steel plate]], [[processing unit]], [[iron gear wheel]], [[stone brick]], all types of [[concrete]], both isotopes of [[Uranium processing|processed uranium]], [[pipe]] (regular), all [[Belt transport system|belts]], [[wall]], [[landfill]].
|-
| 200 || [[Electronic circuit]], [[advanced circuit]], all types of [[Ammunition#Magazines|magazine]], all types of [[tank]] [[Ammunition#Tank shells|cannon shell]], [[copper cable]], both colors of circuit [[Circuit network|wire]], all types of [[science pack]] except space science pack.
|-
| 2,000 || Unique to [[space science pack]], present to allow stacking up to 2 [[Rocket|rockets]]' worth of packs in the [[rocket silo]]'s single output slot.
|}

=== Filtered stacks ===

Stacks can be filtered either by default (in burner-type entities, [[furnace]]s, [[roboport]]s, [[turret]]s, [[lab]]s, and other entities that can only accept one or a few item types in a particular slot), or manually by the player (normally set via the middle mouse button / scroll-wheel click, see [[Keyboard bindings]]). Manual filtering is available for [[cargo wagon]]s, [[car]]s, [[tank]]s, [[spidertron]]s and the player inventory, but not for other types of containers (in particular, [[chests]] of any type).

This can be used to ensure only one item type goes into the inventory space. [[Inserters]] (or [[Robots|bots]], where applicable) will not attempt to insert anything except the allowed item type into filtered slots, and manual insertion of other item types by the player is also not allowed unless and until the filter is cleared.

=== Damaged items ===

Damaged items (i.e, damaged entities now stored as items) stack with other damaged items (of the same type), but not with undamaged items. When items with different amounts of damage are stacked together, the health of the items is averaged.

=== Items with durability ===

Items with durability, such as [[science pack]]s and [[repair pack]]s, always stack with items of the same type, regardless of how much durability remains. The durability displayed on the stack is the durability of the first item. After that item is removed from the stack, a stack of items with full durabilities remains. This means that when multiple items with durabilities are stacked together, their durabilities are merged, which can result in a lower overall item count while the overall remaining durability stays the same.

== Stack size bonuses ==

Inserters and logistic robots can be boosted with research to hold and transfer more items, see:

* [[Inserter capacity bonus (research)]]
* [[Worker robot cargo size (research)]]

== Stack limitation ==

[[File:Stack limiter.jpg|300px|thumb|frame|A [[wooden chest]] limited to three stacks. Once the third stack is full, inserters will no longer attempt to add items.]]

Optionally, the usable space in [[chests]] and [[Cargo wagon|wagons]] can be decreased below their default values. Typically, this is done to store a small amount of items in an automated process, without consuming the resources that would be required to fill the entire container.

To limit a container, click the red X at the end of the last stack. Then, click on one of the stacks to set the new limit. The unused stacks will be highlighted red (see right).

When full, inserters will no longer add to a limited container. However, the player is still free to manually place items in the unused (red) slots.

== Handling stacks ==

There are some [[keyboard bindings]] to quickly handle movement of stacks between inventories, like moving half of a stack to another stack.

== History ==

In game version 0.10, the number of items which can be stored in a stack changed for most items from powers of 2 to multiples of 10. This change was mainly made because most people find it more intuitive to calculate numbers in a base-10 system.

Example: Before the change, a stack could store 64 iron ore, while after the change it is 50. This created some controversy, as some players preferred the old stack sizes.

{{C|Logistics{{!}}#Stack}} {{C|Storage{{!}}#Stack}}

Tutorial:Diagnosing performance issues

2023-12-15T19:26:13Z

SpeckledFleebeedoo: Explain flip

{{Languages}}
== Accessing the "time usage" screen ==

[[File:Debug settings for time usage diagnosis.jpg|thumb|right|The "Debug settings" menu with the options we need to enable]]

Press {{keybinding|F4}} to open the "Debug settings" menu. This will show you a variety of options. You need to enable 3 of them:
* '''show-fps''': This will show your FPS and UPS counter in the top right of your screen.
* '''show-time-usage''': This will show details of many systems of the game and how much they are impacting the performance of your game. The majority of this tutorial will be about how to decrypt this information.
* '''hide-mod-guis''': Sometimes, windows and buttons from mods can hide the information from show-time-usage. This option hides them so we can read everything.

Tip: To read the numbers more easily, open your map and scroll to an area you haven't explored yet, so the information is on a black background.

For more info on debug options and the debug settings menu, check out [[Debug mode]].

== FPS vs UPS ==

The first thing to look at is your FPS/UPS counter in the top right.
* FPS stands for Frames Per Second and relates to the work your graphics card is doing to display the picture on your screen. If your FPS is low, your screen will update less frequently, but your game will continue at regular speed.
* UPS stands for Updates Per Second and relates to the calculations needed to advance the state of your world. If your UPS is low, your game will run in slow motion. Factorio always aims to have 60 FPS and UPS.

'''FPS can never be higher than UPS.''' Which leaves you with 2 cases:

* '''Low FPS, High UPS''': Your problem is graphical. Go to Factorio's graphics settings and adjust some settings here. Upgrading your graphics card will help with this.
* '''Low FPS, Low UPS''': Your problem is low UPS. Continue following this tutorial to figure out what could be the cause and where you can save some UPS.

== Decrypting the "time usage" screen ==

=== How it works ===

You should see a bunch of text and numbers like this:

[[File:Time usage screen.jpg|border|1000px]]

Each line follows this format:
System name: average ms/minimum ms/maximum ms

Those numbers are in '''milliseconds per tick'''. A tick is one update step, it is for UPS what a "frame" is for FPS. Since Factorio aims for 60 ticks per second, the game has 16.667ms to calculate each tick. If it takes longer than this, then your UPS will drop below 60.

The 3 numbers for each line are the average time, minimum time, and maximum time taken by the system over the last 100 ticks.

This information is only telling you about the last 100 ticks, which is a little less than 2 seconds of gameplay. If your performance issues only happen some of the time or when you do something specific, you need to have the screen open while it is happening. If it happens too fast, you can take screenshots to read later. You can also use the "/perf-avg-frames 1000" command to increase the number of ticks considered to 1000 (or another number).

Now that you understand what this information is, look for '''large numbers'''. If you are experiencing consistent UPS issues, look at the '''average times'''. On the other hand, if you are experiencing occasional freezes or large stutters, look at the '''maximum times'''.

Remember, since 60 UPS is equivalent to 16.667ms per tick, you can think of it as 1ms of time costing you about 3.5 UPS. Anything above 1ms may be worth looking into, and anything above 5 is very significant.

When you've found some suspiciously large numbers, refer to the table below to see what the line means, whether you should worry about it, and how you can help:

=== Table of notable "time usage" lines ===

{| class="wikitable"
|-
! Name !! Explanation !! How to solve
|-
| Last save || This is how long your last save took, and is not related to UPS || -
|-
| Frame cycle || This is the total time it took to render a frame. This can't ever be lower than 16.667ms. This doesn't give you any information that your UPS counter wouldn't tell you. || -
|-
| Wait For Update || This is the time your GPU waited for the world update. This should be roughly equal to the "Update" line below. Don't worry about it. || -
|-
| Render preparation (and sub-lines) || This is CPU-based work related to the rendering of the frame on your screen, costing UPS. This will increase if you zoom out or if you're looking at a particularly busy part of your factory. || -
|-
| Render (and sub-lines) || This is GPU-based work related to the rendering of the frame on your screen, costing FPS. This will increase if you zoom out or if you're looking at a particularly busy part of your factory. || -
|-
| Flip[On/Off] || This is the time spent waiting for the graphics driver to refresh the screen. The "On" or "Off" in square brackets indicates if Vsync is enabled or not. || Try toggling Vsync on or off.
|-
| Sleep || When it took less than 16.667ms to prepare a tick, the game sleeps. This is normal and good. If this is above 0, then congrats, you have 60 UPS. || -
|-
| Update || This is where we get into the meat of things. The Update line is purely about the world tick and not about rendering the screen frame. This is usually where most of your frame time will be. || Look at the sub-lines to get more details.
|-
| Game update || The core systems of the game. || Look at the sub-lines to get more details.
|-
| Circuit networks || Self-explanatory. || Use fewer combinators and other circuit connections.
|-
| Transport lines || Related to belts. || Optimizing belt UPS is a dark art that is out of scope of this guide.
|-
| Fluid manager || Self-explanatory. || Reduce your amount of pipes. Use underground pipes (2 fluid entities) wherever they could replace 3 or more pipes. Replace nuclear power with solar power.
|-
| Heat manager || Self-explanatory. || Use less heat entities, for example by replacing nuclear power with solar power.
|-
| Entity manager || Related to "entities", which are a lot of things. This will usually be the largest number in your list. || To dig deeper into this, [[#Digging deeper with the "entity time usage" screen|continue to the next part of the tutorial.]]
|-
| Electric networks || Self-explanatory. || This is particularly affected by the '''number of different electric networks''', not their size. A single electric pole connected to nothing else is an electric network and is a performance cost.
|-
| Trains || Self-explanatory. || Use fewer but bigger trains. Use a train network optimized for UPS, which is also a dark art, out of scope of this guide.
|-
| Chart update || Related to refreshing chunks of your map, usually done by radars. || Reduce your number of radars.
|-
| Lua garbage incremental || This is related to mod scripts. || First, try and solve any issue in the "Script update" lines. If there is nothing there but you still have a high "Lua garbage incremental" cost, the show-lua-object-statistics [[debug mode|debug option]] may help to find mods that create and destroy a lot of Lua objects.
|-
| Script update || The time taken to run mods' Lua scripts. Each "mod-XXX" sub-line is the cost to run the scripts of a particular mod. || Uninstall offending mods. If the performance is worse than expected, consider filing a bug with the mod's author.
|-
|}

=== Hidden mod costs ===

A mod's line on the "Script update" section is not always the entirety of its cost! Mods can indirectly affect the time of core systems. For example, a mod that makes trains repath a lot might increase the Trains cost, and a mod that creates a lot of different electric networks would increase the Electric network cost.

== Digging deeper with the "entity time usage" screen ==

[[File:Entity time usage screen.jpg|thumb|right|The entity time usage screen]]

Return to the "Debug settings" menu, enable '''show-entity-time-usage''' and disable '''show-time-usage''' (It will get in the way).

On this screen, the "Entity manager" cost from the previous screen is split between each class of entity. The first number of each line is the time cost this tick, the second number is the number of active entities of this class.

Most lines are self explanatory, but a couple notes:

* '''AssemblingMachine''': This isn't just assembling machines, but every building where you have to select a recipe (e.g. chemical plants, refineries, etc., but not furnaces). For this cost, the number of machines matters, not their speed. Fewer but faster machines (with beacons and modules) will cost less than many slow machines.
* '''Inserter''': Use fewer inserters and have them work less often, e.g. with "inserter clocking".
* '''Unit''': This is biters and spitters. Removing biters and spitters will remove this cost.

If you've ran out of things to optimize in this section, then you're just suffering from a factory that has grown bigger than your PC can handle. Congratulations!

Copper plate

2023-10-22T01:09:42Z

SpeckledFleebeedoo:

{{Languages}}
{{:Infobox:Copper plate}}

'''Copper plate''' is a material that can be made by smelting [[copper ore]] in a [[furnace]]. The copper plate's use is small in early game, so many players underestimate how much production capacity they will need. In the later game, copper use picks up heavily with the mass production of [[electronic circuit]]s, and other resources that consume copper. However, copper use will usually still be less than [[iron plate]] use, throughout the game.

== History ==
{{History|0.17.0|
* Crafting time reduced from 3.5 to 3.2 seconds}}

{{history|0.10.0|
* New icon}}

{{history|0.1.0|
* Introduced}}

== See also ==

* [[Iron plate]]
* [[Stone furnace]]

{{IntermediateNav}}
{{C|Materials}}

Copper plate

2023-10-22T01:09:12Z

SpeckledFleebeedoo: Add crafting time change to history

{{Languages}}
{{:Infobox:Copper plate}}

'''Copper plate''' is a material that can be made by smelting [[copper ore]] in a [[furnace]]. The copper plate's use is small in early game, so many players underestimate how much production capacity they will need. In the later game, copper use picks up heavily with the mass production of [[electronic circuit]]s, and other resources that consume copper. However, copper use will usually still be less than [[iron plate]] use, throughout the game.

== History ==
{{History|0.17.0|
* Crafting time reduced from 3.5 to 3.2}}

{{history|0.10.0|
* New icon}}

{{history|0.1.0|
* Introduced}}

== See also ==

* [[Iron plate]]
* [[Stone furnace]]

{{IntermediateNav}}
{{C|Materials}}

Iron plate

2023-10-22T01:08:15Z

SpeckledFleebeedoo: Add crafting time change to history

{{Languages}}
{{:Infobox:Iron plate}}

The '''iron plate''' is a material that can be made by smelting [[iron ore]] in a [[furnace]]. It is a component or subcomponent of almost every item in Factorio, and it is recommended to create a large stockpile when possible. When smelted in a furnace for a second time, iron plates will transform into [[steel plate]]s, with a ratio of 5 iron plates per 1 steel plate.

When starting a new freeplay game, the player starts out with 8 iron plate, along with 1 [[burner mining drill]] and 1 [[stone furnace]].
== Achievements ==
{{Achievement|iron-throne-1}}
{{Achievement|iron-throne-2}}
{{Achievement|iron-throne-3}}

== History ==
{{History|0.17.0|
* Crafting time reduced from 3.5 to 3.2}}
{{History|0.1.0|
* Introduced}}

== See also ==
* [[Iron gear wheel]]
* [[Copper plate]]

{{IntermediateNav}}
{{C|Materials}}

Upcoming features

2023-08-28T22:17:10Z

SpeckledFleebeedoo: Update with news from FFF 373

{{Languages}}
This is a list of known information about the upcoming expansion pack '''Factorio: Space Age''':

== Plans ==
* Q: What?
** A: "Factorio: Space Age continues the player's journey after launching rockets into space. Discover new worlds with unique challenges, exploit their novel resources for advanced technological gains, and manage your fleet of interplanetary space platforms." [https://factorio.com/blog/post/fff-373]
* Multiple people, including the modder [https://mods.factorio.com/user/Earendel Earendel] were hired to work on the expansion pack. [https://factorio.com/blog/post/fff-365]
* As of August 2023, development is at the end of step 5 "First pass of tweaking" out of 7 total steps until release. [https://factorio.com/blog/post/fff-373]
* [https://factorio.com/blog/post/fff-367 Friday Facts #367] shows some concept art for the expansion.
* [https://factorio.com/blog/post/fff-372 Friday Facts #372] shows some item icons from the expansion.
* It is planned to be "as big an addition as the whole vanilla game." [https://factorio.com/blog/post/fff-367]
* The planned price is $30.00. [https://factorio.com/blog/post/fff-367]
* The expected release date is around August 2024. [https://factorio.com/blog/post/fff-373]
* [[Rocket silo | Rockets]] will be significantly cheaper [https://www.factorio.com/blog/post/fff-373]
* Tech tree gets overhauled: [https://www.factorio.com/blog/post/fff-373]
** [[Chemical science pack | Chemical science]] unlocks rocket silo and access to space
** [[Space science pack | Space science]] unlocks access to other planets
** [[Artillery]], [[cliff explosives]], [[spidertron]], top [[module]] tiers and some [[Equipment modules | personal equipment upgrades]] are unlocked on another planet.

== Known changes for 2.0 ==

* [[Crafting#Recipe_difficulties|Expensive mode]] gets turned into a mod. [https://forums.factorio.com/viewtopic.php?p=577191#p577191]
* [[Train_stop#Circuit_Network|Train stop disabling]] will be removed. [https://forums.factorio.com/viewtopic.php?p=574563#p574563]
* Improvements to controlling [[Spidertron|spidertrons]]. [https://www.reddit.com/r/factorio/comments/6e6tkw/im_the_founder_of_factorio_kovarex_ama/jnncw10/]
* Added the ability to use the pipette anywhere, including the crafting menu. [https://forums.factorio.com/viewtopic.php?p=567550#p567550]
* Added the ability to automatically remove fuel from [[Locomotive|locomotives]]. [https://forums.factorio.com/viewtopic.php?p=577389#p577389]
* [[Ghost]] [[Pipe|pipes]] will visually connect to each other. [https://forums.factorio.com/viewtopic.php?p=578549#p578549]
* Improvements to control of [[train]] systems. [https://www.factorio.com/blog/post/fff-373]
** Likely including logic for going to or skipping stations depending on [[fuel]] inventory [https://www.reddit.com/r/factorio/comments/160w331/comment/jxqaauz/?utm_source=share&utm_medium=web2x&context=3]
* Better [[blueprint]] building. [https://www.factorio.com/blog/post/fff-373]
* Improved [[Robots | flying robot]] behaviour. [https://www.factorio.com/blog/post/fff-373]

== See also ==
* [https://factorio.com/blog/post/fff-365 Friday Facts #365 - Future plans]
* [https://factorio.com/blog/post/fff-367 Friday Facts #367 - Expansion news]
* [https://factorio.com/blog/post/fff-370 Friday Facts #370 - The journey to Nintendo Switch]
* [https://factorio.com/blog/post/fff-373 Friday Facts #373 - Factorio: Space Age]
* [[Roadmap|Planned releases]]

Roadmap

2023-08-28T21:48:14Z

SpeckledFleebeedoo: Update with news from FFF 373

{{Languages}}
This is a short summary of the future plans for Factorio.

Refer to [[Roadmap/History]] for past versions of the roadmap and to [[upcoming features]] for a more detailed and up-to-date list of upcoming features.

== Factorio 1.1 (stable since January 26 2021) ==

* The 1.1 release is the final release of the vanilla game.
** It will be maintained, so bugfixes, simple modding interface additions, or minor tweaks can happen, but that's about it. [https://factorio.com/blog/post/fff-365]

== Factorio Expansion Pack ==

* The future plan is to release "one big expansion pack", see [https://factorio.com/blog/post/fff-365 Friday Facts #365 - Future plans]
* As of August 2023, development is at the end of step 5 "First pass of tweaking" out of 7 total steps until release. ([https://www.factorio.com/blog/post/fff-373 Factorio Friday Facts 373 - Factorio: Space Age])
* According to [https://www.factorio.com/blog/post/fff-373 Factorio Friday Facts 373 - Factorio: Space Age] the expansion pack will be titled '''Factorio: Space Age''' and will have the player launch into space and explore other planets, using space platforms to get around between them. The expansion will significantly rebalance the tech tree, making it possible to research the rocket silo using chemical science and limiting certain technologies behind science packs and resources that can only be found on the other planets. The expected release date is around August 2024.

== Factorio 2.0==

* Factorio 2.0 will be the base game version that is released alongside the expansion. Expected features are:
** Improved control of train systems,
** Better blueprint building.
** Better flying robot behaviour.

== See also ==
* [[Roadmap/History|Previous versions]]
** [[Version history|Detailed changelogs]]
* [[Upcoming features]]

Command line parameters

2023-05-29T18:03:02Z

SpeckledFleebeedoo:

{{Languages}}__TOC__

Command line parameters can be used to set settings in the command line before the game launches, this is useful mainly for advanced users or server hosts. This page pertains to version 0.17.79.

{| class="wikitable"
|+General options
|-
| -h, --help
| display help
|-
| --version
|show version information
|-
| -v, --verbose
|enable verbose logging
|-
| -c, --config PATH
|config file to use
|-
| --no-log-rotation
|don't rotate log file
|-
| --mod-directory PATH
|Mod directory to use
|-
| --check-unused-prototype-data
|Print a warning for all prototype values that were not accessed. Note for mod authors: If an entry is unused and is a table that contains the key/value pair 'ignore' with the value 'true' then the entire entry is ignored.
|-
| --executable-path PATH
|Override autodetected __PATH__executable. Usually not needed except on very weird systems.
|}

{| class="wikitable"
|+ Running options
|-
| -s, --map2scenario arg
|map to scenario conversion
|-
| -m, --scenario2map arg
|scenario to map conversion
|-
| --apply-update arg
|immediately apply update package
|-
| --create FILE
|create a new map
|-
| --map-gen-settings FILE
|Map generation settings for use with --create, --start-server-load-scenario or --generate-map-preview. See data/map-gen-settings.example.json
|-
| --map-gen-seed SEED
|Map generation seed for use with --create, --start-server-load-scenario or --generate-map-preview. Will override seed specified in map gen settings
|-
| --map-gen-seed-max SEED
|Map generation seed for use with --generate-map-preview to generate multiple previews using every second seed in the interval from map-gen-seed to map-gen-seed-max.
|-
| --map-settings FILE
|Map settings for use with --create or --start-server-load-scenario. See data/base/prototypes/map-settings.lua
|-
| --preset arg
|Name of the map generation preset to be used.
|-
| --generate-map-preview PATH
|Generate preview images of the map; PATH should name a PNG file or end with a '/' or '\' to indicate a directory.
|-
| --generate-map-preview-random COUNT
|Number of maps to generate with a random seed using --generate-map-preview.
|-
| --map-preview-size SCALE
|Size (in pixels) of map preview (default: 1024)
|-
| --map-preview-scale SCALE
|Scale (meters per pixel) of map preview (default: 1)
|-
| --map-preview-offset X,Y
|Offset of the center of the map, in meters (default: 0,0)
|-
| --noise-outputs TAG,TAG...
|Indicate which variables of noise program to output
|-
| --slope-shading SHADEAMOUNT
|Apply elevation shading to map preview
|-
| --slope-shade-property SHADEPROP
|Property to apply slope shading to (default: elevation)
|-
| --report-quantities PROTOTYPE,...
|When generating map preview, report approximate quantities of the named entity prototypes
|-
| --threads THREADCOUNT
|Number of threads to use when generating map previews
|-
| --disable-migration-window
|Disables the gui that is shown when opening a save with migrated content
|-
| --instrument-mod
|Name of a mod to enable [https://lua-api.factorio.com/latest/Instrument.html Instrument Mode]
|-
| --start-server FILE
|start a multiplayer server
|-
| --start-server-load-scenario [MOD/]NAME
|start a multiplayer server and load the specified scenario. The scenario is looked for inside the given mod. If no mod is given, it is looked for in the top-level scenarios directory.
|-
| --start-server-load-latest
|start a multiplayer server and load the latest available save
|-
| --until-tick TICK
|run a save until given map tick
|-
| --benchmark FILE
|load save and run benchmark
|-
| --benchmark-ticks N
|number of ticks for benchmarking. Default is 1000
|-
| --benchmark-runs N
|how often the number of ticks will be run, map will reload after each run. Default is 1
|-
| --benchmark-verbose timings
|comma separated list of Update timings to output each tick. "all", "timestamp" as well as all other values seen in the debug show-time-usage view's Update section are allowed here. An empty string disabled verbose benchmarking. Timings are returned in nanoseconds.
|-
| --benchmark-sanitize
|only output the final benchmark results
|-
| --benchmark-ignore-paused
|leaves the game paused if it was paused when saved. By default the game is unpaused when a benchmark starts.
|-
| --output-perf-stats FILE
|path of file to which rendering performance statistics measurements should be saved. Special tags {api}, {hw}, {time} and {tag} will be replaced.
|-
| --dump-data
|dumps data.raw as JSON to the script output folder and exits.
|-
| --dump-icon-sprites
|dumps all icon sprites as png files to the script output folder and exits.
|-
| --dump-prototype-locale
|dumps all prototypes name and description (if they have a valid value) to the script output folder and exits.
|-
| --mp-connect ADDRESS
|start factorio and connect to address
|-
| --password PASSWORD
|the password to use when using mp-connect (if any)
|-
| --heavy
|run the game in heavy mode if singleplayer with graphics (heavy mode is related to investigating desyncs, see [[Desynchronization#Using_heavy_mode_command]])
|-
| --load-game FILE
|start Factorio and load a game in singleplayer
|-
| --load-scenario [MOD/]NAME
|start Factorio and load the specified scenario in singleplayer. The scenario is looked for inside the given mod. If no mod is given, it is looked for in the top-level scenarios directory.
|-
| --benchmark-graphics FILE
|load save and run it with graphics for benchmark-ticks number of ticks as normal game would
|-
| --benchmark-frame FILE
|load save and benchmark graphics rendering of single frame (prepare + render) without updating the game
|-
| --force-opengl
|use OpenGL for rendering (windows only)
|-
| --force-d3d
|use Direct3D for rendering (windows only)
|-
| --d3d-adapter ID
|adapter which should be used to initialized Direct3D (windows only)
|-
| --d3d-feature-level
|override feature level (11, 10.1, 10) (windows only)
|-
| --dxgi-blit-model
|force Blit presentation mode (windows only)
|-
| --audio-driver
|default = sdl = SDL's WASAPI driver (windows)/SDL's PulseAudio or ALSA driver (linux)/SDL's CoreAudio driver (mac); allegro = Allegro's DirectSound8 driver (windows)/Allegro's PulseAudio, ALSA or OSS driver (linux)/Allegro's OpenAL driver (mac); allegro-via-sdl = Allegro mixer with SDL's WASAPI driver (windows)/not supported (linux + mac)
|-
| --debug-graphics
|enables debugging layer for graphics API. If DirectX is used DirectX SDK needs to be installed for this to work.
|-
| --fullscreen BOOL
|start game in windowed mode (saved to configuration)
|-
| --max-texture-size N
|maximal size of texture that the game can use (saved to configuration). Should be power of two greater than 2048
|-
| --graphics-quality arg
|accepted values: high, normal, low, very-low. low and very-low are deprecated and are migrated to normal.
|-
| --video-memory-usage arg
|accepted values: all, high, medium, low
|-
| --force-graphics-preset arg
|accepted values: very-low, low, mac-with-low-ram, medium-with-low-vram, medium, high, very-high, extreme
|-
| --gfx-safe-mode
|resets some graphics settings to values that should work on most configurations
|-
| --low-vram
|sprites that are not put into sprite atlases won't be allocated as texture objects
|-
| --shader
|enable/disable shader postprocessing (saved to configuration)
|-
| --disable-audio
|Disable audio. Mainly for faster startup during development.
|-
| --window-size arg
|Desired window resolution. For example "1680x1050". Or "maximized"
|-
| --single-thread-loading
|Disables loading of sprites in multiple threads.
|-
| --cache-sprite-atlas BOOL
|Enable/disable sprite atlas cache.
|}

{| class="wikitable"
|+ Server options
|-
| --port N
|network port to use
|-
| --bind ADDRESS[:PORT]
|IP address (and optionally port) to bind to
|-
| --rcon-port N
|Port to use for RCON
|-
| --rcon-bind ADDRESS:PORT
|IP address and port to use for RCON
|-
| --rcon-password PASSWORD
|Password for RCON
|-
| --server-settings FILE
|Path to file with server settings. See data/server-settings.example.json
|-
| --use-authserver-bans BOOL
|Verify that connecting players are not banned from multiplayer and inform Factorio.com about ban/unban commands.
|-
| --use-server-whitelist BOOL
|If the whitelist should be used.
|-
| --server-whitelist FILE
|Path to file with server whitelist.
|-
| --server-banlist FILE
|Path to file with server banlist.
|-
| --server-adminlist FILE
|Path to file with server adminlist.
|-
| --console-log FILE
|Path to file where a copy of the server's log will be stored
|-
| --server-id FILE
|Path where server ID will be stored or read from
|}

=== Multiplayer ===

--start-server SAVE

Will start a Headless (Dedicated) server, with no GUI.

--mp-connect ADDRESS
ADDRESS is the IP:port of the remote host. Port is optional.
Examples:

./factorio --mp-connect 192.168.1.101
./factorio --mp-connect 192.168.1.101:2345

As above, port can be specified by placing the port number after a colon in the address.

=== Creating a map from custom settings ===

Sometimes it's useful to create a new game with map and/or map generator settings stored in a JSON file rather than going through the in-game map settings screen.
One reason is that by editing the settings directly it is possible to set settings outside the range normally available from the GUI.

To do this, Factorio is run from the command-line, and a JSON file containing the map generator settings and a JSON file containing map settings (if customizing them) are needed.

Example for custom generator settings:
<pre>{
"terrain_segmentation": 0.5,
"water": "2",
"width": 0,
"height": 0,
"starting_area": "normal",
"peaceful_mode": false,
"autoplace_controls":
{
"coal": {"frequency": 1, "size": 2, "richness": 0.5},
"copper-ore": {"frequency": "low", "size": "normal", "richness": "high"},
"crude-oil": {"frequency": "normal", "size": "normal", "richness": "normal"},
"enemy-base": {"frequency": "normal", "size": "normal", "richness": "normal"},
"iron-ore": {"frequency": "normal", "size": "normal", "richness": "normal"},
"stone": {"frequency": "normal", "size": 0, "richness": "normal"},
"uranium-ore": {"frequency": "normal", "size": "none", "richness": "normal"}
},

"cliff_settings":
{
"name": "cliff",
"cliff_elevation_0": 30,
"cliff_elevation_interval": 20,
"richness": 1
},

"property_expression_names":
{
"elevation": "0_16-elevation",
"temperature": "35"
},

"seed": null
}
</pre>

Note that this is the same format as [https://lua-api.factorio.com/latest/Concepts.html#MapGenSettings MapGenSettings] that are modifiable from Lua. Everything in the file is optional.

Creating a custom save:
<pre>
"C:\Program Files\Factorio\bin\x64\Factorio.exe" --create stuff-seed123.zip --map-gen-settings map-gen-settings.json --map-gen-seed 123
</pre>

Generating a map preview:
<pre>
"C:\Program Files\Factorio\bin\x64\Factorio.exe" --generate-map-preview preview-seed123.png --map-gen-settings map-gen-settings.json --map-gen-seed 123
</pre>

==== Creating the JSON files from a map exchange string ====

It can be useful to create the initial JSON files from a known map exchange string instead of creating them from scratch. To convert the map exchange string to JSON, open the game and run the following command with your map exchange string:

/c game.write_file('map.txt', game.table_to_json(game.parse_map_exchange_string(<your exchange string here>)))

Then open the script_output folder in the [[user data directory]] and open map.txt - it will look like this:

{"map_settings":{ ...<MAP_SETTINGS> ... },"map_gen_settings":{ ...<MAP_GEN_SETTINGS>... }}

Copy the { ...<MAP_SETTINGS> ... } section into a new file called 'map-settings.json' in the desired location. Copy the { ...<MAP_GEN_SETTINGS> ... } section section into a new file called 'map-gen-settings.json' in the desired location.

== See also ==
* [[Console]]

Tutorial:Localisation

2023-04-09T17:09:11Z

SpeckledFleebeedoo: Put localization categories into table

{{Languages}}Mods should define human readable names for prototypes that they add. They can also define descriptions for items or custom strings for usage in GUIs etc. This is called '''localisation'''.

== File format ==
Translations are stored as .cfg files, with the following format:

<pre>welcome-message=Hello world
[category]
title=Category related title
# Comment
; Another comment</pre>
Any whitespace after or before <code>=</code> is included in the key or string, so <code>title =Category related title</code> will give an unknown key error if you are looking for the <code>title</code> key, since it is the <code>title </code> key.

<code>category</code> can be one of the existing locale categories, which permits implicit search mechanisms to find translations, but may also be another key, such as <code>[my-mod-messages]</code>. These are accessible the same as other translations, e.g. <code>{"my-mod-messages.hello"}</code>

These files are located within the language code of the language in the locale folder of the mod, so as an English example <code>__mod__/locale/en/any_name_here.cfg</code>. There can be more than 1 file per language, all of them will be read.

== Localising simple strings ==
The simplest localisation is of items, entities etc. If we say the item is <code>iron-plate</code>, the game will then search all loaded locale files for <code>item-name.iron-plate</code> and <code>item-description.iron-plate</code>, which in the locale file looks like this:

<pre>[item-name]
iron-plate=Iron plate
[item-description]
iron-plate=A plate made of iron.</pre>
If found in the locale, the label is set to this string. If not found, the game will instead show: <code>Unknown key: "item-name.iron-plate"</code>

In script, the localised string is formatted as <code>{"category.name"}</code>, so <code>game.print({"item-name.iron-plate"})</code> prints ''Iron plate''.

It is possible to use [[rich text]] features in the localised text if the location where the text is shown supports it, e.g. in the chat, prototype names and prototype tooltips.

<code>\n</code> can be used for line breaks if the location where the text is shown supports multiline text.

The list of all localization categories used by the base game is:

{| class="mw-collapsible mw-collapsed wikitable"
|-
!Localization categories
|-
|<code>[achievement-description]</code>
|-
|<code>[achievement-name]</code>
|-
|<code>[ammo-category-name]</code>
|-
|<code>[autoplace-control-names]</code>
|-
|<code>[controls]</code>
|-
|<code>[damage-type-name]</code>
|-
|<code>[decorative-name]</code>
|-
|<code>[entity-description]</code>
|-
|<code>[entity-name]</code>
|-
|<code>[equipment-name]</code>
|-
|<code>[fluid-name]</code>
|-
|<code>[fuel-category-name]</code>
|-
|<code>[item-description]</code>
|-
|<code>[item-group-name]</code>
|-
|<code>[item-limitation]</code>
|-
|<code>[item-name]</code>
|-
|<code>[map-gen-preset-description]</code>
|-
|<code>[map-gen-preset-name]</code>
|-
|<code>[mod-description]</code>
|-
|<code>[mod-name]</code>
|-
|<code>[modifier-description]
|-
|<code>[programmable-speaker-instrument]</code>
|-
|<code>[programmable-speaker-note]</code>
|-
|<code>[recipe-name]</code>
|-
|<code>[shortcut]</code>
|-
|<code>[story]</code>
|-
|<code>[string-mod-setting]</code>
|-
|<code>[technology-description]</code>
|-
|<code>[technology-name]</code>
|-
|<code>[tile-name]</code>
|-
|<code>[tips-and-tricks-item-description]</code>
|-
|<code>[tips-and-tricks-item-name]</code>
|-
|<code>[virtual-signal-description]</code>
|-
|<code>[virtual-signal-name]</code>
|}

== Localising with parameters ==
For more complex strings, localisation parameters can be used. For instance we want to show ''Time left: 10 minutes.''

So a key with a placeholder is defined, which is replaced by the first parameter after the locale key.:

<pre>time-left=Time left: __1__ minutes.</pre>
So it is used like this:

<syntaxhighlight lang="lua">game.print({"time-left", 10})</syntaxhighlight>
It also works with multiple parameters:

<syntaxhighlight lang="lua">game.print({"time-left", 10, 45})</syntaxhighlight>
<pre>time-left=Time left: __1__ minutes and __2__ seconds.</pre>
Which results in ''Time left: 10 minutes and 45 seconds.''

=== Built-in parameters ===
For some situations, we use localisation to show control schemes. For instance we want to say:

<pre>technology-prompt=Use T to open the technology screen</pre>
However the player may have rebound the key, but we can’t figure out which key as it would not be deterministic. So instead we use the built-in replacement functionality

<pre>technology-prompt=Use __CONTROL__open-technology-gui__ to open the technology screen.</pre>
We can also use this for items and entities:

<pre>big-iron-plate=Big __ITEM__iron-plate__</pre>
<pre>tiny-gun-turret=Tiny __ENTITY__gun-turret__</pre>

==== List of built-in parameters ====
<code>name</code> is the name of an internal game control or a prototype name, depending on context. <code>n</code> can be 1 or 2, it's used in parameters that control [[#Localising_alternate_input_names|alternate input names]]. For a list of internal game control names, see [[Prototype/CustomInput#linked_game_control]].
* <code>__CONTROL__name__</code> - The combination of modifiers and input, such as "Control + Alt + Left-click", or "Not set".
* <code>__CONTROL_MODIFIER__name__</code> - The modifiers, such as "ControlShift", or, "No modifier selected."
* <code>__CONTROL_STYLE_BEGIN__</code>
* <code>__CONTROL_STYLE_END__</code>
* <code>__CONTROL_LEFT_CLICK__</code> is replaced with <code>control-keys.mouse-button-1</code> or <code>control-keys.controller-b</code>[https://crowdin.com/project/factorio/discussions/214]
* <code>__CONTROL_RIGHT_CLICK__</code> is replaced with <code>control-keys.mouse-button-2</code> or <code>control-keys.controller-x</code>
* <code>__CONTROL_KEY_SHIFT__</code> is replaced with <code>control-keys.shift</code> or <code>control-keys.controller-leftshoulder</code>
* <code>__CONTROL_KEY_CTRL__</code> is replaced with <code>control-keys.control</code> or <code>control-keys.controller-rightshoulder</code>
* <code>__ALT_CONTROL_LEFT_CLICK__n__</code> is replaced with <code>control-keys.mouse-button-1-alt-n</code> or <code>control-keys.controller-button-alt-n</code> (with parameter <code>control-keys.controller-b</code>)
* <code>__ALT_CONTROL_RIGHT_CLICK__n__</code> is replaced with <code>control-keys.mouse-button-2-alt-n</code> or <code>control-keys.controller-button-alt-n</code> (with parameter <code>control-keys.controller-x</code>)
* <code>__REMARK_COLOR_BEGIN__</code>
* <code>__REMARK_COLOR_END__</code>
* <code>__ALT_CONTROL__n__name__</code>
* <code>__CONTROL_MOVE__</code> - The Movement keys, squished together. Example: "WASD", from a conventional QWERTY English keyboard.
* <code>__ENTITY__name__</code> - The localised_name of the [[Prototype/Entity]] extension.
* <code>__ITEM__name__</code> - The localised_name of the [[Prototype/Item]] or extension.
* <code>__TILE__name__</code> - The localised_name of the [[Prototype/Tile]].
* <code>__FLUID__name__</code> - The localised_name of the [[Prototype/Fluid]].

=== Plurals ===
Pluralization can be used in any string that uses a parameter (e.g. __1__) that is numeric, so something like an amount of minutes. It can be used multiple times per string.

<pre>format-days=__1__ __plural_for_parameter_1_{1=day|rest=days}__</pre>
This results in "1 day" and "2 days" / "500 days" etc.

The number after <code>__plural_for_parameter_</code> denotes which parameter is used to determine the plural. This is the parameter 1 in the above example. Anything inside the {} is used to make the plural. Each plural form is separated by a |.
The text in front of the = determines for what the plural form is used. Options for this are:
* a simple number, e.g. "1".
* Multiple numbers, e.g. "2,3,4".
* What the number ends with, e.g. "ends in 11" or "ends in 1"
* Multiple ends with, e.g. "ends in 1,ends in 2,ends in 12".
* "rest" to give the default plural.

Plural forms may be empty or contain other keys such as __1__ or spaces. This allows rather large plural forms:

<pre>__plural_for_parameter_1_{1=__1__ player is|rest=__1__ players are}__ connecting</pre>

The system chooses the first fitting plural that it encounters when multiple would fit:
<pre>__plural_for_parameter_1_{ends in 12=option 1|ends in 2=option 2|rest=option 3}__</pre>
This will result in "option 1" for 12 and in "option 2" for 22 and in "option 3" for numbers not ending with 2.

=== Concatenating localised strings ===
The special locale key: <code>""</code> is used to concatenate, as the table format does not support concatenation:

<syntaxhighlight lang="lua">game.print({"", {"item-name.iron-plate"}, ": ", 60})</syntaxhighlight>
Will result in: ''Iron plate: 60''

=== Localising alternate input names ===

In the introduction campaign, a special locale system is used for informing players how to do certain actions with their mouse.
The normal form is to use eg:
<pre>how-to-build=Use __CONTROL__build__ to place a building</pre>
which results in "Use Left mouse button to place a building". A more natural phrasing would be "Left-click to place a building", which can be achieved by using the following:
<pre>how-to-build=__ALT_CONTROL__1__build__ to place a building</pre>

These "alt" versions are controlled by a few special locale keys, mouse-button-X-alt-1 and mouse-button-X-alt-2. In English, form 1 produces eg "Left-click", and form 2 produces eg "Left-clicking". Only two alt forms ("1" and "2") are available at the moment, but if this a problem for some languages, more forms may be added in the future.
Extra mouse buttons, mouse scroll and keyboard keys are handled through the mouse-button-n-alt-1/2, mouse-wheel-alt-1/2 and keyboard-alt-1/2 keys, which just take the normal name and prepend something like "Press/Pressing", or "Scroll/Scrolling".

When translating to another language, you can use whatever forms you want here, but the important part is that you are consistent when you use the alt-forms everywhere else. It does not necessarily make sense to just copy the usages of alt forms from the English locale, and for some languages it may be more natural to simply not use this system at all.

== Accessing the localised result in code ==
While usually unneeded, it is possible to read the resulting localised text in code, for example to search in localised names. See [https://lua-api.factorio.com/latest/LuaPlayer.html#LuaPlayer.request_translation LuaPlayer::request_translation] and [https://lua-api.factorio.com/latest/events.html#on_string_translated on_string_translated event].

== Default Behavior(s) for finding an Unspecified Localised String ==
If a localised_string is not defined in the prototype for certain prototype classes, e.g. entity, item, Factorio may have a default search behavior.

Determining an item's localised name:
Note: the angle brackets are meant to mean a generic term, they are not part of the actual string. Also, place_result and placed_as_equipment_result are strings, and Factorio fetches the matching prototype to examine.

# if localised_name is provided in the item prototype and it is not empty {}, use the provided value
# else if there is place_result and it has localised_name that is not an empty table: {}, use the localised_name of place_result
# else if there is place_result with an empty localised_name, use {"entity-name.<entity prototype name>"}
# else if there is placed_as_equipment_result and it has a localised_name that is not an empty table: {}, use the localised_name of placed_as_equipment_result
# else if there is placed_as_equipment_result with empty localised_name, use {"equipment-name.<equipment name>"}
# else use default {"item-name.<item name>"}

Reference: [https://forums.factorio.com/viewtopic.php?p=494243#p494243]

Example: The transport-belt item does not have a localised_name, so 1->2. There is a place result, but not localised_name in the entity prototype. 2->3. The place result lacks a localised_name. Use the localised string {"entity-name.transport-belt"}

Such defaults often include a "leading key" using [<group>-name] or [<group>-description] (such as [recipe-name], [mod-setting-description]). However, each prototype may have a distinct search behavior before using those, based on presence/absence of values in the prototype. [[Prototype/Recipe]] for example may use the first product's localised_name, or the main_product's localised_name, or the localised string found in {"recipe-name.<recipe name>"], depending on values provided (and lacking) in the prototype.

== See also ==
* [[Types/LocalisedString|LocalisedString data stage doc]]
* [https://lua-api.factorio.com/latest/Concepts.html#LocalisedString LocalisedString control stage doc]

Refined flammables (research)/de

2023-03-23T23:24:43Z

SpeckledFleebeedoo: Fix formula (again)

{{Languages}}{{:Infobox:Refined flammables (research)}}
'''Raffinierte entzündliche Stoffe (Forschung)''' betrifft den Schaden von allen brennbaren Stoffen, inklusive Flammenwerfermunition und Flammenwerfer-Geschützturm.

{| class="wikitable"
! colspan = 2 |
! colspan = 2 | {{Icon|Flamethrower ammo}}{{Icon|Flamethrower turret}}
|-
! Technologie !! Kosten !! Auswirkung !! Aufaddierte <br/>Auswirkung
|-
| {{Icontech|Refined flammables (research)|1}} Raffinierte entzündliche Stoffe 1 || {{Icon|Time|30}} {{Icon|Automation science pack|1}} {{Icon|Logistic science pack|1}} {{Icon|Military science pack|1}} ✖ <big>100</big> || 20% || 20%
|-
| {{Icontech|Refined flammables (research)|2}} Raffinierte entzündliche Stoffe 2 || {{Icon|Time|30}} {{Icon|Automation science pack|1}} {{Icon|Logistic science pack|1}} {{Icon|Military science pack|1}} ✖ <big>200</big> || 20% || 40%
|-
| {{Icontech|Refined flammables (research)|3}} Raffinierte entzündliche Stoffe 3 || {{Icon|Time|60}} {{Icon|Automation science pack|1}} {{Icon|Logistic science pack|1}} {{Icon|Military science pack|1}} {{Icon|Chemical science pack|1}} ✖ <big>300</big> || 20% || 60%
|-
| {{Icontech|Refined flammables (research)|4}} Raffinierte entzündliche Stoffe 4 || {{Icon|Time|60}} {{Icon|Automation science pack|1}} {{Icon|Logistic science pack|1}} {{Icon|Military science pack|1}} {{Icon|Chemical science pack|1}} {{Icon|Utility science pack|1}} ✖ <big>400</big> || 30% || 90%
|-
| {{Icontech|Refined flammables (research)|5}} Raffinierte entzündliche Stoffe 5 || {{Icon|Time|60}} {{Icon|Automation science pack|1}} {{Icon|Logistic science pack|1}} {{Icon|Military science pack|1}} {{Icon|Chemical science pack|1}} {{Icon|Utility science pack|1}} ✖ <big>500</big> || 30% || 120%
|-
| {{Icontech|Refined flammables (research)|6}} Raffinierte entzündliche Stoffe 6 || {{Icon|Time|60}} {{Icon|Automation science pack|1}} {{Icon|Logistic science pack|1}} {{Icon|Military science pack|1}} {{Icon|Chemical science pack|1}} {{Icon|Utility science pack|1}} ✖ <big>600</big> || 40% || 160%
|-
| {{Icontech|Refined flammables (research)|7-∞}} Raffinierte entzündliche Stoffe 7-∞ || {{Icon|Time|60|Time}} {{Icon|Automation science pack|1}} {{Icon|Logistic science pack|1}} {{Icon|Military science pack|1}} {{Icon|Chemical science pack|1}} {{Icon|Utility science pack|1}} {{Icon|Space science pack|1}} ✖ <br/><big>{{Key|2^(Level-7)*1000}}</big> (z.B. 1000 für Level 7, 2000 für Level 8) || 20% pro Level || 180% + <pre class="keyboard-key">20%*(Level-7)</pre>
|}
== Siehe auch ==
* [[Research/de|Forschung]]
* [[Technologies/de|Technologien]]

{{TechNav}}

Refined flammables (research)/zh

2023-03-23T23:23:36Z

SpeckledFleebeedoo: Fix infinite research formula

{{Languages}}
{{:Infobox:Refined flammables (research)}}

'''精炼燃料制备'''提高火焰武器的伤害，包括{{L|Flamethrower ammo}}和{{L|Flamethrower turret}}。

{| class="wikitable"
! colspan = 2 |
! colspan = 2 | {{Icon|Flamethrower ammo}}{{Icon|Flamethrower turret}}
|-
! 研究 !! 成本 !! 每级加成 !! 累计加成
|-
| {{Icontech|Refined flammables (research)|1}} 精炼燃料制备 1 || {{Icon|Time|30}} {{Icon|Automation science pack|1}} {{Icon|Logistic science pack|1}} {{Icon|Military science pack|1}} ✖ <big>100</big> || 20% || 20%
|-
| {{Icontech|Refined flammables (research)|2}} 精炼燃料制备 2 || {{Icon|Time|30}} {{Icon|Automation science pack|1}} {{Icon|Logistic science pack|1}} {{Icon|Military science pack|1}} ✖ <big>200</big> || 20% || 40%
|-
| {{Icontech|Refined flammables (research)|3}} 精炼燃料制备 3 || {{Icon|Time|60}} {{Icon|Automation science pack|1}} {{Icon|Logistic science pack|1}} {{Icon|Military science pack|1}} {{Icon|Chemical science pack|1}} ✖ <big>300</big> || 20% || 60%
|-
| {{Icontech|Refined flammables (research)|4}} 精炼燃料制备 4 || {{Icon|Time|60}} {{Icon|Automation science pack|1}} {{Icon|Logistic science pack|1}} {{Icon|Military science pack|1}} {{Icon|Chemical science pack|1}} {{Icon|Utility science pack|1}} ✖ <big>400</big> || 30% || 90%
|-
| {{Icontech|Refined flammables (research)|5}} 精炼燃料制备 5 || {{Icon|Time|60}} {{Icon|Automation science pack|1}} {{Icon|Logistic science pack|1}} {{Icon|Military science pack|1}} {{Icon|Chemical science pack|1}} {{Icon|Utility science pack|1}} ✖ <big>500</big> || 30% || 120%
|-
| {{Icontech|Refined flammables (research)|6}} 精炼燃料制备 6 || {{Icon|Time|60}} {{Icon|Automation science pack|1}} {{Icon|Logistic science pack|1}} {{Icon|Military science pack|1}} {{Icon|Chemical science pack|1}} {{Icon|Utility science pack|1}} ✖ <big>600</big> || 40% || 160%
|-
| {{Icontech|Refined flammables (research)|7-∞}} 精炼燃料制备 7-∞ || {{Icon|Time|60|Time}} {{Icon|Automation science pack|1}} {{Icon|Logistic science pack|1}} {{Icon|Military science pack|1}} {{Icon|Chemical science pack|1}} {{Icon|Utility science pack|1}} {{Icon|Space science pack|1}} ✖ <br/><big>{{Key|2^(级别-7)*1000}}</big> （如：7级是1000，8级是2000） || 每级 20% || 180% + <pre class="keyboard-key">20%*(级别-7)</pre>
|}

== 参见 ==
* [[Research]]
* [[Technologies]]

{{TechNav}}

Refined flammables (research)/ru

2023-03-23T23:23:20Z

SpeckledFleebeedoo: Fix infinite research formula

{{Languages}}{{:Infobox:Refined flammables (research)}}
'''Переработанное горючее ([[research/ru|исследование]])''' влияет на урон любого горючего, включая [[flamethrower/ru|ручной огнемёт]] и [[flamethrower turret/ru|огнемётные турели]].

{| class="wikitable"
! colspan = 2 |
! colspan = 2 | {{Icon|Flamethrower ammo}}{{Icon|Flamethrower turret}}
|-
! Технология !! Затраты !! За уровень !! Суммарно
|-
| {{Icontech|Refined flammables (research)|1}} Переработанное горючее 1 || {{Icon|Time|30}} {{Icon|Automation science pack|1}} {{Icon|Logistic science pack|1}} {{Icon|Military science pack|1}} ✖ <big>100</big> || 20% || 20%
|-
| {{Icontech|Refined flammables (research)|2}} Переработанное горючее 2 || {{Icon|Time|30}} {{Icon|Automation science pack|1}} {{Icon|Logistic science pack|1}} {{Icon|Military science pack|1}} ✖ <big>200</big> || 20% || 40%
|-
| {{Icontech|Refined flammables (research)|3}} Переработанное горючее 3 || {{Icon|Time|60}} {{Icon|Automation science pack|1}} {{Icon|Logistic science pack|1}} {{Icon|Military science pack|1}} {{Icon|Chemical science pack|1}} ✖ <big>300</big> || 20% || 60%
|-
| {{Icontech|Refined flammables (research)|4}} Переработанное горючее 4 || {{Icon|Time|60}} {{Icon|Automation science pack|1}} {{Icon|Logistic science pack|1}} {{Icon|Military science pack|1}} {{Icon|Chemical science pack|1}} {{Icon|Utility science pack|1}} ✖ <big>400</big> || 30% || 90%
|-
| {{Icontech|Refined flammables (research)|5}} Переработанное горючее 5 || {{Icon|Time|60}} {{Icon|Automation science pack|1}} {{Icon|Logistic science pack|1}} {{Icon|Military science pack|1}} {{Icon|Chemical science pack|1}} {{Icon|Utility science pack|1}} ✖ <big>500</big> || 30% || 120%
|-
| {{Icontech|Refined flammables (research)|6}} Переработанное горючее 6|| {{Icon|Time|60}} {{Icon|Automation science pack|1}} {{Icon|Logistic science pack|1}} {{Icon|Military science pack|1}} {{Icon|Chemical science pack|1}} {{Icon|Utility science pack|1}} ✖ <big>600</big> || 40% || 160%
|-
| {{Icontech|Refined flammables (research)|7-∞}} Переработанное горючее 7-∞ || {{Icon|Time|60|Time}} {{Icon|Automation science pack|1}} {{Icon|Logistic science pack|1}} {{Icon|Military science pack|1}} {{Icon|Chemical science pack|1}} {{Icon|Utility science pack|1}} {{Icon|Space science pack|1}} ✖ <br/><big>{{Key|2^(Уровень-7)*1000}}</big> (т.е. 1000 на 7 уровне, 2000 на 8 уровне) || 20% за уровень || 180% + <pre class="keyboard-key">20%*(Уровень-7)</pre>
|}
== Смотреть также ==
* [[Research/ru|Исследование]]
* [[Technologies/ru|Технологии]]

{{TechNav}}

Refined flammables (research)/de

2023-03-23T23:22:51Z

SpeckledFleebeedoo: Fix infinite research formula

{{Languages}}{{:Infobox:Refined flammables (research)}}
'''Raffinierte entzündliche Stoffe (Forschung)''' betrifft den Schaden von allen brennbaren Stoffen, inklusive Flammenwerfermunition und Flammenwerfer-Geschützturm.

{| class="wikitable"
! colspan = 2 |
! colspan = 2 | {{Icon|Flamethrower ammo}}{{Icon|Flamethrower turret}}
|-
! Technologie !! Kosten !! Auswirkung !! Aufaddierte <br/>Auswirkung
|-
| {{Icontech|Refined flammables (research)|1}} Raffinierte entzündliche Stoffe 1 || {{Icon|Time|30}} {{Icon|Automation science pack|1}} {{Icon|Logistic science pack|1}} {{Icon|Military science pack|1}} ✖ <big>100</big> || 20% || 20%
|-
| {{Icontech|Refined flammables (research)|2}} Raffinierte entzündliche Stoffe 2 || {{Icon|Time|30}} {{Icon|Automation science pack|1}} {{Icon|Logistic science pack|1}} {{Icon|Military science pack|1}} ✖ <big>200</big> || 20% || 40%
|-
| {{Icontech|Refined flammables (research)|3}} Raffinierte entzündliche Stoffe 3 || {{Icon|Time|60}} {{Icon|Automation science pack|1}} {{Icon|Logistic science pack|1}} {{Icon|Military science pack|1}} {{Icon|Chemical science pack|1}} ✖ <big>300</big> || 20% || 60%
|-
| {{Icontech|Refined flammables (research)|4}} Raffinierte entzündliche Stoffe 4 || {{Icon|Time|60}} {{Icon|Automation science pack|1}} {{Icon|Logistic science pack|1}} {{Icon|Military science pack|1}} {{Icon|Chemical science pack|1}} {{Icon|Utility science pack|1}} ✖ <big>400</big> || 30% || 90%
|-
| {{Icontech|Refined flammables (research)|5}} Raffinierte entzündliche Stoffe 5 || {{Icon|Time|60}} {{Icon|Automation science pack|1}} {{Icon|Logistic science pack|1}} {{Icon|Military science pack|1}} {{Icon|Chemical science pack|1}} {{Icon|Utility science pack|1}} ✖ <big>500</big> || 30% || 120%
|-
| {{Icontech|Refined flammables (research)|6}} Raffinierte entzündliche Stoffe 6 || {{Icon|Time|60}} {{Icon|Automation science pack|1}} {{Icon|Logistic science pack|1}} {{Icon|Military science pack|1}} {{Icon|Chemical science pack|1}} {{Icon|Utility science pack|1}} ✖ <big>600</big> || 40% || 160%
|-
| {{Icontech|Refined flammables (research)|7-∞}} Raffinierte entzündliche Stoffe 7-∞ || {{Icon|Time|60|Time}} {{Icon|Automation science pack|1}} {{Icon|Logistic science pack|1}} {{Icon|Military science pack|1}} {{Icon|Chemical science pack|1}} {{Icon|Utility science pack|1}} {{Icon|Space science pack|1}} ✖ <br/><big>{{Key|2^(Level-7)*1000}}</big> (z.B. 1000 für Level 7, 2000 für Level 8) || 20% pro Level || 180% + <pre class="keyboard-key">20%*(Level-6)</pre>
|}
== Siehe auch ==
* [[Research/de|Forschung]]
* [[Technologies/de|Technologien]]

{{TechNav}}

Refined flammables (research)

2023-03-23T23:11:14Z

SpeckledFleebeedoo: Fix infinite research formula

{{Languages}}{{:Infobox:Refined flammables (research)}}
'''Refined flammables (research)''' affects the damage of all flammables, including handheld flamethrower ammo and flamethrower turrets.

{| class="wikitable"
! colspan = 2 |
! colspan = 2 | {{Icon|Flamethrower ammo}}{{Icon|Flamethrower turret}}
|-
! Technology !! Cost !! Per level !! Cumulative
|-
| {{Icontech|Refined flammables (research)|1}} Refined flammables 1 || {{Icon|Time|30}} {{Icon|Automation science pack|1}} {{Icon|Logistic science pack|1}} {{Icon|Military science pack|1}} ✖ <big>100</big> || 20% || 20%
|-
| {{Icontech|Refined flammables (research)|2}} Refined flammables 2 || {{Icon|Time|30}} {{Icon|Automation science pack|1}} {{Icon|Logistic science pack|1}} {{Icon|Military science pack|1}} ✖ <big>200</big> || 20% || 40%
|-
| {{Icontech|Refined flammables (research)|3}} Refined flammables 3 || {{Icon|Time|60}} {{Icon|Automation science pack|1}} {{Icon|Logistic science pack|1}} {{Icon|Military science pack|1}} {{Icon|Chemical science pack|1}} ✖ <big>300</big> || 20% || 60%
|-
| {{Icontech|Refined flammables (research)|4}} Refined flammables 4 || {{Icon|Time|60}} {{Icon|Automation science pack|1}} {{Icon|Logistic science pack|1}} {{Icon|Military science pack|1}} {{Icon|Chemical science pack|1}} {{Icon|Utility science pack|1}} ✖ <big>400</big> || 30% || 90%
|-
| {{Icontech|Refined flammables (research)|5}} Refined flammables 5 || {{Icon|Time|60}} {{Icon|Automation science pack|1}} {{Icon|Logistic science pack|1}} {{Icon|Military science pack|1}} {{Icon|Chemical science pack|1}} {{Icon|Utility science pack|1}} ✖ <big>500</big> || 30% || 120%
|-
| {{Icontech|Refined flammables (research)|6}} Refined flammables 6 || {{Icon|Time|60}} {{Icon|Automation science pack|1}} {{Icon|Logistic science pack|1}} {{Icon|Military science pack|1}} {{Icon|Chemical science pack|1}} {{Icon|Utility science pack|1}} ✖ <big>600</big> || 40% || 160%
|-
| {{Icontech|Refined flammables (research)|7-∞}} Refined flammables 7-∞ || {{Icon|Time|60|Time}} {{Icon|Automation science pack|1}} {{Icon|Logistic science pack|1}} {{Icon|Military science pack|1}} {{Icon|Chemical science pack|1}} {{Icon|Utility science pack|1}} {{Icon|Space science pack|1}} ✖ <br/><big>{{Key|2^(Level-7)*1000}}</big> (eg. 1000 for level 7, 2000 for level 8) || 20% per level || 180% + <pre class="keyboard-key">20%*(Level-7)</pre>
|}
== See also ==
* [[Research]]
* [[Technologies]]

{{TechNav}}

Mod portal API

2022-12-13T21:50:03Z

SpeckledFleebeedoo: Add description of license field

<div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Internal|Internal API]]</div>

The Mod Portal API is used to both browse and download all mods available on the [https://mods.factorio.com/ official Factorio mod portal]. Using the API does not require any kind of authentication or account information and can be viewed simply by following the URLs below in any web browser.

<code>https://mods.factorio.com/api/mods</code>

More detailed information about a particular mod can be obtained by retrieving the following URL, where {name} is the mod's name field in the result object.

<code>https://mods.factorio.com/api/mods/{name}</code>

To get even more information about a mod, you can use the following URL.

<code>https://mods.factorio.com/api/mods/{name}/full</code>

== Endpoints ==

=== /api/mods ===

GET Parameters:

{| class="wikitable"
! Key !! Values !! Description
|-
| hide_deprecated || {boolean} || Only return non-deprecated mods.
|-
| page ||{an integer}||Page number you would like to show. Makes it so you can see a certain part of the list without getting detail on all
|-
| page_size ||{an integer or 'max'}||The amount of results to show in your search
|-
| sort || {enum, one of name, created_at or updated_at} || Sort results by this property. Defaults to name when not defined. Ignored for <code>page_size=max</code> queries.
|-
| sort_order || {enum, one of asc or desc} || Sort results ascending or descending. Defaults to descending when not defined. Ignored for <code>page_size=max</code> queries.
|-
| namelist || {array of strings} || Return only mods that match the given names. Response will include <code>releases</code> instead of <code>latest_release</code>.
|-
| version || {enum, one of 0.13, 0.14, 0.15, 0.16, 0.17, 0.18, 1.0 or 1.1} || Only return non-deprecated mods compatible with this Factorio version
|}

Returns [[#Mod List Response]]

=== /api/mods/{mod_name} ===

Return short information of a specific mod.

See [[#Result Entry]], "Short" column.

=== /api/mods/{mod_name}/full ===

Returns more information of a mod.

See [[#Result Entry]], "Full" column.

== JSON Object Types ==

=== Mod List Response ===

{| class="wikitable"
! Key !! Type !! Description
|-
| pagination || [[#Pagination|Pagination]] || See [[#Pagination]]
|-
| results || [[#Result Entry|Result]][] || A list of mods, matching any filters you specified.
|}

=== Pagination ===

{| class="wikitable"
! Key !! Type !! Description
|-
| count || Integer || Total number of mods that match your specified filters.
|-
| links || [[#Pagination_Links|Links]] || Utility links to mod portal api requests, preserving all filters and search queries.
|-
| page || Integer || The current page number.
|-
| page_count || Integer || The total number of pages returned.
|-
| page_size || Integer || The number of results per page.
|}

=== Pagination Links ===

{| class="wikitable"
! Key !! Type !! Description
|-
| first || String(URL) || URL to the first page of the results, or null if you're already on the first page.
|-
| prev || String(URL) || URL to the previous page of the results, or null if you're already on the first page.
|-
| next || String(URL) || URL to the next page of the results, or null if you're already on the last page.
|-
| last || String(URL) || URL to the last page of the results, or null if you're already on the last page.
|}

=== Result Entry ===

Fields returned by the api/mods endpoint are marked with a check (✓) in the "api/mods endpoint" column, those returned by the api/mods/{name} endpoint are marked with a check in the "Short" column and those returned by the api/mods/{name}/full endpoint are marked in the "Full" column. Fields may be absent if there is no data.

{| class="wikitable"
! Key !! Type !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' | api/mods endpoint !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' | Short !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' | Full !! Description
|-
| downloads_count || Integer || ✓ || ✓ || ✓
| Number of downloads.
|-
| latest_release || [[#Releases|Release]]? || ✓ || ||
| The latest version of the mod available for download. Absent when the <code>namelist</code> [[#/api/mods|parameter]] is used.
|-
| name || String || ✓ || ✓ || ✓
| The mod's machine-readable ID string.
|-
| owner || String || ✓ || ✓ || ✓
| The Factorio username of the mod's author.
|-
| releases || [[#Releases|Release]][] || ✓* || ✓ || ✓
| A list of different versions of the mod available for download. See [[#Releases]]. *Only when using <code>namelist</code> [[#/api/mods|parameter]].
|-
| summary || String || ✓ || ✓ || ✓
| A shorter mod description.
|-
| title || String || ✓ || ✓ || ✓
| The mod's human-readable name.
|-
| category || [[#Tags|Tag]]? || ✓ || ✓ || ✓
| A single tag describing the mod. See [[#Tags]].
|-
| thumbnail || String(relative URL) || || ✓ || ✓
| The relative path to the thumbnail of the mod. For mods that have no thumbnail it may be absent or default to <code>"/assets/.thumb.png"</code>. Prepend "assets-mod.factorio.com".
|-
| changelog || String || || || ✓
| A string describing the recent changes to a mod.
|-
| created_at || String(ISO 8601) || || || ✓
| ISO 6501 for when the mod was created.
|-
| description || String || || || ✓
| A longer description of the mod, in text only format.
|-
| github_path || String || || || ✓
| A link to the mod's github project page, just prepend "github.com/". Can be blank ("").
|-
| homepage || String || || || ✓
| Usually a URL to the mod's main project page, but can be any string.
|-
| tag || [[#Tags|Tag]][] || || || ✓
| A list of tag objects that categorize the mod. See [[#Tags]].
|-
| license || [[#License]][] || || || ✓
| The license that applies to the mod. See [[#License]].
|-
|}

=== Releases ===

Only difference here between the api/mods/{name} endpoint and the api/mods/{name}/full endpoint is that the full one includes an array of dependencies in the info_json object.

{| class="wikitable"
! Key !! Type !! Description
|-
| download_url || String
| Path to download for a mod. starts with "/download" and does not include a full url. See [[#Downloading Mods]]
|-
| file_name || String
| The file name of the release. Always seems to follow the pattern "{name}_{version}.zip"
|-
| info_json || Object
| A copy of the mod's info.json file, only contains factorio_version in short version, also contains an array of dependencies in full version
|-
| released_at || String(ISO 8601)
| ISO 6501 for when the mod was released.
|-
| version || String
| The version string of this mod release. Used to determine dependencies.
|-
| sha1 || String
| The sha1 key for the file
|-
|}

=== Tags ===

{| class="wikitable"
! Key !! Type !! Description
|-
| id || Integer || A numerical ID unique to this tag.
|-
| name || String || An all lower-case string used to identify this tag internally.
|-
| title || String || The tag's human-readable tag name.
|-
| description || String || A short description for the tag.
|-
| type || String ||
|}

Currently, there are only a fixed number of tags available, these include:

{| class="wikitable"
! id !! type !! name !! title !! description
|-
| 1 || t || general || General || Mods that cannot be sorted into other categories
|-
| 2 || t || non-game-changing || Non-Game-Changing || Changes only look&feel. New graphics, new sounds, ... such things.
|-
| 3 || t || helper-mods || Helper Mods || These mods are not game-changing, but enhance the gameplay by helping you with useful functions. Mods like showing the current game-time, keep track over your resources, rail-laying...
|-
| 6 || t || big-mods || Big Mods || Too big and/or changes too much of the game to be fit anywhere else
|-
| 12 || t || transportation || Transportation || Player transport
|-
| 13 || t || logistics || Logistics || Transport of materials
|-
| 14 || t || utility || Utility || Helps with certain things the player is doing.
|-
| 15 || t || balancing || Balancing || Makes the game much more fair
|-
| 17 || t || enemies || Enemies || Adds more enemies for more challange
|-
| 16 || t || weapons || Weapons || Adds more weapons to annihilate the enemy
|-
| 18 || t || armor || Armor || Armors or armor equipment related.
|-
| 19 || t || oil || Oil || Things related to oil related manufacture
|-
| 20 || t || logistics-network || Logistics Network || Related to roboports and logistic robots
|-
| 21 || t || storage || Storage || Allows more ways to be able to store items
|-
| 22 || t || power-production || Power Production || Allows more ways to create mass amounts of energy
|-
| 23 || t || manufacture || Manufacture || Furnaces, assembling machines, production chains
|-
| 24 || t || blueprints || Blueprints ||
|-
| 25 || t || cheats || Cheats || Well, they let you cheat
|-
| 26 || t || defense || Defense || Mods that add the ability to protect your base more
|-
| 27 || t || mining || Mining || Mods that provide better or new ways of mining resources
|-
| 28 || t || info || Info || Mods that provide additional information to the player
|-
| 29 || t || trains || Trains || Related to trains
|}

=== License ===

{| class="wikitable"
! Key !! Type !! Description
|-
| description || String || A short description of the license.
|-
| id || String || The unique id of the license.
|-
| name || String || The internal name of the license.
|-
| title || String || The human-readable title of the license.
|-
| url || String || Usually a URL to the full license text, but can be any string.
|}

=== Error ===

{| class="wikitable"
! Key !! Type !! Description
|-
| detail || String ||
|}

== Downloading Mods ==

You can get the full url by appending the download_url to mods.factorio.com, but if you're not authenticated, you will be redirected to mods.factorio.com/login. Logging in to that would give you access to the file. Fortunately, there's a better way to do this. Simply adding username and token parameters to the download url will prevent the redirecting and let you download the file immediately. The token can be acquired from a json file called "player-data.json", located in the User Data directory (see [[Application_directory#User_data_directory]]). You can also get the token by using the [[Web_authentication_API | Web Authentication API]].

Example usage:
https://mods.factorio.com/{download_url}?username={username}&token={token}

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

Mod portal API

2022-12-13T21:39:39Z

SpeckledFleebeedoo: Update notes on availability of various keys

<div align="center" class="stub">'''Category:''' [[Factorio_HTTP_API_usage_guidelines#Internal|Internal API]]</div>

The Mod Portal API is used to both browse and download all mods available on the [https://mods.factorio.com/ official Factorio mod portal]. Using the API does not require any kind of authentication or account information and can be viewed simply by following the URLs below in any web browser.

<code>https://mods.factorio.com/api/mods</code>

More detailed information about a particular mod can be obtained by retrieving the following URL, where {name} is the mod's name field in the result object.

<code>https://mods.factorio.com/api/mods/{name}</code>

To get even more information about a mod, you can use the following URL.

<code>https://mods.factorio.com/api/mods/{name}/full</code>

== Endpoints ==

=== /api/mods ===

GET Parameters:

{| class="wikitable"
! Key !! Values !! Description
|-
| hide_deprecated || {boolean} || Only return non-deprecated mods.
|-
| page ||{an integer}||Page number you would like to show. Makes it so you can see a certain part of the list without getting detail on all
|-
| page_size ||{an integer or 'max'}||The amount of results to show in your search
|-
| sort || {enum, one of name, created_at or updated_at} || Sort results by this property. Defaults to name when not defined. Ignored for <code>page_size=max</code> queries.
|-
| sort_order || {enum, one of asc or desc} || Sort results ascending or descending. Defaults to descending when not defined. Ignored for <code>page_size=max</code> queries.
|-
| namelist || {array of strings} || Return only mods that match the given names. Response will include <code>releases</code> instead of <code>latest_release</code>.
|-
| version || {enum, one of 0.13, 0.14, 0.15, 0.16, 0.17, 0.18, 1.0 or 1.1} || Only return non-deprecated mods compatible with this Factorio version
|}

Returns [[#Mod List Response]]

=== /api/mods/{mod_name} ===

Return short information of a specific mod.

See [[#Result Entry]], "Short" column.

=== /api/mods/{mod_name}/full ===

Returns more information of a mod.

See [[#Result Entry]], "Full" column.

== JSON Object Types ==

=== Mod List Response ===

{| class="wikitable"
! Key !! Type !! Description
|-
| pagination || [[#Pagination|Pagination]] || See [[#Pagination]]
|-
| results || [[#Result Entry|Result]][] || A list of mods, matching any filters you specified.
|}

=== Pagination ===

{| class="wikitable"
! Key !! Type !! Description
|-
| count || Integer || Total number of mods that match your specified filters.
|-
| links || [[#Pagination_Links|Links]] || Utility links to mod portal api requests, preserving all filters and search queries.
|-
| page || Integer || The current page number.
|-
| page_count || Integer || The total number of pages returned.
|-
| page_size || Integer || The number of results per page.
|}

=== Pagination Links ===

{| class="wikitable"
! Key !! Type !! Description
|-
| first || String(URL) || URL to the first page of the results, or null if you're already on the first page.
|-
| prev || String(URL) || URL to the previous page of the results, or null if you're already on the first page.
|-
| next || String(URL) || URL to the next page of the results, or null if you're already on the last page.
|-
| last || String(URL) || URL to the last page of the results, or null if you're already on the last page.
|}

=== Result Entry ===

Fields returned by the api/mods endpoint are marked with a check (✓) in the "api/mods endpoint" column, those returned by the api/mods/{name} endpoint are marked with a check in the "Short" column and those returned by the api/mods/{name}/full endpoint are marked in the "Full" column. Fields may be absent if there is no data.

{| class="wikitable"
! Key !! Type !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' | api/mods endpoint !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' | Short !!+ style='writing-mode:vertical-lr;vertical-align:bottom;font-size:90%' | Full !! Description
|-
| downloads_count || Integer || ✓ || ✓ || ✓
| Number of downloads.
|-
| latest_release || [[#Releases|Release]]? || ✓ || ||
| The latest version of the mod available for download. Absent when the <code>namelist</code> [[#/api/mods|parameter]] is used.
|-
| name || String || ✓ || ✓ || ✓
| The mod's machine-readable ID string.
|-
| owner || String || ✓ || ✓ || ✓
| The Factorio username of the mod's author.
|-
| releases || [[#Releases|Release]][] || ✓* || ✓ || ✓
| A list of different versions of the mod available for download. See [[#Releases]]. *Only when using <code>namelist</code> [[#/api/mods|parameter]].
|-
| summary || String || ✓ || ✓ || ✓
| A shorter mod description.
|-
| title || String || ✓ || ✓ || ✓
| The mod's human-readable name.
|-
| category || [[#Tags|Tag]]? || ✓ || ✓ || ✓
| A single tag describing the mod. See [[#Tags]].
|-
| thumbnail || String(relative URL) || || ✓ || ✓
| The relative path to the thumbnail of the mod. For mods that have no thumbnail it may be absent or default to <code>"/assets/.thumb.png"</code>. Prepend "assets-mod.factorio.com".
|-
| changelog || String || || || ✓
| A string describing the recent changes to a mod.
|-
| created_at || String(ISO 8601) || || || ✓
| ISO 6501 for when the mod was created.
|-
| description || String || || || ✓
| A longer description of the mod, in text only format.
|-
| github_path || String || || || ✓
| A link to the mod's github project page, just prepend "github.com/". Can be blank ("").
|-
| homepage || String || || || ✓
| Usually a URL to the mod's main project page, but can be any string.
|-
| tag || [[#Tags|Tag]][] || || || ✓
| A list of tag objects that categorize the mod. See [[#Tags]].
|-
|}

=== Releases ===

Only difference here between the api/mods/{name} endpoint and the api/mods/{name}/full endpoint is that the full one includes an array of dependencies in the info_json object.

{| class="wikitable"
! Key !! Type !! Description
|-
| download_url || String
| Path to download for a mod. starts with "/download" and does not include a full url. See [[#Downloading Mods]]
|-
| file_name || String
| The file name of the release. Always seems to follow the pattern "{name}_{version}.zip"
|-
| info_json || Object
| A copy of the mod's info.json file, only contains factorio_version in short version, also contains an array of dependencies in full version
|-
| released_at || String(ISO 8601)
| ISO 6501 for when the mod was released.
|-
| version || String
| The version string of this mod release. Used to determine dependencies.
|-
| sha1 || String
| The sha1 key for the file
|-
|}

=== Tags ===

{| class="wikitable"
! Key !! Type !! Description
|-
| id || Integer || A numerical ID unique to this tag.
|-
| name || String || An all lower-case string used to identify this tag internally.
|-
| title || String || The tag's human-readable tag name.
|-
| description || String || A short description for the tag.
|-
| type || String ||
|}

Currently, there are only a fixed number of tags available, these include:

{| class="wikitable"
! id !! type !! name !! title !! description
|-
| 1 || t || general || General || Mods that cannot be sorted into other categories
|-
| 2 || t || non-game-changing || Non-Game-Changing || Changes only look&feel. New graphics, new sounds, ... such things.
|-
| 3 || t || helper-mods || Helper Mods || These mods are not game-changing, but enhance the gameplay by helping you with useful functions. Mods like showing the current game-time, keep track over your resources, rail-laying...
|-
| 6 || t || big-mods || Big Mods || Too big and/or changes too much of the game to be fit anywhere else
|-
| 12 || t || transportation || Transportation || Player transport
|-
| 13 || t || logistics || Logistics || Transport of materials
|-
| 14 || t || utility || Utility || Helps with certain things the player is doing.
|-
| 15 || t || balancing || Balancing || Makes the game much more fair
|-
| 17 || t || enemies || Enemies || Adds more enemies for more challange
|-
| 16 || t || weapons || Weapons || Adds more weapons to annihilate the enemy
|-
| 18 || t || armor || Armor || Armors or armor equipment related.
|-
| 19 || t || oil || Oil || Things related to oil related manufacture
|-
| 20 || t || logistics-network || Logistics Network || Related to roboports and logistic robots
|-
| 21 || t || storage || Storage || Allows more ways to be able to store items
|-
| 22 || t || power-production || Power Production || Allows more ways to create mass amounts of energy
|-
| 23 || t || manufacture || Manufacture || Furnaces, assembling machines, production chains
|-
| 24 || t || blueprints || Blueprints ||
|-
| 25 || t || cheats || Cheats || Well, they let you cheat
|-
| 26 || t || defense || Defense || Mods that add the ability to protect your base more
|-
| 27 || t || mining || Mining || Mods that provide better or new ways of mining resources
|-
| 28 || t || info || Info || Mods that provide additional information to the player
|-
| 29 || t || trains || Trains || Related to trains
|}

=== Error ===

{| class="wikitable"
! Key !! Type !! Description
|-
| detail || String ||
|}

== Downloading Mods ==

You can get the full url by appending the download_url to mods.factorio.com, but if you're not authenticated, you will be redirected to mods.factorio.com/login. Logging in to that would give you access to the file. Fortunately, there's a better way to do this. Simply adding username and token parameters to the download url will prevent the redirecting and let you download the file immediately. The token can be acquired from a json file called "player-data.json", located in the User Data directory (see [[Application_directory#User_data_directory]]). You can also get the token by using the [[Web_authentication_API | Web Authentication API]].

Example usage:
https://mods.factorio.com/{download_url}?username={username}&token={token}

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