-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathgodot.cli-help.txt
More file actions
128 lines (120 loc) · 14.9 KB
/
godot.cli-help.txt
File metadata and controls
128 lines (120 loc) · 14.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
[38;5;39mGodot Engine[0m v4.6.stable.official.89cea1439 - [4mhttps://godotengine.org[0m
[90mFree and open source software under the terms of the MIT license.[0m
[90m(c) 2014-present Godot Engine contributors. (c) 2007-present Juan Linietsky, Ariel Manzur.[0m
[1;93mUsage:[0m
../../Engine/4.6_stable/Godot_v4.6-stable_linux.x86_64 [96m[options] [path to "project.godot" file][0m
[1;93mOption legend (this build = editor):[0m
[1;92mR[0m Available in editor builds, debug export templates and release export templates.
[1;94mD[0m Available in editor builds and debug export templates only.
[1;93mX[0m Only available in editor builds, and export templates compiled with `disable_path_overrides=false`.
[1;91mE[0m Only available in editor builds.
[1;93mGeneral options:[0m
[92m-h, --help [1;92mR[0m Display this help message.
[92m--version [1;92mR[0m Display the version string.
[92m-v, --verbose [1;92mR[0m Use verbose stdout mode.
[92m--quiet [1;92mR[0m Quiet mode, silences stdout messages. Errors are still displayed.
[92m--no-header [1;92mR[0m Do not print engine version and rendering driver/method header on startup.
[1;93mRun options:[0m
[92m--, ++ [1;92mR[0m Separator for user-provided arguments. Following arguments are not used by the engine, but can be read from `OS.get_cmdline_user_args()`.
[92m-e, --editor [1;91mE[0m Start the editor instead of running the scene.
[92m-p, --project-manager [1;91mE[0m Start the project manager, even if a project is auto-detected.
[92m--recovery-mode [1;91mE[0m Start the editor in recovery mode, which disables features that can typically cause startup crashes, such as tool scripts, editor plugins, GDExtension addons, and others.
[92m--debug-server [95m<uri>[0m [1;91mE[0m Start the editor debug server (<protocol>://<host/IP>[:port], e.g. tcp://127.0.0.1:6007)
[92m--dap-port [95m<port>[0m [1;91mE[0m Use the specified port for the GDScript Debug Adapter Protocol. Recommended port range [1024, 49151].
[92m--lsp-port [95m<port>[0m [1;91mE[0m Use the specified port for the GDScript Language Server Protocol. Recommended port range [1024, 49151].
[92m--quit [1;92mR[0m Quit after the first iteration.
[92m--quit-after [95m<int>[0m [1;92mR[0m Quit after the given number of iterations. Set to 0 to disable.
[92m-l, --language [95m<locale>[0m [1;92mR[0m Use a specific locale (<locale> being a two-letter code).
[92m--path [95m<directory>[0m [1;93mX[0m Path to a project (<directory> must contain a "project.godot" file).
[92m--scene [95m<path>[0m [1;93mX[0m Path or UID of a scene in the project that should be started.
[92m--main-pack [95m<file>[0m [1;93mX[0m Path to a pack (.pck) file to load.
[92m--render-thread [95m<mode>[0m [1;92mR[0m Render thread mode ("unsafe" [deprecated], "safe", "separate").
[92m--remote-fs [95m<address>[0m [1;94mD[0m Remote filesystem (<host/IP>[:<port>] address).
[92m--remote-fs-password [95m<password>[0m [1;94mD[0m Password for remote filesystem.
[92m--audio-driver [95m<driver>[0m [1;92mR[0m Audio driver ["PulseAudio", "ALSA", "Dummy"].
[92m--display-driver [95m<driver>[0m [1;92mR[0m Display driver (and rendering driver) ["x11" ("vulkan", "opengl3", "opengl3_es", "dummy"), "wayland" ("vulkan", "opengl3", "opengl3_es", "dummy"), "headless" ("dummy")].
[92m--audio-output-latency [95m<ms>[0m [1;92mR[0m Override audio output latency in milliseconds (default is 15 ms).
[92m [0m [90mLower values make sound playback more reactive but increase CPU usage, and may result in audio cracking if the CPU can't keep up.
[92m--rendering-method [95m<renderer>[0m [1;92mR[0m Renderer name. Requires driver support.
[92m--rendering-driver [95m<driver>[0m [1;92mR[0m Rendering driver (depends on display driver).
[92m--gpu-index [95m<device_index>[0m [1;92mR[0m Use a specific GPU (run with --verbose to get a list of available devices).
[92m--text-driver [95m<driver>[0m [1;92mR[0m Text driver (used for font rendering, bidirectional support and shaping).
[92m--tablet-driver [95m<driver>[0m [1;92mR[0m Pen tablet input driver.
[92m--headless [1;92mR[0m Enable headless mode (--display-driver headless --audio-driver Dummy). Useful for servers and with --script.
[92m--log-file [95m<file>[0m [1;92mR[0m Write output/error log to the specified path instead of the default location defined by the project.
[92m [0m [90m<file> path should be absolute or relative to the project directory.
[92m--write-movie [95m<file>[0m [1;92mR[0m Write a video to the specified path (usually with .avi or .png extension).
[92m [0m [90m--fixed-fps is forced when enabled, but it can be used to change movie FPS.
[92m [0m [90m--disable-vsync can speed up movie writing but makes interaction more difficult.
[92m [0m [90m--quit-after can be used to specify the number of frames to write.
[1;93mDisplay options:[0m
[92m-f, --fullscreen [1;92mR[0m Request fullscreen mode.
[92m-m, --maximized [1;92mR[0m Request a maximized window.
[92m-w, --windowed [1;92mR[0m Request windowed mode.
[92m-t, --always-on-top [1;92mR[0m Request an always-on-top window.
[92m--resolution [95m<W>[0mx[95m<H>[0m [1;92mR[0m Request window resolution.
[92m--position [95m<X>[0m,[95m<Y>[0m [1;92mR[0m Request window position.
[92m--screen [95m<N>[0m [1;92mR[0m Request window screen.
[92m--single-window [1;92mR[0m Use a single window (no separate subwindows).
[92m--xr-mode [95m<mode>[0m [1;92mR[0m Select XR (Extended Reality) mode ["default", "off", "on"].
[92m--wid [95m<window_id>[0m [1;92mR[0m Request parented to window.
[92m--accessibility [95m<mode>[0m [1;92mR[0m Select accessibility mode ['auto' (when screen reader is running, default), 'always', 'disabled'].
[1;93mDebug options:[0m
[92m-d, --debug [1;92mR[0m Debug (local stdout debugger).
[92m-b, --breakpoints [1;92mR[0m Breakpoint list as source::line comma-separated pairs, no spaces (use %%20 instead).
[92m--ignore-error-breaks [1;92mR[0m If debugger is connected, prevents sending error breakpoints.
[92m--profiling [1;92mR[0m Enable profiling in the script debugger.
[92m--gpu-profile [1;92mR[0m Show a GPU profile of the tasks that took the most time during frame rendering.
[92m--gpu-validation [1;92mR[0m Enable graphics API validation layers for debugging.
[92m--gpu-abort [1;94mD[0m Abort on graphics API usage errors (usually validation layer errors). May help see the problem if your system freezes.
[92m--generate-spirv-debug-info [1;92mR[0m Generate SPIR-V debug information (Vulkan only). This allows source-level shader debugging with RenderDoc.
[92m--extra-gpu-memory-tracking [1;92mR[0m Enables additional memory tracking (see class reference for `RenderingDevice.get_driver_and_device_memory_report()` and linked methods). Currently only implemented for Vulkan. Enabling this feature may cause crashes on some systems due to buggy drivers or bugs in the Vulkan Loader. See https://github.com/godotengine/godot/issues/95967
[92m--accurate-breadcrumbs [1;92mR[0m Force barriers between breadcrumbs. Useful for narrowing down a command causing GPU resets. Currently only implemented for Vulkan.
[92m--remote-debug [95m<uri>[0m [1;92mR[0m Remote debug (<protocol>://<host/IP>[:<port>], e.g. tcp://127.0.0.1:6007).
[92m--single-threaded-scene [1;92mR[0m Force scene tree to run in single-threaded mode. Sub-thread groups are disabled and run on the main thread.
[92m--debug-collisions [1;94mD[0m Show collision shapes when running the scene.
[92m--debug-paths [1;94mD[0m Show path lines when running the scene.
[92m--debug-navigation [1;94mD[0m Show navigation polygons when running the scene.
[92m--debug-avoidance [1;94mD[0m Show navigation avoidance debug visuals when running the scene.
[92m--debug-stringnames [1;94mD[0m Print all StringName allocations to stdout when the engine quits.
[92m--debug-canvas-item-redraw [1;94mD[0m Display a rectangle each time a canvas item requests a redraw (useful to troubleshoot low processor mode).
[92m--max-fps [95m<fps>[0m [1;92mR[0m Set a maximum number of frames per second rendered (can be used to limit power usage). A value of 0 results in unlimited framerate.
[92m--frame-delay [95m<ms>[0m [1;92mR[0m Simulate high CPU load (delay each frame by <ms> milliseconds). Do not use as a FPS limiter; use --max-fps instead.
[92m--time-scale [95m<scale>[0m [1;92mR[0m Force time scale (higher values are faster, 1.0 is normal speed).
[92m--disable-vsync [1;92mR[0m Forces disabling of vertical synchronization, even if enabled in the project settings. Does not override driver-level V-Sync enforcement.
[92m--disable-render-loop [1;92mR[0m Disable render loop so rendering only occurs when called explicitly from script.
[92m--disable-crash-handler [1;92mR[0m Disable crash handler when supported by the platform code.
[92m--fixed-fps [95m<fps>[0m [1;92mR[0m Force a fixed number of frames per second. This setting disables real-time synchronization.
[92m--delta-smoothing [95m<enable>[0m [1;92mR[0m Enable or disable frame delta smoothing ["enable", "disable"].
[92m--print-fps [1;92mR[0m Print the frames per second to the stdout.
[92m--editor-pseudolocalization [1;91mE[0m Enable pseudolocalization for the editor and the project manager.
[1;93mStandalone tools:[0m
[92m-s, --script [95m<script>[0m [1;93mX[0m Run a script.
[92m--main-loop [95m<main_loop_name>[0m [1;93mX[0m Run a MainLoop specified by its global class name.
[92m--check-only [1;93mX[0m Only parse for errors and quit (use with --script).
[92m--import [1;91mE[0m Starts the editor, waits for any resources to be imported, and then quits.
[92m--export-release [95m<preset>[0m [95m<path>[0m [1;91mE[0m Export the project in release mode using the given preset and output path. The preset name should match one defined in "export_presets.cfg".
[92m [0m [90m<path> should be absolute or relative to the project directory, and include the filename for the binary (e.g. "builds/game.exe").
[92m [0m [90mThe target directory must exist.
[92m--export-debug [95m<preset>[0m [95m<path>[0m [1;91mE[0m Export the project in debug mode using the given preset and output path. See --export-release description for other considerations.
[92m--export-pack [95m<preset>[0m [95m<path>[0m [1;91mE[0m Export the project data only using the given preset and output path. The <path> extension determines whether it will be in PCK or ZIP format.
[92m--export-patch [95m<preset>[0m [95m<path>[0m [1;91mE[0m Export pack with changed files only. See --export-pack description for other considerations.
[92m--patches [95m<paths>[0m [1;91mE[0m List of patches to use with --export-patch. The list is comma-separated.
[92m--install-android-build-template [1;91mE[0m Install the Android build template. Used in conjunction with --export-release or --export-debug.
[92m--convert-3to4 [0m
[92m [96m[max_file_kb][0m [96m[max_line_size][0m [1;91mE[0m Converts project from Godot 3.x to Godot 4.x.
[92m--validate-conversion-3to4 [0m
[92m [96m[max_file_kb][0m [96m[max_line_size][0m [1;91mE[0m Shows what elements will be renamed when converting project from Godot 3.x to Godot 4.x.
[92m--doctool [96m[path][0m [1;91mE[0m Dump the engine API reference to the given <path> (defaults to current directory) in XML format, merging if existing files are found.
[92m--no-docbase [1;91mE[0m Disallow dumping the base types (used with --doctool).
[92m--gdextension-docs [1;91mE[0m Rather than dumping the engine API, generate API reference from all the GDExtensions loaded in the current project (used with --doctool).
[92m--gdscript-docs [95m<path>[0m [1;91mE[0m Rather than dumping the engine API, generate API reference from the inline documentation in the GDScript files found in <path> (used with --doctool).
[92m--build-solutions [1;91mE[0m Build the scripting solutions (e.g. for C# projects). Implies --editor and requires a valid project to edit.
[92m--dump-gdextension-interface [1;91mE[0m Generate a GDExtension header file "gdextension_interface.h" in the current folder. This file is the base file required to implement a GDExtension.
[92m--dump-gdextension-interface-json [1;91mE[0m Generate a JSON dump of the GDExtension interface named "gdextension_interface.json" in the current folder.
[92m--dump-extension-api [1;91mE[0m Generate a JSON dump of the Godot API for GDExtension bindings named "extension_api.json" in the current folder.
[92m--dump-extension-api-with-docs [1;91mE[0m Generate JSON dump of the Godot API like the previous option, but including documentation.
[92m--validate-extension-api [95m<path>[0m [1;91mE[0m Validate an extension API file dumped (with one of the two previous options) from a previous version of the engine to ensure API compatibility.
[92m [0m [90mIf incompatibilities or errors are detected, the exit code will be non-zero.
[92m--benchmark [1;91mE[0m Benchmark the run time and print it to console.
[92m--benchmark-file [95m<path>[0m [1;91mE[0m Benchmark the run time and save it to a given file in JSON format. The path should be absolute.