1GODOT(6) Games GODOT(6)
2
6 godot - multi-platform 2D and 3D game engine with a feature-rich editor
7
9 godot [options] [path to scene or 'project.godot' file]
10
12 Godot Engine is an advanced, feature-packed, multi-platform 2D and 3D
13 game engine.
14 It provides a huge set of common tools, so you can just focus on making
15 your game without reinventing the wheel.
16 General options:
18 -h, --help
19 Display this help message.
20 --version
22 Display the version string.
23 -v, --verbose
25 Use verbose stdout mode.
26 --quiet
28 Quiet mode, silences stdout messages. Errors are still dis‐
29 played.
30 Run options:
32 -e, --editor
33 Start the editor instead of running the scene.
34 -p, --project-manager
36 Start the project manager, even if a project is auto-detected.
37 -q, --quit
39 Quit after the first iteration.
40 -l, --language <locale>
42 Use a specific locale (<locale> being a two-letter code).
43 --path <directory>
45 Path to a project (<directory> must contain a 'project.godot'
46 file).
47 -u, --upwards
49 Scan folders upwards for project.godot file.
50 --main-pack <file>
52 Path to a pack (.pck) file to load.
53 --render-thread <mode>
55 Render thread mode ('unsafe', 'safe', 'separate').
56 --remote-fs <address>
58 Remote filesystem (<host/IP>[:<port>] address).
59 --remote-fs-password <password>
61 Password for remote filesystem.
62 --audio-driver <driver>
64 Audio driver ('PulseAudio', 'ALSA').
65 --video-driver <driver>
67 Video driver ('GLES3').
68 Display options:
70 -f, --fullscreen
71 Request fullscreen mode.
72 -m, --maximized
74 Request a maximized window.
75 -w, --windowed
77 Request windowed mode.
78 --resolution <W>x<H>
80 Request window resolution.
81 --position <X>,<Y>
83 Request window position.
84 --low-dpi
86 Force low-DPI mode (macOS and Windows only).
87 --no-window
89 Disable window creation (Windows only). Useful together with
90 --script.
91 Debug options:
93 -d, --debug
94 Debug (local stdout debugger).
95 -b, --breakpoints
97 Breakpoint list as source::line comma-separated pairs, no spaces
98 (use %20 instead).
99 --profiling
101 Enable profiling in the script debugger.
102 --remote-debug <address>
104 Remote debug (<host/IP>:<port> address).
105 --debug-collisions
107 Show collisions shapes when running the scene.
108 --debug-navigation
110 Show navigation polygons when running the scene.
111 --frame-delay <ms>
113 Simulate high CPU load (delay each frame by <ms> milliseconds).
114 --time-scale <scale>
116 Force time scale (higher values are faster, 1.0 is normal
117 speed).
118 --disable-render-loop
120 Disable render loop so rendering only occurs when called explic‐
121 itly from script.
122 --disable-crash-handler
124 Disable crash handler when supported by the platform code.
125 --fixed-fps <fps>
127 Force a fixed number of frames per second. This setting disables
128 real-time synchronization.
129 --print-fps
131 Print the frames per second to the stdout.
132 Standalone tools:
134 -s, --script <script>
135 Run a script.
136 --export <target>
138 Export the project using the given export target.
139 --export-debug
141 Use together with --export, enables debug mode for the template.
142 --doctool <path>
144 Dump the engine API reference to the given <path> in XML format,
145 merging if existing files are found.
146 --no-docbase
148 Disallow dumping the base types (used with --doctool).
149 --build-solutions
151 Build the scripting solutions (e.g. for C# projects).
152 --gdnative-generate-json-api
154 Generate JSON dump of the Godot API for GDNative bindings.
155 --test <test>
157 Run a unit test ('string', 'containers', 'math', 'render', 'mul‐
158 timesh', 'gui', 'io', 'shaderlang', 'physics', 'oa_hash_map').
159
161 XDG_DATA_CONFIG/godot/ or ~/.config/godot/
162 User-specific configuration folder, contains persistent editor
163 settings, script and text editor templates and projects meta‐
164 data.
165 XDG_DATA_HOME/godot/ or ~/.local/share/godot/
166 Contains the default configuration and user data folders for
167 Godot-made games (user:// path), as well as export templates.
168 XDG_DATA_CACHE/godot or ~/.cache/godot/
169 Cache folder for generated thumbnails and scene previews, as
170 well as temporary location for downloads.
171 /usr/share/doc/godot/
172 Additional documentation files.
173 /usr/share/licenses/godot/
174 Detailed licensing information.
175
177 See the project website at https://godotengine.org and the source code
178 repository at https://github.com/godotengine/godot for more details.
179
181 Godot Engine is a free and open source project and welcomes any kind of
182 contributions. In particular, you can report issues or make suggestions
183 on Godot's issue tracker at
184 https://github.com/godotengine/godot/issues.
185
187 Man page written by Rémi Verschelde <akien@godotengine.org> on behalf
188 of the Godot Engine development team.
189godot 3.0.2 February 2018 GODOT(6)