Official Factorio Wiki - User contributions [en]

Command line parameters

2020-11-12T23:53:01Z

Mulark:

{{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
|-
| --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.
|-
| --mp-connect ADDRESS
|start factorio and connect to address
|-
| --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 = Allegro's DirectSound8 backend, sdl = SDL's WASAPI backend)
|-
| --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: normal, low, very-low
|-
| --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.
|-
| --disable-prototype-history
|Disables tracking which mod created/changed what prototype. 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.
|-
| --instrument-mod
|Name of a mod to enable [https://lua-api.factorio.com/latest/Instrument.html Instrument Mode]
|-
| --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-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]]

Command line parameters

2019-11-19T00:20:53Z

Mulark:

__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.78.

{| 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.
|-
| --enable-runtime-autoplace-modification
|Allows changing autoplace specifications runtime in non-multiplayer non-replay enabled games for debug purposes.
|-
| --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
|-
| --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.
|-
| --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.
|-
| --mp-connect ADDRESS
|start factorio and connect to address
|-
| --heavy
|run the game in heavy mode
|-
| --load-game FILE
|start Factorio and load a game in singleplayer
|-
| --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
|-
| --force-d3d
|use Direct3D for rendering
|-
| --d3d-adapter ID
|adapter which should be used to initialized Direct3D
|-
| --d3d-feature-level
|override feature level (11, 10.1, 10)
|-
| --dxgi-blit-model
|force Blit presentation mode
|-
| --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: normal, low, very-low
|-
| --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.
|-
| --disable-prototype-history
|Disables tracking which mod created/changed what prototype. 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.
|}

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

Command line parameters

2019-11-19T00:19:54Z

Mulark:

__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.67.

{| 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.
|-
| --enable-runtime-autoplace-modification
|Allows changing autoplace specifications runtime in non-multiplayer non-replay enabled games for debug purposes.
|-
| --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
|-
| --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.
|-
| --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.
|-
| --mp-connect ADDRESS
|start factorio and connect to address
|-
| --heavy
|run the game in heavy mode
|-
| --load-game FILE
|start Factorio and load a game in singleplayer
|-
| --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
|-
| --force-d3d
|use Direct3D for rendering
|-
| --d3d-adapter ID
|adapter which should be used to initialized Direct3D
|-
| --d3d-feature-level
|override feature level (11, 10.1, 10)
|-
| --dxgi-blit-model
|force Blit presentation mode
|-
| --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: normal, low, very-low
|-
| --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.
|-
| --disable-prototype-history
|Disables tracking which mod created/changed what prototype. 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.
|}

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

Prototype/Entity

2019-10-13T20:04:37Z

Mulark: typo

{{Prototype parent|PrototypeBase}}
Abstract base of all entities in the game.
Entity is basically everything that can be on the map (except tiles).
For in game script access to entity, take a look at [http://lua-api.factorio.com/latest/LuaEntity.html LuaEntity]

{{Prototype TOC|''abstract''}}

== Extensions ==
<div class="factorio-list">
* [[Prototype/Arrow]] '''arrow'''
* [[Prototype/ArtilleryProjectile]] '''artillery-projectile'''
* [[Prototype/Beam]] '''beam'''
* [[Prototype/CharacterCorpse]] '''character-corpse'''
* [[Prototype/Cliff]] '''cliff'''
* [[Prototype/Corpse]] '''corpse'''
** [[Prototype/RailRemnants]] '''rail-remnants'''
* [[Prototype/DeconstructibleTileProxy]] '''deconstructible-tile-proxy'''
* [[Prototype/EntityGhost]] '''entity-ghost'''
* [[Prototype/EntityWithHealth]] <abstract>
** [[Prototype/Accumulator]] '''accumulator'''
** [[Prototype/ArtilleryTurret]] '''artillery-turret'''
** [[Prototype/Beacon]] '''beacon'''
** [[Prototype/Boiler]] '''boiler'''
** [[Prototype/Character]] '''character'''
** [[Prototype/Combinator]] <abstract>
*** [[Prototype/ArithmeticCombinator]] '''arithmetic-combinator'''
*** [[Prototype/DeciderCombinator]] '''decider-combinator'''
** [[Prototype/ConstantCombinator]] '''constant-combinator'''
** [[Prototype/Container]] '''container'''
*** [[Prototype/LogisticContainer]] '''logistic-container'''
**** [[Prototype/InfinityContainer]] '''infinity-container'''
** [[Prototype/CraftingMachine]] <abstract>
*** [[Prototype/AssemblingMachine]] '''assembling-machine'''
**** [[Prototype/RocketSilo]] '''rocket-silo'''
*** [[Prototype/Furnace]] '''furnace'''
** [[Prototype/ElectricEnergyInterface]] '''electric-energy-interface'''
** [[Prototype/ElectricPole]] '''electric-pole'''
** [[Prototype/EnemySpawner]] '''unit-spawner'''
** [[Prototype/Fish]] '''fish'''
** [[Prototype/FlyingRobot]] <abstract>
*** [[Prototype/CombatRobot]] '''combat-robot'''
*** [[Prototype/RobotWithLogisticInterface]] <abstract>
**** [[Prototype/ConstructionRobot]] '''construction-robot'''
**** [[Prototype/LogisticRobot]] '''logistic-robot'''
** [[Prototype/Gate]] '''gate'''
** [[Prototype/Generator]] '''generator'''
** [[Prototype/HeatInterface]] '''heat-interface'''
** [[Prototype/HeatPipe]] '''heat-pipe'''
** [[Prototype/Inserter]] '''inserter'''
** [[Prototype/Lab]] '''lab'''
** [[Prototype/Lamp]] '''lamp'''
** [[Prototype/LandMine]] '''land-mine'''
** [[Prototype/Market]] '''market'''
** [[Prototype/MiningDrill]] '''mining-drill'''
** [[Prototype/OffshorePump]] '''offshore-pump'''
** [[Prototype/Pipe]] '''pipe'''
*** [[Prototype/InfinityPipe]] '''infinity-pipe'''
** [[Prototype/PipeToGround]] '''pipe-to-ground'''
** [[Prototype/PlayerPort]] '''player-port'''
** [[Prototype/PowerSwitch]] '''power-switch'''
** [[Prototype/ProgrammableSpeaker]] '''programmable-speaker'''
** [[Prototype/Pump]] '''pump'''
** [[Prototype/Radar]] '''radar'''
** [[Prototype/Rail]] <abstract>
*** [[Prototype/CurvedRail]] '''curved-rail'''
*** [[Prototype/StraightRail]] '''straight-rail'''
** [[Prototype/RailSignalBase]] <abstract>
*** [[Prototype/RailChainSignal]] '''rail-chain-signal'''
*** [[Prototype/RailSignal]] '''rail-signal'''
** [[Prototype/Reactor]] '''reactor'''
** [[Prototype/Roboport]] '''roboport'''
** [[Prototype/SimpleEntity]] '''simple-entity'''
** [[Prototype/SimpleEntityWithOwner]] '''simple-entity-with-owner'''
** [[Prototype/SimpleEntityWithForce]] '''simple-entity-with-force'''
** [[Prototype/SolarPanel]] '''solar-panel'''
** [[Prototype/StorageTank]] '''storage-tank'''
** [[Prototype/TrainStop]] '''train-stop'''
** [[Prototype/TransportBeltConnectable]] <abstract>
*** [[Prototype/Loader]] '''loader'''
*** [[Prototype/Splitter]] '''splitter'''
*** [[Prototype/TransportBelt]] '''transport-belt'''
*** [[Prototype/UndergroundBelt]] '''underground-belt'''
** [[Prototype/Tree]] '''tree'''
** [[Prototype/Turret]] '''turret'''
*** [[Prototype/AmmoTurret]] '''ammo-turret'''
*** [[Prototype/ElectricTurret]] '''electric-turret'''
*** [[Prototype/FluidTurret]] '''fluid-turret'''
** [[Prototype/Unit]] '''unit'''
** [[Prototype/Vehicle]] <abstract>
*** [[Prototype/Car]] '''car'''
*** [[Prototype/RollingStock]] <abstract>
**** [[Prototype/ArtilleryWagon]] '''artillery-wagon'''
**** [[Prototype/CargoWagon]] '''cargo-wagon'''
**** [[Prototype/FluidWagon]] '''fluid-wagon'''
**** [[Prototype/Locomotive]] '''locomotive'''
** [[Prototype/Wall]] '''wall'''
* [[Prototype/Explosion]] '''explosion'''
** [[Prototype/FlameThrowerExplosion]] '''flame-thrower-explosion'''
* [[Prototype/FireFlame]] '''fire'''
* [[Prototype/FluidStream]] '''stream'''
* [[Prototype/FlyingText]] '''flying-text'''
* [[Prototype/HighlightBoxEntity]] '''highlight-box'''
* [[Prototype/ItemEntity]] '''item-entity'''
* [[Prototype/ItemRequestProxy]] '''item-request-proxy'''
* [[Prototype/LegacyDecorative]] '''decorative''' probably exists for migration
* [[Prototype/Particle]] '''particle'''
** [[Prototype/ArtilleryFlare]] '''artillery-flare'''
** [[Prototype/LeafParticle]] '''leaf-particle'''
* [[Prototype/ParticleSource]] '''particle-source'''
* [[Prototype/Projectile]] '''projectile'''
* [[Prototype/ResourceEntity]] '''resource'''
* [[Prototype/RocketSiloRocket]] '''rocket-silo-rocket'''
* [[Prototype/RocketSiloRocketShadow]] '''rocket-silo-rocket-shadow'''
* [[Prototype/Smoke]] <abstract>
** [[Prototype/SimpleSmoke]] '''smoke'''
** [[Prototype/SmokeWithTrigger]] '''smoke-with-trigger'''
* [[Prototype/SpeechBubble]] '''speech-bubble'''
* [[Prototype/Sticker]] '''sticker'''
* [[Prototype/TileGhost]] '''tile-ghost'''
</div>

== Mandatory properties ==
Inherits all properties from [[PrototypeBase]].

=== order ===
:''See [[PrototypeBase#order]]''
Inherited from [[PrototypeBase]]. It is mandatory for entities that have at least one of these flags active: placeable-neutral, placeable-player, placeable-enemy.

{{Prototype property|icons, icon, icon_size (IconSpecification)|[[Types/IconSpecification|IconSpecification]]}}
An icon is mandatory for entities that have at least one of these flags active: placeable-neutral, placeable-player, placeable-enemy.

The icon will be used in the editor building selection and the bonus gui.
<syntaxhighlight lang="lua">icon = "__base__/graphics/icons/wooden-chest.png"</syntaxhighlight>

== Optional properties ==

{{Prototype property|collision_box|[[Types/BoundingBox|BoundingBox]]|Empty=<nowiki>{{0, 0}, {0, 0}} means no collisions.</nowiki>|optional=true}}
Specification of the entity collision boundaries.

Empty collision box is used for smoke, projectiles, particles, explosions etc.
<syntaxhighlight lang="lua">collision_box = {{-0.4, -0.4}, {0.4, 0.4}}</syntaxhighlight>
The {0,0} coordinate in the collision box will match the entity position.

It should be near the center of the collision box, to keep correct entity drawing order. It must include the {0,0} coordinate.

Note, that for buildings, it is customary to leave 0.1 wide border between the edge of the tile and the edge of the building, this lets the player move between the building and electric poles/inserters etc.

{{Prototype property|collision_mask|[[Types/CollisionMask|CollisionMask]]|<nowiki>{"item-layer", "object-layer", "player-layer", "water-tile"}</nowiki>|optional=true}}

Two entities can collide only if they share a layer from the collision mask.

<div class="toccolours mw-collapsible mw-collapsed">
NOTE: '''Some entity types have their own default''' that differs from the above default. They are listed here:
<div class="mw-collapsible-content">
* [[Prototype/Arrow]] - no masks
* [[Prototype/ArtilleryProjectile]] - no masks
* [[Prototype/Beam]] - no masks
* [[Prototype/Car]] - <code>{"player-layer", "train-layer", "consider-tile-transitions"}</code>
* [[Prototype/Character]] - <code>{"player-layer", "train-layer", "consider-tile-transitions"}</code>
* [[Prototype/CharacterCorpse]] - no masks
* [[Prototype/Cliff]] - <code>{ "item-layer", "object-layer", "player-layer", "water-tile", "not-colliding-with-itself"}</code>
* [[Prototype/Corpse]] - no masks
* [[Prototype/DeconstructibleTileProxy]] - <code>{"ground-tile"}</code>
* [[Prototype/EntityGhost]] - <code>{"ghost-layer"}</code>
* [[Prototype/Explosion]] - no masks
* [[Prototype/FireFlame]] - no masks
* [[Prototype/Fish]] - <code>{"ground-tile", "colliding-with-tiles-only"}</code>
* [[Prototype/FluidStream]] - no masks
* [[Prototype/FlyingRobot]] - no masks
* [[Prototype/FlyingText]] - no masks
* [[Prototype/Gate]] - <code>{"item-layer", "object-layer", "player-layer", "water-tile", "train-layer"}</code>
* [[Prototype/HeatPipe]] - <code>{"object-layer", "floor-layer", "water-tile"}</code>
* [[Prototype/HighlightBoxEntity]] - no masks
* [[Prototype/ItemEntity]] - <code>{"item-layer"}</code>
* [[Prototype/ItemRequestProxy]] - no masks
* [[Prototype/LandMine]] - <code>{"object-layer", "water-tile"}</code>
* [[Prototype/LegacyDecorative]] - <code>{"doodad-layer", "not-colliding-with-itself")</code>
* [[Prototype/Loader]] - <code>{"object-layer", "item-layer", "water-tile"}</code>
* [[Prototype/Particle]] - no masks
* [[Prototype/ParticleSource]] - no masks
* [[Prototype/PlayerPort]] - <code>{"object-layer", "floor-layer", "water-tile"}</code>
* [[Prototype/Projectile]] - no masks
* [[Prototype/Rail]] - <code>{"item-layer", "object-layer", "floor-layer", "water-tile", "not-colliding-with-itself"}</code>
* [[Prototype/RailSignalBase]] - <code>{"item-layer", "floor-layer"}</code>
* [[Prototype/ResourceEntity]] - <code>{"resource-layer"}</code>
* [[Prototype/RollingStock]] - <code>{"train-layer"}</code>
* [[Prototype/Smoke]] - no masks
* [[Prototype/SpeechBubble]] - no masks
* [[Prototype/Splitter]] - <code>{"object-layer", "item-layer", "water-tile"}</code>
* [[Prototype/Sticker]] - no masks
* [[Prototype/TileGhost]] - <code>{"ghost-layer"}</code>
* [[Prototype/TransportBelt]] - <code>{"object-layer", "floor-layer", "water-tile"}</code>
* [[Prototype/UndergroundBelt]] - <code>{"object-layer", "item-layer", "water-tile"}</code>
* [[Prototype/Unit]] - <code>{"player-layer", "train-layer"}</code>
* [[Prototype/Vehicle]] - <code>{"player-layer", "train-layer"}</code>
</div></div>

{{Prototype property|map_generator_bounding_box|[[Types/BoundingBox|BoundingBox]]|The value of collision box.|optional=true}}
Used instead of the collision box during map generation. Allows space entities differently during map generation, for example if the box is bigger, the entities will be placed farther apart.

{{Prototype property|selection_box|[[Types/BoundingBox|BoundingBox]]|<nowiki>Empty = {{0, 0}, {0, 0}}</nowiki>|optional=true}}
Specification of the entity selection area.
When empty the entity will have no selection area (and thus is not selectable).
<syntaxhighlight lang="lua">selection_box = {{-0.5, -0.5}, {0.5, 0.5}}</syntaxhighlight>
The selection box is usually a little bit bigger than the collision box, for tilable entities (like buildings) it should match the tile size of the building.

{{Prototype property|drawing_box|[[Types/BoundingBox|BoundingBox]]|<nowiki>Empty = {{0, 0}, {0, 0}} (selection_box is used instead)</nowiki>|optional=true}}
Specification of space needed to see the whole entity.

This is used to calculate the correct zoom and positioning in the entity info gui.
<syntaxhighlight lang="lua">drawing_box = {{-0.5, -0.5}, {0.5, 0.5}}</syntaxhighlight>

{{Prototype property|sticker_box|[[Types/BoundingBox|BoundingBox]]|The value of collision box.|optional=true}}
Used to set the area of the entity that can have stickers on it, currently only used for units to specify the area where the green slow down stickers can appear.
It is optional and the collision box is used when not specified.
<syntaxhighlight lang="lua">sticker_box = {{-0.5, -0.5}, {0.5, 0.5}}</syntaxhighlight>

{{Prototype property|hit_visualization_box|[[Types/BoundingBox|BoundingBox]]|<nowiki>Empty = {{0, 0}, {0, 0}}</nowiki>|optional=true}}
Where beams should hit the entity. Useful if the bounding box only covers part of the entity (e.g. feet of the character) and beams only hitting there would look weird.

{{Prototype property|flags|[[Types/EntityPrototypeFlags|EntityPrototypeFlags]]|optional=true}}

{{Prototype property|minable|[[Types/MinableProperties|MinableProperties]]|<nowiki>{minable = false, mining_time = 0}</nowiki>|optional=true}}

{{Prototype property|subgroup|[[Types/string|string]]|optional=true}}
The name of the subgroup this entity should be sorted into in the map editor building selection.

{{Prototype property|allow_copy_paste|[[Types/bool|bool]]|true|optional=true}}

{{Prototype property|selectable_in_game|[[Types/bool|bool]]|true|optional=true}}

{{Prototype property|selection_priority|[[Types/uint8|uint8]]|50|optional=true}}
The entity with the higher number is selectable before the entity with the lower number.

{{Prototype property|emissions_per_second|[[Types/double|double]]|0|optional=true}}
Amount of emissions created (positive number) or cleaned (negative number) every second by the entity.
This is passive, and it is independent concept of the emissions of machines, these are created actively depending on the power consumption.
Currently used just for trees.

<syntaxhighlight lang="lua">emissions_per_second = -0.0005 -- cleaning effect of big tree</syntaxhighlight>

{{Prototype property|emissions_per_tick|[[Types/double|double]]|0|optional=true}}
[[#emissions_per_second]], but per tick. Deprecated.

{{Prototype property|shooting_cursor_size|[[Types/double|double]]|optional=true}}
The cursor size used when shooting at this entity.

{{Prototype property|created_smoke|[[Types/CreateTrivialSmokeEffectItem|CreateTrivialSmokeEffectItem]]|optional=true}}
The smoke that is shown when the entity is placed. Default is using the "smoke-building" smoke.

{{Prototype property|autoplace|[[Types/AutoplaceSpecification|AutoplaceSpecification]]|nil (entity is not autoplacable)|optional=true}}
Used to specify the rules for placing this entity during map generation.

{{Prototype property|working_sound|[[Types/WorkingSound|WorkingSound]]|optional=true}}
Will also work on entities that don't actually do work.

{{Prototype property|created_effect|[[Types/Trigger|Trigger]]|optional=true}}
The effect/trigger that happens when the entity is placed.

{{Prototype property|build_sound|[[Types/Sound|Sound]]|optional=true}}

{{Prototype property|mined_sound|[[Types/Sound|Sound]]|optional=true}}

{{Prototype property|vehicle_impact_sound|[[Types/Sound|Sound]]|optional=true}}

{{Prototype property|open_sound|[[Types/Sound|Sound]]|optional=true}}

{{Prototype property|close_sound|[[Types/Sound|Sound]]|optional=true}}

{{Prototype property|build_base_evolution_requirement|[[Types/double|double]]|0|optional=true}}

{{Prototype property|alert_icon_shift|[[Types/vector|vector]]|optional=true}}

{{Prototype property|alert_icon_scale|[[Types/float|float]]|optional=true}}

{{Prototype property|fast_replaceable_group|[[Types/string|string]]|optional=true}}
This allows you to replace an entity that's already placed, with a different one in your inventory. For example, replacing a burner inserter with a fast inserter.

This is simply a string, so any string can be used here. The entity that should be replaced simply has to use the same string here.

The ones the game uses are:

"underground-belt"
"loader"
"splitter"
"transport-belt"
"assembling-machine"
"container"
"long-handed-inserter"
"inserter"
"wall"
"rail-signal"
"container"
"pipe"
"furnace"
"steam-engine"

{{Prototype property|next_upgrade|[[Types/string|string]]|optional=true}}
Name of the entity that will be automatically selected as the upgrade of this entity when using the [[upgrade planner]] without configuration.

This entity may not have 'not-upgradable' flag set and must be minable. This entity must produce no item result or mine to an item that isn't hidden.<br>
The upgrade target entity needs to have the same bounding box, collision mask, and fast replaceable group as this entity. The upgrade target entity must have least 1 item that builds it that isn't hidden.

{{Prototype property|placeable_by|[[Types/ItemToPlace|ItemToPlace]] or [[Types/table|table]] of [[Types/ItemToPlace|ItemToPlace]]|optional=true}}
Item that when placed creates this entity. Also determines which item is picked when "Q" (smart pipette) is used on the entity.

{{Prototype property|remains_when_mined|[[Types/string|string]] or [[Types/table|table]] of [[Types/string|string]]|optional=true}}
The entity that remains when this one is mined, deconstructed or fast-replaced. The entity wont actually be spawned if it would collide with the entity that is in the process of being mined.

{{Prototype property|additional_pastable_entities|[[Types/string|string]] or [[Types/table|table]] of [[Types/string|string]]|optional=true}}
Entities this entity prototype can be pasted on to in addition to the standard supported types.
This is used to allow copying between types that aren't compatible on the C++ code side.

{{Prototype property|tile_width|[[Types/uint32|uint32]]|calculated by the collision box width rounded up.|optional=true}}
Used to determine how the center of the entity should be positioned when building (unless the offgrid [[Types/EntityPrototypeFlags|flag]] is specified).
When the tile width is odd, the center will be in the center of the tile, when it is even, the center is on the tile transition.

{{Prototype property|tile_height|[[Types/uint32|uint32]]|calculated by the collision box height rounded up.|optional=true}}

{{Prototype property|map_color|[[Types/Color|Color]]|optional=true}}

{{Prototype property|friendly_map_color|[[Types/Color|Color]]|optional=true}}

{{Prototype property|enemy_map_color|[[Types/Color|Color]]|optional=true}}

== Example ==
<syntaxhighlight lang="lua">{
type = "container",
name = "wooden-chest",
icon = "__base__/graphics/icons/wooden-chest.png",
flags = {"placeable-neutral", "player-creation"},
minable = {mining_time = 1, result = "wooden-chest"},
max_health = 100,
corpse = "small-remnants",
collision_box = {{-0.35, -0.35}, {0.35, 0.35}},
fast_replaceable_group = "container",
selection_box = {{-0.5, -0.5}, {0.5, 0.5}},
inventory_size = 16,
open_sound = { filename = "__base__/sound/wooden-chest-open.ogg" },
close_sound = { filename = "__base__/sound/wooden-chest-close.ogg" },
vehicle_impact_sound = { filename = "__base__/sound/car-wood-impact.ogg", volume = 1.0 },
picture =
{
filename = "__base__/graphics/entity/wooden-chest/wooden-chest.png",
priority = "extra-high",
width = 46,
height = 33,
shift = {0.25, 0.015625}
},
circuit_wire_connection_point =
{
shadow =
{
red = {0.734375, 0.453125},
green = {0.609375, 0.515625},
},
wire =
{
red = {0.40625, 0.21875},
green = {0.40625, 0.375},
}
},
circuit_connector_sprites = get_circuit_connector_sprites({0.1875, 0.15625}, nil, 18),
circuit_wire_max_distance = 9
}</syntaxhighlight>

Pollution

2019-03-09T16:51:34Z

Mulark: /* Chunks */ Update table to reflect 0.17 values

{{languages}}
[[File:Pollution.png|400px|thumb|Example of in-game pollution (red squares) in the map]]

Pollution is represented as an abstract "cloud", updated [[Chunk|per chunk]] every game second (60 ticks) and visible on the map, when "alt-view" is on (default [[Keyboard bindings|Alt-Key]]). It appears as a red colored blocky cloud.

It is produced by many buildings involved in processing items and spreads outwards at a steady rate.

The [[Enemies#Evolution|evolution factor]] is not increased by the spreading/absorbed pollution, but by the pollution produced by all the player's [[Pollution#Polluters|machinery]] at every tick. This means that no matter how hard the player tries to contain the pollution, [[enemies]] will still evolve at the same rate. They just won't attack the player as frequently. The pollution cloud is used to trigger biter attacks and determines the size of the attacks.

Pollution settings can be changed via [[map generator|map generation]] settings, or can be disabled entirely.

== Pollution spread ==

As soon as a chunk has reached 15.0 pollution it starts spreading in all four cardinal directions at a rate of 2% per [[game-second]] (60 ticks).

For example, a chunk with 400.0 pollution and 4 adjacent chunks with 100.0 pollution each, raises the pollution in all adjacent chunks by 8.0 while reducing its own pollution by 32.0. But every one of the 4 surrounding spreads 2.0 pollution "back" to the center chunk, so it only loses 24.0 + [[Pollution#De-polluters|absorbed value]].

== Pollution dissipation==

* Every [[chunk]] (32x32) of map slowly reduces the pollution it covers (See [[Pollution#Chunks]]). So the more the pollution spreads, the more is absorbed.
* [[Tree]]s also absorb some pollution (See [[Pollution#Trees]]).
* [[Enemies#Spawner|Spawners]] absorb a great amount of pollution, and use this to produce enemies.

== Native life ==
Pollution attracts [[Enemies|biters]] to the Player's factory. Biters who find themselves in a polluted area will attempt to reach the source of pollution and destroy it.

Each [[Enemies|spawner]] absorbs 20 + 0.01 * [chunk's pollution] every game second (60 ticks) if the chunk's pollution is greater than 20. If there is 20 or less pollution in the chunk, the spawner absorbs all the pollution.

Higher pollution values decrease the time it takes for biters to join the attack force. After a certain amount of pollution is absorbed the spawner sends one of its biters/spitters to a rendezvous point. 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.

Required pollution to add an additional biter/spitter to the attack wave:
{| class="wikitable" style="text-align:right;"
! style="width: 100px;" | Pollution 
! style="width: 130px;" | Type 
|-
| 200  || Small biter 
|-
| 1,000  || Medium biter 
|-
| 4,000  || Big biter 
|-
| 20,000  || Behemoth biter 
|-
| 200  || Small spitter 
|-
| 600  || Medium spitter 
|-
| 1,500  || Big spitter 
|-
| 10,000  || Behemoth spitter 
|-
|}

With 1350 absorbed pollution at the time of attack the following wave consists of 6 small biters and 1 medium biter OR 6 small spitters and 2 medium spitters depending on the spawner's type and [[Enemies#Spawn_chances_by_evolution_factor|evolution factor]].

== Modules ==
[[Module]]s that list "+x% pollution" increase pollution multiplier, not a flat pollution rate. Final pollution value is (pollution multiplier * energy usage multiplier * base pollution), meaning heavily boosted buildings are likely to account for most of the pollution produced in a factory.

== Production/Absorption ==
These tables contain information about the levels of pollution produced/absorbed by items in the game.
=== Polluters ===
{| class="wikitable"
| '''Object''' || '''Pollution per KW per game second (60 ticks)''' || '''Pollution per game second at full power'''
|-
| {{Imagelink|Stone furnace}} || 0.01/KW || 1.8
|-
| {{Imagelink|Steel furnace}} || 0.02/KW || 3.6
|-
| {{Imagelink|Electric furnace}} || 0.005/KW || 0.9
|-
| {{Imagelink|Burner mining drill}} || 0.03333/KW || 10
|-
| {{Imagelink|Electric mining drill}} || 0.1/KW || 9
|-
| {{imagelink|Pumpjack}} || 0.1/KW || 9
|-
| {{Imagelink|Assembling machine 1}} || 0.03333/KW || 3
|-
| {{Imagelink|Assembling machine 2}} || 0.016/KW || 2.4
|-
| {{Imagelink|Assembling machine 3}} || 0.00857/KW || 1.8
|-
| {{Imagelink|Pump}} || 0.004/KW || 0.12
|-
| {{imagelink|Boiler}} || 0.01538/KW || 27.6923
|-
| {{Imagelink|Oil refinery}} || 0.00857/KW || 3.6
|-
| {{Imagelink|Chemical plant}} || 0.00857/KW || 1.8
|-
| {{Imagelink|Centrifuge}} || 0.016/KW || 5.6
|-
|}

Fire on the ground and burning trees produce 0.005 pollution per tick.

=== De-polluters ===

==== Spawner ====
If a chunk's pollution is greater than 20, each enemy spawner absorbs 20 + 0.01 * [chunk's pollution] every game second (60 ticks), otherwise it absorbs the chunk's total pollution.

==== Chunks ====
Every chunk has a natural absorption rate per tick which is determined by the weighted average of its floor tiles.

Following numbers are the pollution reduction for a full chunk (32x32 tiles) composed of the same floor tiles per tick.
{| class="wikitable"
! Tile !! Pollution per tick !! Pollution per second
|-
|Grass 1-4 || -0.00045|| -0.027
|-
|Dirt 1|| -0.0004|| -0.024
|-
|Dirt 2-7 || -0.00045|| -0.027
|-
|Dry dirt || -0.00039|| -0.0234
|-
|Sand 1-3 || -0.00039|| -0.0234
|-
|Red desert 0 || -0.00045|| -0.027
|-
|Red desert 1-3 || -0.0004|| -0.024
|-
|Water, Green water, Deep water, Deep green water || -0.0003 || -0.018
|-
|Path tiles (Stone bricks, concrete etc) || 0.0 || 0.0
|-
|Special tiles (Lab tiles, out of map, tutorial grid) || -0.0006 || -0.036
|-
|}

==== Trees ====
Every single tree absorbs a small amount of pollution in its chunk per tick if the total pollution in that chunk is above 3500 units. By absorbing pollution, trees lose their leaves for every 500 pollution absorbed. The less dense the leaves, the slower the tree absorbs pollution.

{| class="wikitable"
! Object !! Stage !! Pollution per tick !! Pollution per second
|-
| rowspan="4" | [[File:Green tree.png|120px]] Tree, red tree, brown tree || 0 (Max leaf density) || -0.001 || -0.06
|-
| 1 || -0.00067 || -0.04
|-
| 2 || -0.00033 || -0.02
|-
| 3 (Min leaf density) || 0 || 0
|-
| [[File:Dead dry hairy tree.png|120px]] Dead dry hairy tree || No stages || -0.0001 || -0.006
|-
| [[File:Dead grey trunk.png|120px]] Dead grey trunk || No stages || -0.0001 || -0.006
|-
| [[File:Dead tree desert.png|120px]] Dead tree - desert|| No stages || -0.0001 || -0.006
|-
| [[File:Dry hairy tree.png|120px]] Dry hairy tree || No stages || -0.0001 || -0.006
|-
| [[File:Dry tree.png|120px]] Dry tree || No stages || -0.0001 || -0.006
|-
|}

== Achievements ==
Pollution is directly connected to the following achievement:
{{Achievement|it-stinks-and-they-dont-like-it}}

== History ==

{{history|0.13.2|
* Optimized rendering of huge pollution clouds on the map.}}

{{history|0.13.0|
* Large amounts of pollution is created when burning fires.
* Pollution creation of the productivity module was reduced drastically.
* Optimized pollution rendering on map and minimap.
}}

{{history|0.12.0|
* [[Tree]]s degenerate slowly when exposed to pollution at high levels. }}

{{history|0.8.0|
* Added option to turn off pollution visibility even when detailed info is on. }}

{{history|0.7.1|
* Speed modules no longer produce extra pollution.
* Added missing pollution descriptions.
* Pollution is only shown on the minimap with alt mode on.
}}

{{history|0.7.0|
* Introduced concept of pollution.}}

== See also ==
* [[Crafting]]
* [[Module]]s
* [[Enemies]]