Command line parameters - Revision history

Osmo: Add --enable-lua-udp

2026-04-24T03:41:35Z

Add --enable-lua-udp

← Older revision		Revision as of 03:41, 24 April 2026
Line 122:		Line 122:
	\|		\|
	\| Enables unsafe functions in the Lua debug library.		\| Enables unsafe functions in the Lua debug library.
			\|-
			\| --enable-lua-udp
			\| arg
			\| Set local port and enable [https://lua-api.factorio.com/latest/classes/LuaHelpers.html#send_udp helpers.send_udp()] and and [https://lua-api.factorio.com/latest/classes/LuaHelpers.html#recv_udp helpers.recv_udp()]
	\|-		\|-
	\| --host		\| --host

SpeckledFleebeedoo: Add more detail to --sync-mods

2025-06-21T19:11:19Z

Add more detail to --sync-mods

← Older revision		Revision as of 19:11, 21 June 2025
Line 117:		Line 117:
	\| --sync-mods		\| --sync-mods
	\| FILE		\| FILE
	\| Sync mods with save. Note for headless servers: requires <code>service-username</code> and <code>service-token</code> to be set in the player-data.json file.		\| Sync mods with save. Note for headless servers: requires <code>service-username</code> and <code>service-token</code> to be set in the player-data.json file if any mods need to be downloaded.
	\|-		\|-
	\| --enable-unsafe-lua-debug-api		\| --enable-unsafe-lua-debug-api

Bilka: return BOOL, OS specific options

2025-04-18T17:13:49Z

return BOOL, OS specific options

← Older revision		Revision as of 17:13, 18 April 2025
Line 161:		Line 161:
	\| --benchmark-verbose		\| --benchmark-verbose
	\| timings		\| timings
	\| comma separated list of timings to output each tick. "all", "timestamp" as well as all other values seen in the debug view are allowed here. An empty string disabled verbose benchmarking.		\| 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		\| --benchmark-sanitize
Line 226:		Line 226:
	\| FILE		\| FILE
	\| load save and benchmark graphics rendering of single frame (prepare + render) without updating the game		\| load save and benchmark graphics rendering of single frame (prepare + render) without updating the game
			\|-
			\| --force-opengl
			\|
			\|use OpenGL for rendering (windows, mac only)
			\|-
			\| --force-d3d
			\|
			\|use Direct3D for rendering (windows only)
			\|-
			\| --d3d-adapter
			\| ID
			\|adapter which should be used to initialized Direct3D (windows only)
			\|-
			\| --d3d-feature-level
			\|
			\|override feature level (11, 10.1, 10) (windows only)
			\|-
			\| --dxgi-blit-model
			\|
			\|force Blit presentation mode (windows only)
			\|-
			\| --force-metal
			\|
			\|use Metal for rendering (mac only)
	\|-		\|-
	\| --debug-graphics		\| --debug-graphics
Line 232:		Line 256:
	\|-		\|-
	\| --fullscreen		\| --fullscreen
	\|		\| BOOL
	\| start game in windowed mode (saved to configuration)		\| start game in windowed mode (saved to configuration)
	\|-		\|-
Line 276:		Line 300:
	\|-		\|-
	\| --cache-sprite-atlas		\| --cache-sprite-atlas
	\|		\| BOOL
	\| Enable/disable sprite atlas cache.		\| Enable/disable sprite atlas cache.
	\|-		\|-
Line 313:		Line 337:
	\|-		\|-
	\| --use-server-whitelist		\| --use-server-whitelist
	\|		\| BOOL
	\| If the whitelist should be used.		\| If the whitelist should be used.
	\|-		\|-

SpeckledFleebeedoo: Add better explanation to --sync-mods

2025-01-25T12:45:30Z

Add better explanation to --sync-mods

← Older revision		Revision as of 12:45, 25 January 2025
Line 117:		Line 117:
	\| --sync-mods		\| --sync-mods
	\| FILE		\| FILE
	\| Sync mods with save		\| Sync mods with save. Note for headless servers: requires <code>service-username</code> and <code>service-token</code> to be set in the player-data.json file.
	\|-		\|-
	\| --enable-unsafe-lua-debug-api		\| --enable-unsafe-lua-debug-api

SpeckledFleebeedoo: Bring back add-on notes for some entries

2025-01-25T12:39:35Z

Bring back add-on notes for some entries

← Older revision		Revision as of 12:39, 25 January 2025
Line 32:		Line 32:
	\| --check-unused-prototype-data		\| --check-unused-prototype-data
	\|		\|
	\| Print a warning for all prototype values that were not accessed.		\| 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		\| --executable-path
Line 61:		Line 61:
	\| --map-gen-settings		\| --map-gen-settings
	\| FILE		\| FILE
	\| Map generation settings for use with --create, --start-server-load-scenario or --generate-map-preview. See data/map-gen-settings.example.json		\| Map generation settings for use with <code>--create</code>, <code>--start-server-load-scenario</code> or <code>--generate-map-preview</code>. See data/map-gen-settings.example.json
	\|-		\|-
	\| --map-gen-seed		\| --map-gen-seed
Line 113:		Line 113:
	\| --instrument-mod		\| --instrument-mod
	\| arg		\| arg
	\| Name of a mod to enable Instrument Mode		\| Name of a mod to enable [https://lua-api.factorio.com/latest/auxiliary/instrument.html Instrument Mode]
	\|-		\|-
	\| --sync-mods		\| --sync-mods
Line 153:		Line 153:
	\| --benchmark-ticks		\| --benchmark-ticks
	\| N		\| N
	\| number of ticks for benchmarking. Default is 1000 ~~(default: 1000)~~		\| number of ticks for benchmarking. Default is 1000
	\|-		\|-
	\| --benchmark-runs		\| --benchmark-runs
	\| N		\| N
	\| how often the number of ticks will be run, map will reload after each run. Default is 1 ~~(default: 1)~~		\| how often the number of ticks will be run, map will reload after each run. Default is 1
	\|-		\|-
	\| --benchmark-verbose		\| --benchmark-verbose
	\| timings		\| timings
	\| comma separated list of timings to output each tick. "all", "timestamp" as well as all other values seen in the debug view are allowed here. An empty string disabled verbose benchmarking. ~~(default: )~~		\| comma separated list of timings to output each tick. "all", "timestamp" as well as all other values seen in the debug view are allowed here. An empty string disabled verbose benchmarking.
	\|-		\|-
	\| --benchmark-sanitize		\| --benchmark-sanitize
Line 209:		Line 209:
	\| --heavy		\| --heavy
	\|		\|
	\| run the game in heavy mode if singleplayer with graphics		\| 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		\| --load-game

SpeckledFleebeedoo: Update list of parameters to match Factorio 2.0.32

2025-01-25T12:32:02Z

Update list of parameters to match Factorio 2.0.32

Show changes

Bilka: Updated lua api doc links

2024-10-23T10:15:22Z

Updated lua api doc links

← Older revision		Revision as of 10:15, 23 October 2024
Line 124:		Line 124:
	\| --instrument-mod		\| --instrument-mod
	\|		\|
	\|Name of a mod to enable [https://lua-api.factorio.com/latest/~~Instrument~~.html Instrument Mode]		\|Name of a mod to enable [https://lua-api.factorio.com/latest/auxiliary/instrument.html Instrument Mode]
	\|-		\|-
	\| --start-server		\| --start-server
Line 414:		Line 414:
	</pre>		</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.		Note that this is the same format as [https://lua-api.factorio.com/latest/concepts/MapGenSettings.html MapGenSettings] that are modifiable from Lua. Everything in the file is optional.

	Creating a custom save:		Creating a custom save:

Bilka: helpers

2024-10-21T19:17:30Z

helpers

← Older revision		Revision as of 19:17, 21 October 2024
Line 430:		Line 430:
	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:		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>")))		/c helpers.write_file('map.txt', helpers.table_to_json(helpers.parse_map_exchange_string("<your exchange string here>")))

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

Nallaj: Separate arg type from arg name

2024-09-04T12:49:13Z

Separate arg type from arg name

Show changes

Majoca: Clarify the usage of boolean options

2024-08-25T16:32:39Z

Clarify the usage of boolean options

← Older revision		Revision as of 16:32, 25 August 2024
Line 263:		Line 263:
	\|Path where server ID will be stored or read from		\|Path where server ID will be stored or read from
	\|}		\|}

			=== Boolean options ===

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

			--fullscreen=false

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

	=== Multiplayer ===		=== Multiplayer ===