Skip to content
Godot Development Tools

Quick start

After installing gdt.

1. Get a Godot build

Section titled “1. Get a Godot build”
Terminal window
gdt install 4.7.2        # downloads the official build and checks its SHA-512
gdt ls                   # what you have; `gdt ls -r` shows what you can install

The first build you install becomes the global default (gdt use 4.7.2 changes it). Add -mono for the .NET build: gdt install 4.7.2-mono.

2. Tie a project to it

Section titled “2. Tie a project to it”

In the project folder:

Terminal window
gdt pin 4.7              # writes [godot] version = "4.7.x" into gdt.toml
gdt open                 # the editor, with the version the project asks for
gdt run tools/foo.gd     # a script, headless, from any folder
gdt run -- --path . --import

Commit gdt.toml. Anyone who clones the project gets the same version. If that build is not installed, gdt prints the exact gdt install ... command and exits with 4; gdt sync does it for you.

3. Add addons and tests

Section titled “3. Add addons and tests”
Terminal window
gdt addon add github:bitwes/Gut@v9.7.1 --dev    # install GUT, record it, pin it in gdt.lock
gdt test                                         # run the tests headless; exit 10 if any fail

Commit gdt.toml and gdt.lock.

4. On a fresh clone

Section titled “4. On a fresh clone”
Terminal window
gdt sync                 # the engine, then the addons
gdt test

5. Optional: a godot that follows gdt

Section titled “5. Optional: a godot that follows gdt”
Terminal window
gdt shim install --modify-path

Then godot --path <project> ... uses the project’s version, from any folder. See the shim.

Where next

Section titled “Where next”

Independent community project. Not affiliated with, endorsed by or sponsored by the Godot Foundation or the Godot Engine project. “Godot” is a trademark of the Godot Foundation; this site does not use the Godot logo.