1GODOT(6)                             Games                            GODOT(6)
2
3
4

NAME

6       godot - multi-platform 2D and 3D game engine with a feature-rich editor
7

SYNOPSIS

9       godot [options] [path to scene or 'project.godot' file]
10

DESCRIPTION

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
17   General options:
18       -h, --help
19              Display this help message.
20
21       --version
22              Display the version string.
23
24       -v, --verbose
25              Use verbose stdout mode.
26
27       --quiet
28              Quiet  mode,  silences  stdout  messages.  Errors are still dis‐
29              played.
30
31   Run options:
32       -e, --editor
33              Start the editor instead of running the scene.
34
35       -p, --project-manager
36              Start the project manager, even if a project is auto-detected.
37
38       -q, --quit
39              Quit after the first iteration.
40
41       -l, --language <locale>
42              Use a specific locale (<locale> being a two-letter code).
43
44       --path <directory>
45              Path to a project (<directory> must  contain  a  'project.godot'
46              file).
47
48       -u, --upwards
49              Scan folders upwards for project.godot file.
50
51       --main-pack <file>
52              Path to a pack (.pck) file to load.
53
54       --render-thread <mode>
55              Render thread mode ('unsafe', 'safe', 'separate').
56
57       --remote-fs <address>
58              Remote filesystem (<host/IP>[:<port>] address).
59
60       --remote-fs-password <password>
61              Password for remote filesystem.
62
63       --audio-driver <driver>
64              Audio driver ('PulseAudio', 'ALSA', 'Dummy').
65
66       --video-driver <driver>
67              Video driver ('GLES3', 'GLES2').
68
69   Display options:
70       -f, --fullscreen
71              Request fullscreen mode.
72
73       -m, --maximized
74              Request a maximized window.
75
76       -w, --windowed
77              Request windowed mode.
78
79       -t, --always-on-top
80              Request an always-on-top window.
81
82       --resolution <W>x<H>
83              Request window resolution.
84
85       --position <X>,<Y>
86              Request window position.
87
88       --low-dpi
89              Force low-DPI mode (macOS and Windows only).
90
91       --no-window
92              Disable  window  creation  (Windows  only). Useful together with
93              --script.
94
95   Debug options:
96       -d, --debug
97              Debug (local stdout debugger).
98
99       -b, --breakpoints
100              Breakpoint list as source::line comma-separated pairs, no spaces
101              (use %20 instead).
102
103       --profiling
104              Enable profiling in the script debugger.
105
106       --remote-debug <address>
107              Remote debug (<host/IP>:<port> address).
108
109       --debug-collisions
110              Show collisions shapes when running the scene.
111
112       --debug-navigation
113              Show navigation polygons when running the scene.
114
115       --frame-delay <ms>
116              Simulate high CPU load (delay each frame by <ms> milliseconds).
117
118       --time-scale <scale>
119              Force  time  scale  (higher  values  are  faster,  1.0 is normal
120              speed).
121
122       --disable-render-loop
123              Disable render loop so rendering only occurs when called explic‐
124              itly from script.
125
126       --disable-crash-handler
127              Disable crash handler when supported by the platform code.
128
129       --fixed-fps <fps>
130              Force a fixed number of frames per second. This setting disables
131              real-time synchronization.
132
133       --print-fps
134              Print the frames per second to the stdout.
135
136   Standalone tools:
137       -s, --script <script>
138              Run a script.
139
140       --check-only
141              Only parse for errors and quit (use with --script).
142
143       --export <target>
144              Export the project using the given export  target.  Export  only
145              main pack if path ends with .pck or .zip.
146
147       --export-debug <target>
148              Like --export, but use debug template.
149
150       --doctool <path>
151              Dump the engine API reference to the given <path> in XML format,
152              merging if existing files are found.
153
154       --no-docbase
155              Disallow dumping the base types (used with --doctool).
156
157       --build-solutions
158              Build the scripting solutions (e.g. for C# projects).
159
160       --gdnative-generate-json-api
161              Generate JSON dump of the Godot API for GDNative bindings.
162
163       --test <test>
164              Run a unit  test  ('string',  'math',  'physics',  'physics_2d',
165              'render',  'oa_hash_map',  'gui',  'shaderlang', 'gd_tokenizer',
166              'gd_parser', 'gd_compiler',  'gd_bytecode',  'ordered_hash_map',
167              'astar').
168

FILES

170       XDG_DATA_CONFIG/godot/ or ~/.config/godot/
171              User-specific  configuration  folder, contains persistent editor
172              settings, script and text editor templates  and  projects  meta‐
173              data.
174       XDG_DATA_HOME/godot/ or ~/.local/share/godot/
175              Contains  the  default  configuration  and user data folders for
176              Godot-made games (user:// path), as well as export templates.
177       XDG_DATA_CACHE/godot/ or ~/.cache/godot/
178              Cache folder for generated thumbnails  and  scene  previews,  as
179              well as temporary location for downloads.
180       /usr/share/doc/godot/
181              Additional documentation files.
182       /usr/share/licenses/godot/
183              Detailed licensing information.
184

SEE ALSO

186       See  the project website at https://godotengine.org and the source code
187       repository at https://github.com/godotengine/godot for more details.
188

BUGS

190       Godot Engine is a free and open source project and welcomes any kind of
191       contributions. In particular, you can report issues or make suggestions
192       on            Godot's            issue            tracker            at
193       https://github.com/godotengine/godot/issues.
194

AUTHOR

196       Man  page  written by Rémi Verschelde <akien@godotengine.org> on behalf
197       of the Godot Engine development team.
198
199
200
201godot 3.1                        January 2019                         GODOT(6)
Impressum