In other languages: Deutsch 日本語 한국어 Русский 中文

Console: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(→‎See also: Changed main link to latest, added new link to list of versions)
(Refactored opening sections of page to detail different uses of console)
Line 1: Line 1:
{{Languages}}
{{Languages}}


<span style="color:#FF0000">NOTE: Many of the below commands will likely only work in version 0.13, and will disable Achievements for the world they are used in. Use with caution. </span>
== Overview ==
The in-game console is used for:


== Console Overview ==
* chatting with other players
The Factorio console is the built in interface for executing Lua commands within Factorio. It works similarly to any command line interface or the JavaScript console for your browser.
* running commands / scripts / cheats
* occasional status updates


You can essentially fire any Lua command here, just as you would from a Lua program - Factorio [[Mods]] are merely Lua commands. Therefore you don't necessarily need "cheats" active per-se, as the console allows you full access to the game's internals. You only need a familiarity with the commands and types, as shown in the below examples and the [[Modding]] section.
There are three types of command:
 
* '''Multiplayer''' - message filtering, banning users, etc.
* '''Information''' - display various information about the game
* '''Scripting/Cheating''' - run small Lua scripts (but they <span style="color:#FF0000">disable achievements for the save game</span>)
 
=== Using the console ===
The console display can be toggled with the '''/''' (slash) or '''~''' (tilde) keys.
 
You can customise 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.
 
When console is closed, only the most recent messages/commands will be displayed, but they will gradually fade away (opening the console will immediately redisplay all recent messages).
 
You can set the fade out time via '''Options Menu -> Other Settings -> Message Delay'''.
 
If you want to immediately hide everything on 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.
 
=== 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 '''up arrow''' and '''down arrow''' keys to scroll through the console history.
 
Use the '''left arrow''' and '''right arrow''' keys to cursor through the currently displayed message or command, which you can edit (delete, insert, etc.) and resend (by pressing '''Return''').
 
 
== Multiplayer Chat ==
 
Send private message to specific player with '''/whisper''' (or '''/w'''):
 
/whisper <playerId> <message>
 
Reply to the most recently received private message with '''/reply''' (or '''/r'''):
 
/reply <message>
 
In [https://forums.factorio.com/viewtopic.php?f=3&t=32248 Factorio 0.14.4 and later], group chat works like this:
 
hello my team!
 
/s hello all players!
/shout same as /s
 
In Factorio 0.14.3 and earlier, group chat worked like this:
 
hello all players!
 
/team hello my team!
 
 
== Commands ==
To see a list of all available commands, enter '''/help''' (or '''/h''') in to the console. The available commands will depend on Factorio version and game setup.
 
/help
 
In [https://forums.factorio.com/viewtopic.php?f=3&t=32248 Factorio 0.14.4 and later], the '''/help''' command will just display a list of commands on - to get full details for a command add the command name (without slash) after '''/help''' (or '''/h'''), for example if you want help on the '''/evolution''' command, you'd type:
 
/h evolution
 
=== Scripting and cheat commands ===
You can run Lua script commands via the console. It works similarly to any command line interface or the JavaScript console for your browser.
 
This is a very powerful feature, which also allows cheating, and as such <span style="color:#FF0000">achievements will be permanently disabled for the save</span> as soon as you use a script command.
 
To run a script, prefix it with '''/command''' (or '''/c'''), for example:
 
/c game.player.print 'hello me!'
 
If you're in a multiplayer game, the command will be echoed to all other players (so they can see if you're cheating).
 
In [https://forums.factorio.com/viewtopic.php?p=203991#p203991 Factorio 0.14.5 and later], multiplayer server admins can use '''/silent-command''' (only via RCON/server console) instead of '''/c''' to avoid the command being echoed to all players.


== Using the console ==
/silent-command game.player.print 'only admins can use (and see) silent commands'
=== Opening the console ===
With default key bindings, the console is opened with the ''' '/' or '~'''' keys. Like most others, this key binding may be customized within the Options Menu->Keyboard>"Toggle Lua console".


=== Inputting commands ===
Mod developers can also take advantage of the special '''/measured-command''' which is like '''/c''' but will time how long the command takes to run. This is very useful for performance tuning your scripts.


The console is also the chat window in multiplayer. You need to type '/c' in front of your commands, otherwise it will be sent as a chat message. The console has an inbuilt history. You can use the "cursor-up"-key to repeat or quickly edit and re-issue previous commands.
/measured-command game.player.print 'how much time does this take to run?'


The game ignores newlines when pasting "scriptlets" in the console. This means they can be written in a human readable form in an editor and copy/pasted into the console, making understanding and editing a bit easier.
The game ignores newlines when pasting "scriptlets" in the console. This means they can be written in a human readable form in an editor and copy/pasted into the console, making understanding and editing a bit easier.


Note: As of [https://forums.factorio.com/viewtopic.php?p=203991#p203991 Factorio 0.14.5], multiplayer server admins can use `/silent-command' (only via RCON/server console) instead of '/c', to avoid the command being echoed to all players' consoles.
You can essentially fire any Lua command here, just as you would from a Lua program - Factorio [[Mods]] are merely Lua commands. Therefore you don't necessarily need "cheats" active per-se, as the console allows you full access to the game's internals. You only need a familiarity with the commands and types, as shown in the below examples and the [[Modding]] section.
 
 
==Basic Command Examples==


=== Use it as calculator ===
=== Use it as calculator ===
Line 25: Line 100:


=== Mine faster ===
=== Mine faster ===
  /c game.player.force.manual_mining_speed_modifier=1000
  /c game.player.force.manual_mining_speed_modifier=1000


=== Craft faster ===
=== Craft faster ===
  /c game.player.force.manual_crafting_speed_modifier=1000
  /c game.player.force.manual_crafting_speed_modifier=1000


Line 47: Line 124:


  /c game.player.zoom = 0.1
  /c game.player.zoom = 0.1


== Inventory Manipulation ==
== Inventory Manipulation ==
=== Refill resources (refill oil, iron etc.) ===
=== Refill resources (refill oil, iron etc.) ===
While holding the cursor over a resource tile in-game
While holding the cursor over a resource tile in-game
Line 62: Line 141:


  /c game.player.cheat_mode=true
  /c game.player.cheat_mode=true


== World Manipulation ==
== World Manipulation ==
=== Turn off night ===
=== Turn off night ===
Enables eternal day.
Enables eternal day.
Line 87: Line 168:
   end
   end
  end
  end


== Enemy/Evolution ==
== Enemy/Evolution ==
Line 117: Line 199:
     end
     end
   end
   end


=== Enable peaceful mode ===
=== Enable peaceful mode ===
Peaceful mode prevents biter attacks until provoked. Substitute false for true to disable.
Peaceful mode prevents biter attacks until provoked. Substitute false for true to disable.
  /c game.player.surface.peaceful_mode = true
  /c game.player.surface.peaceful_mode = true


== Player Character ==
== Player Character ==

Revision as of 15:17, 8 September 2016


Overview

The in-game console is used for:

  • chatting with other players
  • running commands / scripts / cheats
  • occasional status updates

There are three types of command:

  • Multiplayer - message filtering, banning users, etc.
  • Information - display various information about the game
  • 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 / (slash) or ~ (tilde) keys.

You can customise 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.

When console is closed, only the most recent messages/commands will be displayed, but they will gradually fade away (opening the console will immediately redisplay all recent messages).

You can set the fade out time via Options Menu -> Other Settings -> Message Delay.

If you want to immediately hide everything on 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.

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 up arrow and down arrow keys to scroll through the console history.

Use the left arrow and right arrow keys to cursor through the currently displayed message or command, which you can edit (delete, insert, etc.) and resend (by pressing Return).


Multiplayer Chat

Send private message to specific player with /whisper (or /w):

/whisper <playerId> <message>

Reply to the most recently received private message with /reply (or /r):

/reply <message>

In Factorio 0.14.4 and later, group chat works like this:

hello my team!
/s hello all players!
/shout same as /s

In Factorio 0.14.3 and earlier, group chat worked like this:

hello all players!
/team hello my team!


Commands

To see a list of all available commands, enter /help (or /h) in to the console. The available commands will depend on Factorio version and game setup.

/help

In Factorio 0.14.4 and later, the /help command will just display a list of commands on - to get full details for a command add the command name (without slash) after /help (or /h), for example if you want help on the /evolution command, you'd type:

/h evolution

Scripting and cheat commands

You can run Lua script commands via the console. It works similarly to any command line interface or the JavaScript console for your browser.

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.

To run a script, prefix it with /command (or /c), for example:

/c game.player.print 'hello me!'

If you're in a multiplayer game, the command will be echoed to all other players (so they can see if you're cheating).

In Factorio 0.14.5 and later, multiplayer server admins can use /silent-command (only via RCON/server console) instead of /c to avoid the command being echoed to all players.

/silent-command game.player.print 'only admins can use (and see) silent commands'

Mod developers can also take advantage of the special /measured-command which is like /c but will time how long the command takes to run. This is very useful for performance tuning your scripts.

/measured-command game.player.print 'how much time does this take to run?'

The game ignores newlines when pasting "scriptlets" in the console. This means they can be written in a human readable form in an editor and copy/pasted into the console, making understanding and editing a bit easier.

You can essentially fire any Lua command here, just as you would from a Lua program - Factorio Mods are merely Lua commands. Therefore you don't necessarily need "cheats" active per-se, as the console allows you full access to the game's internals. You only need a familiarity with the commands and types, as shown in the below examples and the Modding section.


Basic Command Examples

Use it as calculator

/c game.player.print(1234 * 5678)

Mine faster

/c game.player.force.manual_mining_speed_modifier=1000

Craft faster

/c game.player.force.manual_crafting_speed_modifier=1000

Unlock and Research all Technology

/c game.player.force.research_all_technologies()

Undo this with:

for _, tech in pairs(game.player.force.technologies) do tech.researched=false end

Reset any modifiers to default

This includes Tech and speed alterations.

/c game.player.force.reset()

Zoom beyond normal bounds

Note that zooming too far out can cause performance hits. Be careful.

/c game.player.zoom = 0.1


Inventory Manipulation

Refill resources (refill oil, iron etc.)

While holding the cursor over a resource tile in-game

/c game.player.selected.amount=7500

Add items to the player's inventory

Replace iron-plate with the internal name of the item desired.

/c game.player.insert{name="iron-plate", count=100}

Cheat mode

Allows for infinite free crafting. Disable by replacing true with false.

/c game.player.cheat_mode=true


World Manipulation

Turn off night

Enables eternal day.

/c game.surfaces[1].always_day=true

Change Game Speed

0.5 is half speed, 1 is default, 2 is double speed, etc. 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.

/c game.speed = X

Freeze Time Passage

Stops the advancement of the time if true is passed, or unfreezes it if false is passed.

/c game.player.surface.freeze_daytime(BOOL)

Add new resource patch

This creates a new 5x5 patch of resources, centered on the player character. For resources other than stone, just change "stone" to "iron-ore", "copper-ore", or "coal"

/c local surface = game.player.surface;
for y=-2,2 do
 for x=-2,2 do
  surface.create_entity({name="stone", amount=5000, position={game.player.position.x+x, game.player.position.y+y}})
 end
end


Enemy/Evolution

Check how far the biters have evolved

Note that commands that do not start with "/c" do not disable achievements.

/evolution

Set evolution factor

Ranges from 0 (new game) to 1.

/c game.evolution_factor=X

Disable time-based evolution & increases pollution-based evolution

/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

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 and worms, spawners will not be killed.

/c game.forces["enemy"].kill_all_units()

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.

/c local surface = game.player.surface
for c in surface.get_chunks() do
   for key, entity in pairs(surface.find_entities_filtered({area={{c.x * 32, c.y * 32}, {c.x * 32 + 32, c.y * 32 + 32}}, force= "enemy"})) do
       entity.destroy()
   end
 end

Enable peaceful mode

Peaceful mode prevents biter attacks until provoked. Substitute false for true to disable.

/c game.player.surface.peaceful_mode = true


Player Character

Commands concerning the player directly.

Get Player Position

Prints coordinates of your current position.

/c game.player.print({"", "(", game.player.position.x, ", ", game.player.position.y, ")"})

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.

/c game.player.teleport({X, Y})

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

Spawn a player character

This is useful for escaping god mode. (see Console#Enable_god_mode.) This will spawn a new player at the spawn point of the world, and connect your controls to it.

/c game.player.character = game.player.surface.create_entity{name="player", position = {0,0}, force = game.forces.player}

Change Player color

Note that commands that do not start with "/c" do not disable achievements. Replace COLOR with the name of a color.

/color COLOR

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:

/c game.player.character = nil

Then, hover the mouse over the useless player and destroy it by typing:

/c game.player.selected.destroy()


Research

Enable faster research

/c game.player.force.laboratory_speed_modifier = 1

1 is normal speed, 2 is double speed 3 is triple etc. I think it goes up to 100.

Enabling specific technologies

Enabling technologies (forums)

/c game.player.force.technologies['electric-energy-distribution-1'].researched=true
/c game.player.force.technologies['steel-processing'].researched=true

Finish research immediately

/c for name,technology in pairs(game.player.force.technologies) do technology.researched=technology.enabled end

Large Screenshots

And finally, this is how you would take a large HD screenshot. As usual, replace the X and Y with the values you wish.

The file is put into a folder called "script-output", which is located in the same location as the mods folder. These pictures can be quite large.

/c game.take_screenshot{resolution = {x = XPOS, y = YPOS}}

or

/c game.take_screenshot{showgui = true, resolution = {x = XPOS, y = YPOS}}


See also