Official Factorio Wiki - User contributions [en]

Tutorial:Mod settings

2024-10-09T18:50:51Z

Lovely santa: Corrected error in example for string setting localisations

{{Languages}}
This tutorial aims to explain how to create and use mod settings. Basic knowledge of modding is assumed, so you should have at least understood [[Tutorial:Modding tutorial/Gangsir|Gangsir's modding tutorial]].

== Overview ==
Each mod can specify settings that users can change. The values of these settings can be accessed from inside the data stage or the control stage depending on their [[#The_setting_type_property|setting_type]] and allow to conditionally create or modify prototypes and to add configuration options to control scripts. They allow modders to easily create a graphical interface for their configuration options, instead of using on text files that have to be edited manually by users.

== Location ==

Mod settings are defined in the [https://lua-api.factorio.com/latest/Data-Lifecycle.html settings stage]. This stage is loaded before the data stage. There are three files in which settings can be defined:
* settings.lua
* settings-updates.lua
* settings-final-fixes.lua

First the settings.lua file is called for each mod, in the order of their dependencies and then in the [[:Wikipedia:natural sort order|natural sort order]]. After settings.lua has been called for all mods, the settings-updates.lua file is called for each mod (in the same order) and finally the settings-final-fixes.lua file is called for each mod (in the same order). These 3 different phases of the settings stage allow to change settings of other mods without needing to rely on dependencies to load last. The settings are all defined in the same stage and their user defined values are not available, therefore mods cannot conditionally create settings depending on the values of other mod settings. Since the settings stage gets loaded first, there is also no prototype data or [http://lua-api.factorio.com/latest/LuaRemote.html remote interface] available.

The "mod-settings.dat" file stored in the [[Application_directory#User_Data_directory|mods folder]] for the game contains the local players settings between game sessions similar to the player-data.json file.

== Creation ==

Mod settings are defined and modified by using the data table during the settings stage. This works [[Tutorial:Modding_tutorial/Gangsir#Prototype_creation|the same way as other prototypes]]. An example would be:
<syntaxhighlight lang="lua">
data:extend({
{
type = "bool-setting",
name = "my-mod-test-setting",
setting_type = "runtime-global",
default_value = true
}
})
</syntaxhighlight>

As you can see, the setting has multiple properties. Each setting supports the following standard prototype properties:
* name - [[Types/string|string]] - Mandatory.
* type - [[Types/string|string]] - Mandatory.
* localised_name - [[Types/LocalisedString|LocalisedString]] - Optional.
* localised_description - [[Types/LocalisedString|LocalisedString]] - Optional.
* [[Types/Order|order]] - [[Types/string|string]] - Optional.

In addition to the standard properties, mod settings also contain:

* hidden - [[Types/bool|bool]] - Optional.
* setting_type - [[Types/string|string]] - Mandatory.

=== The name property ===

The name of the settings prototype should be unique to avoid mod conflicts since the mod settings are global across all mods. Because of that it is recommened to prefix mod settings with your mod name, "my-mod" in this example.

=== The type property ===

There are four types of mod settings:

* bool-setting - a true/false checkbox
* int-setting - a signed 64 bit integer textfield (or selection dropdown)
* double-setting - a double precision floating point textfield (or selection dropdown)
* string-setting - a string textfield (or selection dropdown)
* color-setting - a color picker (sliders), with whole number textfields. Includes alpha.

Depending on the type, the prototype also allows or requires additional properties, these are listed below.

==== bool-setting ====
* default_value - [[Types/bool|bool]] - Mandatory.
** Defines the default value of the setting, in this case whether the checkbox is checked or not.
* forced_value - [[Types/bool|bool]] - Optional.
** Only loaded if <code>hidden = true</code>. This forces the setting to be of this value. This can be useful for mod compatiblity.[https://forums.factorio.com/viewtopic.php?p=531322#p531322]


==== int-setting ====
* default_value - [[Types/int64|int64]] - Mandatory.
** Defines the default value of the setting.
* minimum_value - [[Types/int64|int64]] - Optional.
** Defines the lowest possible number.
* maximum_value - [[Types/int64|int64]] - Optional.
** Defines the highest possible number.
* allowed_values - [[Types/table|array]] of [[Types/int64|int64]] - Optional.
** Makes it possible to force the player to choose between the defined numbers, creates a dropdown instead of a texfield.
** If only one allowed value is given, the settings is forced to be of that value.

==== double-setting ====
* default_value - [[Types/double|double]] - Mandatory.
** Defines the default value of the setting.
* minimum_value - [[Types/double|double]] - Optional.
** Defines the lowest possible number.
* maximum_value - [[Types/double|double]] - Optional.
** Defines the highest possible number.
* allowed_values - [[Types/table|array]] of [[Types/double|double]] - Optional.
** Makes it possible to force the player to choose between the defined numbers, creates a dropdown instead of a textfield.
** If only one allowed value is given, the settings is forced to be of that value.

==== string-setting ====
* default_value - [[Types/string|string]] - Mandatory.
** Defines the default value of the setting.
* allow_blank - [[Types/bool|bool]] - Optional. - Default: false
** Defines whether it's possible for the user to set the textfield to empty and apply the setting.
* auto_trim - [[Types/bool|bool]] - Optional. - Default: false
** Whether values that are input by the user should have whitespace removed from both ends of the string.
* allowed_values - [[Types/table|array]] of [[Types/string|string]] - Optional.
** Makes it possible to force the player to choose between the defined strings, creates a dropdown instead of a textfield. The strings in the dropdown can be localized (translated) and can have a tooltip, see below.
** If only one allowed value is given, the settings is forced to be of that value.

==== color-setting ====
* default_value - [[Types/Color|Color]] - Mandatory.
** Defines the default value of the setting.

=== The order property ===

The order property can be used to change how the mod settings are ordered in the settings gui. Mod settings are sorted
* first by mod
* then by the setting "order" string
* then finally by the setting name.

For more info on how to use the order string, see [[Types/Order]].

=== The hidden property ===

The hidden property can be used to hide mod settings from GUIs, so that they cannot be seen or changed by players. However, other mods can still access hidden settings.[https://forums.factorio.com/83316]

=== The setting_type property ===
[[File:Mod_settings_gui.png|right|300px|thumb|The mod settings gui. Can be reached from the main menu → Settings → Mod settings.]]
There are the overall kinds of settings:

* '''startup''': This kind of setting is available in the prototype stage, and can not be changed runtime. They have to be set to the same values for all players on a server.
* '''runtime-global''': This kind of setting is global to an entire save game and can be changed runtime. On servers, only admins can change these settings.
* '''runtime-per-user''': This kind of setting is only available runtime in the control.lua stage and each player has their own instance of this setting. When a player joins a server their local setting of "keep mod settings per save" determines if the local settings they have set are synced to the loaded save or if the save's settings are used.

This "setting_type" also determines in which tab the setting is showed in the mod settings menu.

=== Locale ===
The locale for mod settings works like any other locale in the game. The names of the groups for the setting name and description (tooltip) are "mod-setting-name" and "mod-setting-description". The dropdown items of a string setting can be localized in the "string-mod-setting" group, but the game falls back to just showing the name of the dropdown item if no localization is found. An example for mod setting localization that would be set within "locale/en/locale.cfg", is:
<pre>
[mod-setting-name]
my-mod-string-test-setting=Localized test setting name

[mod-setting-description]
my-mod-string-test-setting=Localized test setting description

[string-mod-setting]
#<setting-name>-<dropdown-item-name>=<translated dropdown item>
my-mod-string-test-setting-item-1=Item 1 localized string

[string-mod-setting-description]
#<setting-name>-<dropdown-item-name>=<tooltip of dropdown item>
my-mod-string-test-setting-item-1=Item 1 localized tooltip

</pre>

== Usage ==
=== Reading settings ===
When accessing any mod setting, you will have to specifically access the ''value'' of the setting. The data type of the value depends on the type of the setting. For string settings that use a selection of allowed values, the value of the setting is one of the original string values defined in the prototype, the localization is ignored. See also: [http://lua-api.factorio.com/latest/Concepts.html#ModSetting ModSetting concept].

In the prototype stage you can access settings of the setting_type "startup" by indexing <code>settings.startup</code> with the name of the setting. Example:
<syntaxhighlight lang="lua">
--in settings.lua:
data:extend({
{
type = "int-setting",
name = "my-mod-stone-wall-stack-size",
setting_type = "startup",
minimum_value = 1,
default_value = 100
}
})

--in data.lua:
data.raw.item["stone-wall"].stack_size = settings.startup["my-mod-stone-wall-stack-size"].value
</syntaxhighlight>

<div class="plainlinks">
In the control stage, the settings of the setting_type "runtime-global" can be accessed using <code>settings.global["setting-name"]</code> (see [https://lua-api.factorio.com/latest/LuaSettings.html LuaSettings]). Settings of the setting_type "runtime-per-user" are accessed using <code>settings.get_player_settings([https://lua-api.factorio.com/latest/Concepts.html#PlayerIdentification <PlayerIdentification>])["setting-name"]</code> or <code>game.players[[https://lua-api.factorio.com/latest/Concepts.html#PlayerIdentification <PlayerIdentification>]].mod_settings["setting-name"]</code>.
</div>
Example:
<syntaxhighlight lang="lua">
--in settings.lua:
data:extend({
{
type = "string-setting",
name = "my-mod-always-difficult",
setting_type = "runtime-global",
default_value = "yes",
allowed_values = {"yes", "no"}
},
{
type = "bool-setting",
name = "my-mod-kill-player-on-entity-built",
setting_type = "runtime-per-user",
default_value = false
}
})

--in control.lua:
script.on_init(function()
if settings.global["my-mod-always-difficult"].value == "yes" then
game.difficulty_settings.recipe_difficulty = 1
game.difficulty_settings.technology_difficulty = 1
game.difficulty_settings.technology_price_multiplier = 4
end
end)

script.on_event(defines.events.on_built_entity, function(event)
local setting_value = settings.get_player_settings(event.player_index)["my-mod-kill-player-on-entity-built"].value
if setting_value then
game.get_player(event.player_index).die()
end
end)
</syntaxhighlight>

=== Writing to your own settings ===
It is possible for mods to write to their own runtime (global or per player) mod settings. This is done by writing a new [https://lua-api.factorio.com/latest/Concepts.html#ModSetting ModSetting] table to the setting.

Example:
<syntaxhighlight lang="lua">
--in settings.lua:
data:extend({
{
type = "string-setting",
name = "my-mod-always-difficult",
setting_type = "runtime-global",
default_value = "yes",
allowed_values = {"yes", "no"}
}
})

--in control.lua:
script.on_event(defines.events.on_rocket_launched, function()
settings.global["my-mod-always-difficult"] = {value = "yes"}
end)
</syntaxhighlight>

=== Changing another mod's settings ===
After creating a setting in the settings stage, it is stored in data.raw until the end of the stage, so it can be altered from another mod.

Example:
<syntaxhighlight lang="lua">
--in settings-updates.lua:
data.raw["string-setting"]["my-mod-always-difficult"].order = "abc"
</syntaxhighlight>

If the intent is to force the setting to be of a certain value that cannot be modified by players, the properties [[#The_hidden_property|hidden]], allowed_values and forced_value can be used. Modifying existing settings of other mods can be useful for mod packs or other mod compatibility goals.[https://forums.factorio.com/viewtopic.php?p=531322#p531322]

Example:
<syntaxhighlight lang="lua">
--in settings-updates.lua:
data.raw["string-setting"]["my-mod-always-difficult"].hidden = true
data.raw["string-setting"]["my-mod-always-difficult"].allowed_values = {"no"}
data.raw["string-setting"]["my-mod-always-difficult"].default_value = "no"
</syntaxhighlight>

=== Tips ===
* Do not conditionally 'require(...)' things depending on mod settings: This breaks the CRC checks and people will get errors trying to use your mod in multiplayer. 'require(...)' everything and then conditionally add the values to data.raw using the settings.
* You should cache the settings table inside the event you use it in. Accessing it is relatively expensive (about as expensive as accessing game.*prototypes[...]), so when accessing it mutliple times within the same event, you should set a local variable to it (within the event) to improve performance.
** If you want to cache startup/and runtime settings outside of events, you will have to makes sure that the local variable of settings of the setting_type "runtime-global" are updated in the <code>on_runtime_mod_setting_changed</code> event.
* If you want to detect whether a certain mod is installed in the settings stage, you can use <code>if mods["another-mods-name"] then</code>, just like in the data stage.

== See also ==
* [https://forums.factorio.com/viewtopic.php?p=207275 Forum post documenting mod settings]
* [https://forums.factorio.com/viewtopic.php?p=305644#p305644 per_user is not a valid property and has no effects!]
* [http://lua-api.factorio.com/latest/LuaSettings.html Lua api documentation on the settings table]

[[Category:Modding]]

Prototype/MiningDrill

2023-02-27T21:33:29Z

Lovely santa: corrected base_productivity

{{Prototype parent|Prototype/EntityWithOwner}}
A mining drill for automatically extracting resources from [[Prototype/ResourceEntity|resource entities]]. This prototype type is used by [[burner mining drill]], [[electric mining drill]] and [[pumpjack]] in vanilla.

{{Prototype TOC|mining-drill}}

== Mandatory properties ==
This prototype inherits the properties of [[Prototype/EntityWithOwner]].

{{Prototype property|vector_to_place_result|[[Types/vector|vector]]}}
The position where any item results are placed, when the mining drill is facing north (default direction). If the drill does not produce any solid items but uses a fluidbox output instead (e.g. pumpjacks), a vector of {0,0} disables the yellow arrow alt-mode indicator for the placed item location.

{{Prototype property|resource_searching_radius|[[Types/double|double]]}}
The distance from the centre of the mining drill to search for resources in.

This is 2.49 for electric mining drills (a 5x5 area) and 0.99 for burner mining drills (a 2x2 area). The drill searches resource outside its natural boundary box, which is 0.01 (the middle of the entity); making it 2.5 and 1.0 gives it another block radius.

{{Prototype property|energy_usage|[[Types/Energy|Energy]]}}
The amount of energy used by the drill while mining. Can't be less than or equal to 0.

{{Prototype property|mining_speed|[[Types/double|double]]}}
The speed of this drill.

{{Prototype property|energy_source|[[Types/EnergySource|EnergySource]]}}
The energy source of this mining drill.

{{Prototype property|resource_categories|[[Types/table|array]] of [[Types/string|string]]}}
The names of the [[Prototype/ResourceCategory]] that can be mined by this drill. For a list on built-in categories, see [[Data.raw#resource-category]].
Note: Categories containing resources which produce items, fluids, or items+fluids may be combined on the same entity, but may not work as expected.
Examples: Miner does not rotate fluid-resulting resources until depletion. Fluid isn't output (fluid resource change and fluidbox matches previous fluid). Miner with no vector_to_place_result can't output an item result and halts.

== Optional properties ==

{{Prototype property|output_fluid_box|[[Types/FluidBox|FluidBox]]|optional=true}}

{{Prototype property|input_fluid_box|[[Types/FluidBox|FluidBox]]|optional=true}}

{{Prototype property|animations|[[Types/Animation4Way|Animation4Way]]|optional=true}}
Loaded only if <code>graphics_set</code> does not exist.

{{Prototype property|graphics_set|[[Types/MiningDrillGraphicsSet|MiningDrillGraphicsSet]]|optional=true}}

{{Prototype property|wet_mining_graphics_set|[[Types/MiningDrillGraphicsSet|MiningDrillGraphicsSet]]|optional=true}}

{{Prototype property|base_picture|[[Types/Sprite4Way|Sprite4Way]]|optional=true}}
Used by the [[pumpjack]] to have a static 4 way sprite.

{{Prototype property|allowed_effects|[[Types/EffectTypeLimitation|EffectTypeLimitation]]|All effects are allowed|optional=true}}

{{Prototype property|radius_visualisation_picture|[[Types/Sprite|Sprite]]|optional=true}}
The sprite used to show the range of the mining drill.

{{Prototype property|circuit_wire_max_distance|[[Types/double|double]]|0|optional=true}}
The maximum circuit wire distance for this entity.

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

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

{{Prototype property|base_render_layer|[[Types/RenderLayer|RenderLayer]]|"lower-object"|optional=true}}

{{Prototype property|base_productivity|[[Types/float|float]]|0|optional=true}}
Productivity bonus that this machine always has. Any values below 0 will be changed to -100, disabling any productivity, even bonus productivity from research.

{{Prototype property|monitor_visualization_tint|[[Types/Color|Color]]|optional=true}}
When this mining drill is connected to the circuit network, the resource that it is reading (either the entire resource patch, or the resource in the mining area of the drill, depending on circuit network setting), is tinted in this color when mousing over the mining drill.

{{Prototype property|circuit_wire_connection_points|[[Types/table|table]] of [[Types/WireConnectionPoint|WireConnectionPoint]]|optional=true}}
Mandatory if circuit_wire_max_distance > 0.

{{Prototype property|circuit_connector_sprites|[[Types/table|table]] of [[Types/CircuitConnectorSprites|CircuitConnectorSprites]]|optional=true}}
Mandatory if circuit_wire_max_distance > 0.

{{Prototype property|module_specification|[[Types/ModuleSpecification|ModuleSpecification]]|optional=true}}

User:Lovely santa

2021-07-01T17:02:03Z

Lovely santa:

Hi, I am lovely_santa, I live in Belgium and I am a 25 year old electrical engineer. I am a casual gamer who likes to share his creations with others. I mostly play Factorio, and I try also to create some mod content for this game in my free time.

Property tree

2021-07-01T16:57:23Z

Lovely santa: Fixed wrong link to string datatype (https://forums.factorio.com/viewtopic.php?p=548580#p548580)

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

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

== The file format ==

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

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

== Property Tree Type ==

=== None ===
Nothing

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

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

=== String ===
1 [[Data_types#bool|bool]] if there is no string - otherwise, if there is a string:

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

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

=== List ===
Identical to Dictionary

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

For each element:

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

1 [[Property_tree]]

[[Category:Technical]]

Types/RenderLayer

2019-07-23T21:21:09Z

Lovely santa: Added example

The render layer specifies the order of the sprite when rendering, most of the objects have it hardcoded in the source, but some are configurable.

The value is specified as [[Types/uint8]] or [[Types/string]] (for example 7 and "decals" are both valid).

The order of acceptable string values are listed from lowest to highest:
* water-tile
* ground-tile
* tile-transition
* decals
* lower-radius-visualization
* radius-visualization
* transport-belt-integration
* resource
* building-smoke
* decorative
* ground-patch
* ground-patch-higher
* ground-patch-higher2
* remnants
* floor
* transport-belt
* transport-belt-endings
* corpse
* floor-mechanics
* item
* lower-object
* transport-belt-circuit-connector
* lower-object-above-shadow
* object
* higher-object-under
* higher-object-above
* item-in-inserter-hand
* wires
* wires-above
* entity-info-icon
* entity-info-icon-above
* explosion
* projectile
* smoke
* air-object
* air-entity-info-icon
* light-effect
* selection-box
* collision-selection-box
* arrow
* cursor

Types/RenderLayer

2019-07-23T21:19:49Z

Lovely santa: Types/RenderLayer can be represented as a value in range 0-255 as well

The render layer specifies the order of the sprite when rendering, most of the objects have it hardcoded in the source, but some are configurable.

The value is specified as [[Types/uint8]] or [[Types/string]].

The order of acceptable string values are listed from lowest to highest:
* water-tile
* ground-tile
* tile-transition
* decals
* lower-radius-visualization
* radius-visualization
* transport-belt-integration
* resource
* building-smoke
* decorative
* ground-patch
* ground-patch-higher
* ground-patch-higher2
* remnants
* floor
* transport-belt
* transport-belt-endings
* corpse
* floor-mechanics
* item
* lower-object
* transport-belt-circuit-connector
* lower-object-above-shadow
* object
* higher-object-under
* higher-object-above
* item-in-inserter-hand
* wires
* wires-above
* entity-info-icon
* entity-info-icon-above
* explosion
* projectile
* smoke
* air-object
* air-entity-info-icon
* light-effect
* selection-box
* collision-selection-box
* arrow
* cursor

Console

2019-07-04T11:03:32Z

Lovely santa: changed 2nd part of the code to also have the radius variable to be more inline with the first part.

{{Languages}}
== Overview ==
The '''Console''' is Factorio's command-line interface.

The in-game console is used for:

* Chatting with other players
* Running commands / scripts / cheats
* Occasional status updates

There are three types of commands:

* '''[[#Normal commands|Normal]]''' - Display information about the game and customize your experience.
* '''[[#Multiplayer commands|Multiplayer]]''' - Message filtering, banning users, etc.
* '''[[#Scripting and cheat commands|Scripting/Cheating]]''' - Run small Lua scripts (but they disable achievements for the save game)

=== Using the console ===
The console display can be toggled with the {{keybinding|/}} (slash) or {{keybinding|~}} (tilde) keys.

You can customize the keys via '''Options Menu → Keyboard → Toggle Lua console'''.
When the console is open, you'll see a blinking cursor at the bottom of the screen; type your message or command and hit '''Return''' to send it (this will also close the console).
Documentation about message and command prefixes can be found further down this page.

The console supports [[rich text]] tags. These tags are useful for sharing blueprints, marking map locations in chat or adding icons to map markers and train stations. Ctrl+alt clicking the map or ground will automatically insert a gps tag and post it into the console. Shift clicking most things with the console open will insert a tag for that thing into chat.

When console is closed, only the most recent messages/commands will be displayed, but they will gradually fade away (opening the console will immediately re-display all recent messages).
Note that by default, all executed commands are made visible to all users. You can set the fade out time via '''Options Menu → Other Settings → Message Delay'''.

If you want to immediately hide the console, open the console and then press '''Escape''' key (or press '''Return''' without entering any message/command).
This not only closes the console, but it also hides all the recent messages/commands.
The console can be cleared with the '''/clear''' command.

Note that the console can also accept raw Lua code as well as game commands.

=== Console history ===

The console has an inbuilt history; it's a bit like a text editor where only one line of text is displayed at a time.

Use the {{keybinding|↑}} and {{keybinding|↓}} keys to scroll through the console history.

Use the {{keybinding|←}} and {{keybinding|→}} keys to cursor through the currently displayed message or command, which you can edit (delete, insert, etc.) and resend (by pressing '''Return''').

The {{keybinding|Tab}} key will auto-complete commands and player ids.

== Normal commands ==

{| class="wikitable"
|-
! style="width:25%"| Command
! style="width:25%"| Example
! style="width:46%"| Description
! style="width:4%"| Admin only
|-
| /alerts <enable/disable/mute/unmute> <alert>
| /alerts disable turret_fire
| Enables, disables, mutes, or unmutes the given [[alerts|alert]] type. Available alerts: entity_destroyed, entity_under_attack, not_enough_construction_robots, no_material_for_construction, not_enough_repair packs, turret_fire, custom, no_storage, train_out_of_fuel, fluid_mixing.
| No
|-
| /clear
| /clear
| Clears the console.
| No
|-
| /color <color>
| /color 20 255 255 100
| Changes your color. Can either be one of the pre-defined colors or [[:Wikipedia:RGBA_color_space|RGBA value]] in the format of “# # # #”. Available colors: default, red, green, blue, orange, yellow, pink, purple, white, black, gray, brown, cyan, acid.
| No
|-
| /evolution
| /evolution
| Prints info about the alien evolution factor.
| No
|-
| /help [command]
| /help
| Prints a list of available commands, the optional argument can specify the command that should be described.
| No
|-
| /h [command]
| /h
| Same as /help.
| No
|-
| /mute-programmable-speaker <mute/unmute> <local/everyone>
| /mute-programmable-speaker mute local
| Mutes or unmutes the global sounds created by the Programmable Speaker. Use “local” to mute just the local client. Admins can use “everyone” to mute the sounds for everyone on the server.
| No
|-
| /perf-avg-frames <number>
| /perf-avg-frames 100
| Number of ticks/updates used to average performance counters. Default is 100. Value of 5-10 is recommended for fast convergence, but numbers will jitter more rapidly.
| No
|-
| /permissions
| /permissions
| Opens the permissions GUI.
| Yes
|-
| /screenshot [x resolution] [y resolution] [zoom]
| /screenshot
| Takes a screenshot with the GUI hidden, centered on the player. It is saved in the "script-output" subfolder of your [[User data directory]]. Resolution is optional and defaults to the current window size. Zoom is optional and defaults to 1.
| No
|-
| /seed
| /seed
| Prints the starting map seed.
| No
|-
| /time
| /time
| Prints info about how old the map is.
| No
|-
| /toggle-action-logging
| /toggle-action-logging
| Toggles logging all input actions performed by the game. This value isn’t persisted between game restarts and only affects your local game in multiplayer sessions.
| Yes
|-
| /toggle-heavy-mode
| /toggle-heavy-mode
| Used to investigate [[Desynchronization#Using_heavy_mode_command|desyncs]]. Will slow down the game and make multiplayer unplayable.
| Yes
|-
| /toggle-rockets-sent-gui
| /toggle-rockets-sent-gui
| Toggles if the rockets sent button is shown in the upper left corner of the screen.
| No
|-
| /unlock-shortcut-bar
| /unlock-shortcut-bar
| Unlocks all shortcut bar items.
| No
|-
| /version
| /version
| Prints the current game version.
| No
|-
|}

== Multiplayer commands ==

{| class="wikitable"
|-
! style="width:25%"| Command
! style="width:25%"| Example
! style="width:46%"| Description
! style="width:4%"| Admin only
|-
| <message>
| Hello team!
| Console input that does not start with {{keybinding|/}} is shown as a chat message to your team.
| No
|-
| /admin
| /admin
| Opens the player management GUI.
| Yes
|-
| /admins
| /admins
| Prints a list of game admins.
| No
|-
| /ban <player> <reason>
| /ban xTROLLx Throwing grenades in base
| Bans the specified player.
| Yes
|-
| /banlist <add/remove/get/clear> <player>
| /banlist get
| Adds or removes a player from the banlist. Same as /ban or /unban.
| No
|-
| /config <get/set> <option> <value>
| /config set password hunter2
| Gets or sets various multiplayer game settings. Available configs are: afk-auto-kick, allow-commands, allow-debug-settings, autosave-interval, autosave-only-on-server, ignore-player-limit-for-returning-players, max-players, max-upload-speed, only-admins-can-pause, password, require-user-verification, visibility-lan, visibility-public.
| Yes
|-
| /delete-blueprint-library <player>
| /delete-blueprint-library everybody confirm
| Deletes the blueprint library storage for the given offline player from the save file. Enter “everybody confirm” to delete the storage of all offline players.
| Yes
|-
| /demote <player>
| /demote AzureDiamond
| Demotes the player from admin.
| Yes
|-
| /ignore <player>
| /ignore Cthon98
| Prevents the chat from showing messages from this player. Admin messages are still shown.
| No
|-
| /ignores
| /ignores
| Prints a list of ignored players.
| No
|-
| /kick <player> <reason>
| /kick xTROLLx Throwing grenades in base
| Kicks the specified player.
| Yes
|-
| /mute <player>
| /mute Cthon98
| Prevents the player from saying anything in chat.
| Yes
|-
| /mutes
| /mutes
| All players that are muted (can’t talk in chat).
| No
|-
| /open <player>
| /open AzureDiamond
| Opens another player’s inventory.
| Yes
|-
| /o <player>
| /o AzureDiamond
| Same as /open.
| Yes
|-
| /players [online/o/count/c]
| /players
| Prints a list of players in the game. (parameter online/o, it prints only players that are online, count/c prints only count)
| No
|-
| /promote <player>
| /promote AzureDiamond
| Promotes the player to admin.
| Yes
|-
| /purge <player>
| /purge Cthon98
| Clears all the messages from this player from the chat log.
| Yes
|-
| /reply <message>
| /reply oh, really?
| Replies to the last player that whispered to you.
| No
|-
| /r <message>
| /r oh, really?
| Same as /reply.
| No
|-
| /server-save
| /server-save
| Saves the game on the server in a multiplayer game.
| Yes
|-
| /shout <message>
| /shout Hello world!
| Sends a message to all players including other forces.
| No
|-
| /s <message>
| /s Hello world!
| Same as /shout.
| No
|-
| /swap-players <player> [player]
| /swap-players AzureDiamond
| Swaps your character with the given player’s character, or if two players are given swaps the two player characters.
| Yes
|-
| /unban <player>
| /unban xTROLLx
| Unbans the specified player.
| Yes
|-
| /unignore <player>
| /unignore Cthon98
| Allows the chat to show messages from this player.
| No
|-
| /unmute <player>
| /unmute Cthon98
| Allows the player to talk in chat again.
| Yes
|-
| /whisper <player> <message>
| /whisper AzureDiamond thats what I see
| Sends a message to the specified player.
| No
|-
| /w <player> <message>
| /w AzureDiamond thats what I see
| Same as /whisper.
| No
|-
| /whitelist <add/remove/get/clear> [player]
| /whitelist get
| Adds or removes a player from the whitelist, where only whitelisted players can join the game. Enter nothing for “player” when using “get” to print a list of all whitelisted players. An empty whitelist disables the whitelist functionality allowing anyone to join.
| No
|}

== Scripting and cheat commands ==
{| class="wikitable"
|-
! Command
! Description
|-
| /cheat <all>
| Researches all technologies and enables cheat mode. Using the '''all''' option also gives the player some additional items.
|-
| /command <command>
| Executes a Lua command.
|-
| /c <command>
| Executes a Lua command.
|-
| /editor
| Toggles the map editor.
|-
| /measured-command <command>
| Executes a Lua command and measures time it took.
|-
| /silent-command <command>
| Executes a Lua command without printing it to the console.
|}

This is a very powerful feature, which also allows cheating, and as such achievements will be permanently disabled for the save as soon as you use a script command.

== Basic example scripts ==

=== Use it as calculator ===
<syntaxhighlight lang="lua">
/c game.player.print(1234*5678)
</syntaxhighlight>

=== Zoom beyond normal bounds ===
Note that zooming too far out can cause performance hits. Be careful.
<syntaxhighlight lang="lua">
/c game.player.zoom=0.1
</syntaxhighlight>

=== Mine faster ===
<syntaxhighlight lang="lua">
/c game.player.force.manual_mining_speed_modifier=1000
</syntaxhighlight>

=== Craft faster ===
<syntaxhighlight lang="lua">
/c game.player.force.manual_crafting_speed_modifier=1000
</syntaxhighlight>

=== Unlock and research all technologies ===
<syntaxhighlight lang="lua">
/c game.player.force.research_all_technologies()
</syntaxhighlight>

Undo this with the command in the next section.

=== Unresearch all technologies ===
This does not reset manually applied bonuses
<syntaxhighlight lang="lua">
/c for _, tech in pairs(game.player.force.technologies) do
tech.researched=false
game.player.force.set_saved_technology_progress(tech, 0)
end
</syntaxhighlight>

=== Reset your force ===
This resets all data for your force, including kill and production statistics, technologies, bonuses and charting status.
<syntaxhighlight lang="lua">
/c game.player.force.reset()
</syntaxhighlight>

=== Always show rail block visualization ===
Permanently show the rail block visualization instead of only when holding a rail signal. Disable by replacing true with false.

<syntaxhighlight lang="lua">
/c game.player.game_view_settings.show_rail_block_visualisation = true
</syntaxhighlight>

== Inventory manipulation scripts ==

=== Cheat mode ===
Allows for infinite free crafting. Disable by replacing true with false.
<syntaxhighlight lang="lua">
/c game.player.cheat_mode=true
</syntaxhighlight>

=== Refill resources (refill oil, iron etc.) ===
While holding the cursor over a resource tile in-game
<syntaxhighlight lang="lua">
/c game.player.selected.amount=7500
</syntaxhighlight>

Alternatively you can refill all resources in the map with the following command. Change ore.amount to the desired value.
<syntaxhighlight lang="lua">
/c surface = game.player.surface
for _, ore in pairs(surface.find_entities_filtered({type="resource"})) do
ore.amount = 10000
end
</syntaxhighlight>

=== Add items to the player's inventory ===
Replace iron-plate with the [[data.raw|internal name]] of the item desired.
<syntaxhighlight lang="lua">
/c game.player.insert{name="iron-plate", count=100}
</syntaxhighlight>

For instance, here's a stack of the god-mode energy system interface:
<syntaxhighlight lang="lua">
/c game.player.insert{name="electric-energy-interface"}
</syntaxhighlight>

Add a powerful armor with equipment and some tools for construction:
<syntaxhighlight lang="lua">
/c local player = game.player
player.insert{name="power-armor-mk2", count = 1}
local p_armor = player.get_inventory(5)[1].grid
p_armor.put({name = "fusion-reactor-equipment"})
p_armor.put({name = "fusion-reactor-equipment"})
p_armor.put({name = "fusion-reactor-equipment"})
p_armor.put({name = "exoskeleton-equipment"})
p_armor.put({name = "exoskeleton-equipment"})
p_armor.put({name = "exoskeleton-equipment"})
p_armor.put({name = "exoskeleton-equipment"})
p_armor.put({name = "energy-shield-mk2-equipment"})
p_armor.put({name = "energy-shield-mk2-equipment"})
p_armor.put({name = "personal-roboport-mk2-equipment"})
p_armor.put({name = "night-vision-equipment"})
p_armor.put({name = "battery-mk2-equipment"})
p_armor.put({name = "battery-mk2-equipment"})
player.insert{name="construction-robot", count = 25}
</syntaxhighlight>

== World manipulation scripts ==

=== Reveal the map around the player ===

Reveals the map around the player, similar to a [[radar]].
<syntaxhighlight lang="lua">
/c local radius=150
game.player.force.chart(game.player.surface, {{game.player.position.x-radius, game.player.position.y-radius}, {game.player.position.x+radius, game.player.position.y+radius}})
</syntaxhighlight>
or from start position
<syntaxhighlight lang="lua">
/c local radius=150
game.player.force.chart(game.player.surface, {{x = -radius, y = -radius}, {x = radius, y = radius}})
</syntaxhighlight>
Change 150 to the desired radius, higher values take longer.

=== Hide revealed map ===

Hides all revealed chunks, inverted map revealing.
<syntaxhighlight lang="lua">
/c local surface = game.player.surface
local force = game.player.force
for chunk in surface.get_chunks() do
force.unchart_chunk({x = chunk.x, y = chunk.y}, surface)
end
</syntaxhighlight>

=== Delete chunks ===
If much of the map is revealed, it increases the size of the save file. The following command cancels the generation of all chunks that are currently queued for generation and removes chunks outside a 32 chunks radius around 0,0. Note that this will remove player entities if there are any on these chunks.
<syntaxhighlight lang="lua">
/c local surface = game.player.surface;
game.player.force.cancel_charting(surface);
local chunk_radius = 32;
for chunk in surface.get_chunks() do
if (chunk.x < -chunk_radius or chunk.x > chunk_radius or chunk.y < -chunk_radius or chunk.y > chunk_radius) then
surface.delete_chunk(chunk)
end
end
</syntaxhighlight>

=== Turn off night ===
Enables eternal day.
<syntaxhighlight lang="lua">
/c game.player.surface.always_day=true
</syntaxhighlight>

=== Change game speed ===
0.5 is half speed, 1 is default, 2 is double speed, etc. Minimum is 0.01. This can be used for a lot of things like when you know you will have to wait for long periods of time for something to complete. Increasing will decrease performance, be careful.
<syntaxhighlight lang="lua">
/c game.speed=X
</syntaxhighlight>

=== Expensive (marathon) or normal mode ===
To change from normal to expensive mode preset (this changes the research cost and intermediate product cost):
<syntaxhighlight lang="lua">
/c game.difficulty_settings.recipe_difficulty=1
game.difficulty_settings.technology_difficulty=1
game.difficulty_settings.technology_price_multiplier=4
</syntaxhighlight>

To change back to normal:
<syntaxhighlight lang="lua">
/c game.difficulty_settings.recipe_difficulty=0
game.difficulty_settings.technology_difficulty=0
game.difficulty_settings.technology_price_multiplier=1
</syntaxhighlight>

=== Freeze time ===
Stops the advancement of the time if you replace "BOOL" with "true" or unfreezes it if you replace it with "false".
<syntaxhighlight lang="lua">
/c game.player.surface.freeze_daytime=BOOL
</syntaxhighlight>

=== Remove all pollution ===
<syntaxhighlight lang="lua">
/c game.player.surface.clear_pollution()
</syntaxhighlight>

=== Completely turn off pollution ===

<syntaxhighlight lang="lua">
/c for _, surface in pairs(game.surfaces) do
surface.clear_pollution()
end
game.map_settings.pollution.enabled = false
</syntaxhighlight>

=== Add a lot of pollution ===
<syntaxhighlight lang="lua">
/c game.player.surface.pollute(game.player.position, 1000000)
</syntaxhighlight>

=== Where speakers are, by who ===
<syntaxhighlight lang="lua">
/c speakers = game.player.surface.find_entities_filtered{force = game.player.force, type="programmable-speaker"}
for key, speaker in pairs(speakers) do
game.player.print(speaker.last_user.name .. " placed a speaker at X=" .. speaker.position.x .. ", Y=" .. speaker.position.y)
end
</syntaxhighlight>

=== Disable friendly fire for your force ===
<syntaxhighlight lang="lua">
/c game.player.force.friendly_fire = false
</syntaxhighlight>

=== Add new resource patch ===
This creates a new 11×11 patch of resources, centered on the player character, where the ground is not water.
The patch it creates is perfectly square but it randomizes the amount similar to natural generation, with fewer ore at the edges and more ore in the center.
The default numbers result in a patch with 2500-3000 ore.

If you want a larger patch, change "local size = 5" to a larger number.
A larger patch will have exponentially more ore.
Entering a number above 30 is not recommended.

If you want a richer patch, change "local density = 10" to a larger number.
Entering a very large number shouldn't hurt anything but you probably don't need to go above 100.

To choose which resource is spawned, change "stone" near the bottom to "iron-ore", "copper-ore", "coal", or "uranium-ore".

<syntaxhighlight lang="lua">
/c local surface=game.player.surface
local ore=nil
local size=5
local density=10
for y=-size, size do
for x=-size, size do
a=(size+1-math.abs(x))*10
b=(size+1-math.abs(y))*10
if a<b then
ore=math.random(a*density-a*(density-8), a*density+a*(density-8))
end
if b<a then
ore=math.random(b*density-b*(density-8), b*density+b*(density-8))
end
if surface.get_tile(game.player.position.x+x, game.player.position.y+y).collides_with("ground-tile") then
surface.create_entity({name="stone", amount=ore, position={game.player.position.x+x, game.player.position.y+y}})
end
end
end
</syntaxhighlight>

=== Remove resources around the player ===
Removes all resource patches from the ground in a 50 x 50 area around the player.

<syntaxhighlight lang="lua">
/c local surface=game.player.surface
local size=50
local pos=game.player.position

for _, e in pairs(surface.find_entities_filtered{area={{pos.x-size, pos.y-size},{pos.x+size, pos.y+size}}, type="resource"})
do e.destroy()
end
</syntaxhighlight>

=== Add new oil patch ===
This creates 9 crude oil patches in a 3×3 square.
<syntaxhighlight lang="lua">
/c for y=0,2 do
for x=0,2 do
game.player.surface.create_entity({name="crude-oil", amount=100000, position={game.player.position.x+x*7-7, game.player.position.y+y*7-7}})
end
end
</syntaxhighlight>

or randomly without any collision:
<syntaxhighlight lang="lua">
/c local position=nil
for i=1,9 do
position=game.player.surface.find_non_colliding_position("crude-oil", game.player.position, 0, i/2+1.5)
if position then
game.player.surface.create_entity({name="crude-oil", amount=100000, position=position})
end
end
</syntaxhighlight>

=== Create 10 fishes ===
This creates 10 fishes around of player. The player must be on the water edge.
<syntaxhighlight lang="lua">
/c local player = game.player
local surface = player.surface
for i = 1, 10 do
local position = surface.find_non_colliding_position('fish', player.position, 10, 1)
if not position then return end
surface.create_entity {name = 'fish', position = position}
end
</syntaxhighlight>

=== Count entities ===
Counts all entities whose name includes the string in local entity.
<syntaxhighlight lang="lua">
/c local entity="belt"
local surface=game.player.surface
local count=0
for key, ent in pairs(surface.find_entities_filtered({force=game.player.force})) do
if string.find(ent.name,entity) then
count=count+1
end
end
game.player.print(count)
</syntaxhighlight>

=== Emptying all pipes, underground pipes and pumps ===
Useful when pipes contain a fluid you dont want.
<syntaxhighlight lang="lua">
/c local surface = game.player.surface
local deleted=0
for key, entity in pairs(surface.find_entities_filtered({force=game.player.force})) do
if string.find(entity.name, "pipe") or
string.find(entity.name, "pump")
then
for i=1,#entity.fluidbox do
deleted = deleted + 1
entity.fluidbox[i] = nil;
end
end
end
game.player.print("Fluids removed from "..deleted .." entities")
</syntaxhighlight>

=== Turn off cliff generation ===
Sets size to "none". Only effective on chunks that are generated after using this command. Use [[#Remove all cliffs]] to delete existing cliffs.

<syntaxhighlight lang="lua">
/c local mgs = game.player.surface.map_gen_settings
mgs.cliff_settings.cliff_elevation_0 = 1024
game.player.surface.map_gen_settings = mgs</syntaxhighlight>

=== Remove all cliffs ===
Removes all cliffs existing cliffs from the world. Use [[#Turn off cliff generation]] to turn off cliff generation in new chunks.

<syntaxhighlight lang="lua">
/c for _, v in pairs(game.player.surface.find_entities_filtered{type="cliff"}) do
v.destroy()
end</syntaxhighlight>

=== Delete all decoratives ===
Delete the decoratives that can be found in the world.

<syntaxhighlight lang="lua">
/c local surface = game.player.surface
for c in surface.get_chunks() do
surface.destroy_decoratives({{c.x*32, c.y*32}, {c.x*32+32, c.y*32+32}})
end</syntaxhighlight>

=== Change map generation settings ===
This allows to change the map generation settings for new chunks; it does not alter already generated chunks. [[#Delete chunks|Deleted chunks]] are affected by the setting change because they are newly generated when they get explored again.

To change resource generation settings, replace "iron-ore" with the [[Data.raw#resource|resource]] that should be changed and replace "very-high" with the desired [https://lua-api.factorio.com/latest/Concepts.html#MapGenSize MapGenSize] in the following command. Replace "iron-ore" with "enemy-base" to change the enemy base generation settings.

<syntaxhighlight lang="lua">
/c local surface = game.player.surface
local resource = "iron-ore"
local autoplace = surface.map_gen_settings.autoplace_controls
autoplace[resource].size = "very-high"
autoplace[resource].frequency = "very-high"
autoplace[resource].richness = "very-high"
surface.map_gen_settings.autoplace_controls = autoplace</syntaxhighlight>

To change water generation settings, replace "very-high" with the desired [https://lua-api.factorio.com/latest/Concepts.html#MapGenSize MapGenSize] in the following command.

<syntaxhighlight lang="lua">
/c local surface = game.player.surface
local mgs = surface.map_gen_settings
mgs.water = "very-high" --[[ size]]
mgs.terrain_segmentation = "very-high" --[[ frequency]]
surface.map_gen_settings = mgs </syntaxhighlight>

== Enemy/evolution scripts ==

=== Set evolution factor ===
Ranges from 0 (new game) to 1.
<syntaxhighlight lang="lua">
/c game.forces["enemy"].evolution_factor=X
</syntaxhighlight>

=== Disable time-based evolution & increases pollution-based evolution ===
<syntaxhighlight lang="lua">
/c game.map_settings.enemy_evolution.time_factor=0
/c game.map_settings.enemy_evolution.pollution_factor=game.map_settings.enemy_evolution.pollution_factor*2
</syntaxhighlight>

The "2" at the end of the last command will double the default pollution factor. You can substitute another number to increase (or decrease) the pollution factor further.

=== Kill all biters on the "enemy" force ===
Note that this will kill only mobile units, spawners will not be killed.
<syntaxhighlight lang="lua">
/c game.forces["enemy"].kill_all_units()
</syntaxhighlight>

=== Kill all enemies ===
This will kill all biters, bases and worms. Anything that is an enemy will be completely destroyed. This only affects enemies in the explored world, so any unexplored parts of the map which still need to be generated will still have enemies. You can [[#Prevent biters being on newly generated chunks|prevent biters being on newly generated chunks]] if desired.
<syntaxhighlight lang="lua">
/c local surface=game.player.surface
for key, entity in pairs(surface.find_entities_filtered({force="enemy"})) do
entity.destroy()
end
</syntaxhighlight>

=== Kill all nearby enemies ===

This will kill all biters, bases and worms in a configurable radius. The default, 250 tiles, is about two zoomed-out screen widths on full HD. After destruction, it shows how many objects were destroyed.

<syntaxhighlight lang="lua">
/c local radius = 250
local surface=game.player.surface
local pp = game.player.position
local cnt = 0
for key, entity in pairs(surface.find_entities_filtered({force="enemy"})) do
if entity.position.x > pp.x - radius and entity.position.x < pp.x + radius
and entity.position.y > pp.y - radius and entity.position.y < pp.y + radius then
cnt = cnt+1
entity.destroy()
end
end
game.player.print(cnt)
</syntaxhighlight>

=== Enable/Disable peaceful mode ===
Enabling peaceful mode prevents biter attacks until provoked. Substitute true for false to disable. Already existing biters are not affected by this command so attacks could continue for a while after activating peaceful mode.
<syntaxhighlight lang="lua">
/c game.player.surface.peaceful_mode = true
</syntaxhighlight>

=== Enable/Disable biter expansion ===
Biter expansion allows biters to create new nests, it is enabled by default. Substitute true for false to disable.
<syntaxhighlight lang="lua">
/c game.map_settings.enemy_expansion.enabled = true
</syntaxhighlight>

=== Prevent biters being on newly generated chunks ===
On newly generated chunks no biters will be present, however all current biters will remain unaffected. Equivalent of setting the Enemy Base Size to None under the Terrain settings during map generation but achieved mid game by [[#Change map generation settings|changing map generation settings]].
<syntaxhighlight lang="lua">
/c local surface = game.player.surface
local mgs = surface.map_gen_settings
mgs.autoplace_controls["enemy-base"].size = "none"
surface.map_gen_settings = mgs
</syntaxhighlight>

== Player character scripts ==
Commands concerning the player directly.
=== Get player position ===
Prints coordinates of your current position.
<syntaxhighlight lang="lua">
/c game.player.print(game.player.position.x .. ", " .. game.player.position.y)
</syntaxhighlight>

=== Teleport player ===
Moves the player to the specified location. You should be able to teleport to a specific player if you obtain their coordinates via them executing the previous command and giving them to you.
<syntaxhighlight lang="lua">
/c game.player.teleport({X, Y})
</syntaxhighlight>

To teleport to the world's origin, use 0,0.

=== Enable god mode ===
God mode removes your player character allowing you to fly over obstacles and take no damage.

Disassociate your controls from the player:
<syntaxhighlight lang="lua">
/c game.player.character=nil
</syntaxhighlight>

Then, hover the mouse over the useless player and destroy it by typing:
<syntaxhighlight lang="lua">
/c game.player.selected.destroy()
</syntaxhighlight>

To undo, spawn a player character. This will spawn a new player at the spawn point of the world, and connect your controls to it.
<syntaxhighlight lang="lua">
/c game.player.create_character()
</syntaxhighlight>

=== Enable long reach ===
Enables long reach, which allows the player to build and interact with entities at a greater distance. The default reach is 10.
<syntaxhighlight lang="lua">
/c local reach = 10000
game.player.force.character_build_distance_bonus = reach
game.player.force.character_reach_distance_bonus = reach
</syntaxhighlight>

== Research scripts ==

=== Enable Research Queue ===
Enable the research queue for the players current team. Can be done after the game has started if it was forgotten during the map's setup.
<syntaxhighlight lang="lua">
/c game.player.force.research_queue_enabled = true
</syntaxhighlight>

=== Enable faster research ===
<syntaxhighlight lang="lua">
/c game.player.force.laboratory_speed_modifier=1
</syntaxhighlight>
1 is normal speed, 2 is double speed 3 is triple etc.

=== Research specific technologies ===
The internal technology names can be found in the infoboxes on their respective pages.
<syntaxhighlight lang="lua">
/c game.player.force.technologies['electric-energy-distribution-1'].researched=true
/c game.player.force.technologies['steel-processing'].researched=true
</syntaxhighlight>

=== Unresearch specific technologies ===
The internal technology names can be found in the infoboxes on their respective pages.
<syntaxhighlight lang="lua">
/c game.player.force.technologies['electric-energy-distribution-1'].researched=false; game.player.force.set_saved_technology_progress('electric-energy-distribution-1', 0)
/c game.player.force.technologies['steel-processing'].researched=false; game.player.force.set_saved_technology_progress('steel-processing', 0)
</syntaxhighlight>

=== Enabling specific recipes ===
The internal recipe/item names can be found in the infoboxes on their respective pages.
<syntaxhighlight lang="lua">
/c game.player.force.recipes["electric-energy-interface"].enabled=true
/c game.player.force.recipes["rocket-silo"].enabled=true
/c game.player.force.recipes.loader.enabled=true
/c game.player.force.recipes["fast-loader"].enabled = true
/c game.player.force.recipes["express-loader"].enabled = true
</syntaxhighlight>

=== Enable all recipes ===
<syntaxhighlight lang="lua">
/c for name, recipe in pairs(game.player.force.recipes) do recipe.enabled = true end
</syntaxhighlight>

== Command line parameters ==
'''As of Game Version 0.17.5'''

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.

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

{|
|'''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-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 PNGFILE
|Generate preview images of the map
|-
| --generate-tile-properties-csv CSVFILE
|Generate tile properties into a CSV file; can be used with --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 (default: 1000)
|-
| --benchmark-verbose FILE
|comma seperated list of timings to ouput 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: )
|-
| --output-perf-stats FILE
|path of file to which 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
|-
| --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
|-
| --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: 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 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.
|}

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

--map2scenario SAVE
Converts a save game to a User Scenario, allows saved game state to be loaded into map editor.
Assuming that save game name is "foo.zip", executing './factorio --map2scenario s1' will result in Factorio loading, opening the save file, and saving the scenario into the scenario folder.

== Modding tools ==
A list of the internal names of most things in the vanilla game can also be found on [[data.raw]].

=== Print to console which tile are you have under the player position ===
<syntaxhighlight lang="lua">
/c game.player.print(game.player.surface.get_tile(game.player.position.x, game.player.position.y).name)
</syntaxhighlight>

=== Write all researched technologies to file ===
<syntaxhighlight lang="lua">
/c local list = {}
for _, tech in pairs(game.player.force.technologies) do
if tech.researched then
list[#list+1] = tech.name
end
end
game.write_file("techs.lua", serpent.block(list) .. "\n", true)
</syntaxhighlight>

=== Write all enabled recipes to file ===
<syntaxhighlight lang="lua">
/c local list = {}
for _, recipe in pairs(game.player.force.recipes) do
if recipe.enabled then
list[#list+1] = recipe.name
end
end
game.write_file("recipes.lua", serpent.block(list) .. "\n", true)
</syntaxhighlight>

== See also ==

* http://lua-api.factorio.com/latest/ - Factorio API reference for latest version

Prototype/Sprite

2019-05-28T12:13:57Z

Lovely santa: Example didn't have type defined

== Basics ==
Prototype type: '''sprite'''

Specifies a picture that can be used with https://lua-api.factorio.com/latest/Concepts.html#SpritePath during runtime.
== Mandatory properties ==

=== type ===
'''Type''': [[Types/string]]

Must be "sprite".

=== name ===
'''Type''': [[Types/string]]

Name of the sprite. Must be unique. Used in https://lua-api.factorio.com/latest/Concepts.html#SpritePath.

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

'''Default''': ""

Technically optional, but path to sprite cannot be empty.

== Optional properties ==

=== layers ===
'''Type''': [[Types/table]] of [[Types/Sprite]]

If this property is present, all Sprite definitions have to be placed as entries in the array, and they will all be loaded from there. Each item (Sprite definition) in the array may also have the <code>layers</code> property.

If this property is present, all other properties are ignored and the mandatory properties do not have to be defined.

=== hr_version ===
'''Type''': [[Types/Sprite]]

If this property exists and high resolution sprites are turned on, its contents are used to load the sprite.

=== slice ===
'''Type''': [[Types/SpriteSizeType]]

Number of slices this is sliced into when using the "optimized atlas packing" option. If you are a modder, you can just ignore this property.

Example: If this is 4, the sprite will be sliced into a 4×4 grid.

=== slice_x ===
'''Type''': [[Types/SpriteSizeType]]

Same as <code>slice</code> above, but this specifies only how many slices there are on the x axis.

=== slice_y ===
'''Type''': [[Types/SpriteSizeType]]

Same as <code>slice</code> above, but this specifies only how many slices there are on the y axis.

=== priority ===
'''Type''': [[Types/string]]

'''Default''': "medium"

Possible values:
* "extra-high-no-scale"
* "extra-high"
* "high"
* "medium"
* "low"
* "very-low"

=== flags ===
'''Type''': [[Types/SpriteFlags]]

=== size ===
'''Type''': [[Types/SpriteSizeType]] or [[Types/table]] of [[Types/SpriteSizeType]]

The width and height of the sprite. If this is an array, the first member of the array is the width and the second is the height. Otherwise the size is both width and height.

Width and height may only be in the range of 0-8192.

=== width ===
'''Type''': [[Types/SpriteSizeType]]

Mandatory if <code>size</code> is not given. Width of the picture in pixels, from 0-8192.

=== height ===
'''Type''': [[Types/SpriteSizeType]]

Mandatory if <code>size</code> is not given. Height of the picture in pixels, from 0-8192.

=== x ===
'''Type''': [[Types/SpriteSizeType]]

'''Default''': 0

Horizontal position of the sprite in the source file in pixels.

=== y ===
'''Type''': [[Types/SpriteSizeType]]

'''Default''': 0

Vertical position of the sprite in the source file in pixels.

=== position ===
'''Type''': [[Types/table]] of [[Types/SpriteSizeType]]

Loaded only when <code>x</code> and <code>y</code> are both 0. The first member of the array is x and the second is y.

=== shift ===
'''Type''': [[Types/vector]]

'''Default''': {0, 0}

In tiles. util.by_pixel() can be used to divide the shift by 32 which is the usual pixel height/width of 1 tile in normal resolution. Note that 32 pixel tile height/width is not enforced anywhere - any other tile height or width is also possible.

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

'''Default''': 1

Values different than 1 specify the scale of the sprite on default zoom.
Scale 2 means that the picture will be 2 times bigger on screen (and more pixelated).

=== draw_as_shadow ===
'''Type''': [[Types/bool]]

'''Default''': false

=== apply_runtime_tint ===
'''Type''': [[Types/bool]]

'''Default''': false

=== tint ===
'''Type''': [[Types/Color]]

'''Default''': {r=1, g=1, b=1, a=1} (white)

=== blend_mode ===
'''Type''': [[Types/string]]

'''Default''': "normal"

Possible values:
* "normal"
* "additive"
* "additive-soft"
* "multiplicative"
* "overwrite"

=== load_in_minimal_mode ===
'''Type''': [[Types/bool]]

'''Default''': false

Minimal mode is entered when mod loading fails. You are in it when you see the gray box after (part of) the loading screen that tells you a mod error ([https://cdn.discordapp.com/attachments/340530709712076801/532315796626472972/unknown.png Example]). If you are a modder, you can just ignore this property.

=== premul_alpha ===
'''Type''': [[Types/bool]]

'''Default''': true

Whether alpha should be premultiplied.

=== generate_sdf ===
'''Type''': [[Types/bool]]

'''Default''': false

== Example ==
{
type = "sprite"
name = "accumulator-sprite",
filename = "__base__/graphics/entity/basic-accumulator/basic-accumulator.png",
priority = "extra-high",
width = 124,
height = 103,
shift = {0.7, -0.2}
}

Types/SpriteFlags

2019-05-23T12:30:49Z

Lovely santa: Updated SpriteFlags; Added new flags as game state v0.17.42; Updated layout and added example as is with Types/EntityPrototypeFlags

Array ([[Types/table]]) of strings. The possible strings are listed below.

== "none" ==
When no flags, or when an invalid flag (such as "compressed") is set.

== "no-crop" ==
The sprite won't be automatically cropped.

== "not-compressed" ==

== "always-compressed" ==

== "mipmap" ==

== "linear-minification" ==

== "linear-magnification" ==

== "linear-mip-level" ==

== "alpha-mask" ==

== "no-scale" ==

== "mask" ==

== "icon" ==
When this flag is set, it will automaticaly set these flags:
* "no-crop"
* "not-compressed"
* "mipmap"
* "linear-minification"
* "linear-magnification"
* "linear-mip-level"
* "no-scale"

== "light" ==

== "terrain" ==

== "shadow" ==

== "smoke" ==

== "decal" ==

== "low-object" ==

== "trilinear-filtering" ==

== Example ==
flags = {"icon", "no-crop"}