Installing Dependencies

Go

If you haven’t already done so, you will need to Download and Install Go so you will be able to compile any .go source files into native executables.

After Go is installed, make sure $GOPATH/bin is part of your PATH, so that any tools that you decide to go install will be available for use in your terminal.

Windows

setx PATH "%PATH%;%GOPATH%\bin"

macOS

echo 'export PATH="$PATH:$GOPATH/bin"' >> ~/.zshrc && source ~/.zshrc

Linux

echo 'export PATH="$PATH:$GOPATH/bin"' >> ~/.bashrc && source ~/.bashrc

Godot

The gd command will look for godot in your $PATH - make sure you have the right version installed (typically this will be the latest stable version of Godot).

https://godotengine.org/download/

Note

On Linux and MacOS, the gd command line tool will attempt to automatically download and use the correct version of godot for you if it’s not already installed.

Zig

In order for Go code to work together with the C++ code in the Godot Engine, you’ll need a C compiler. We officially support The Zig Compiler as it supports full cross-compilation.

Note

graphics.gd can build projects for any supported platforms on any operating system (this includes building for macOS on Windows/Linux without needing access to Apple hardware).

Windows

Please ensure that Zig is added to your PATH after you’ve extracted it to a convieniant location on your computer.

setx PATH "%PATH%;C:\place\you\extracted\zig-windows-x86_64-your-version"

macOS

You can use Homebrew to install Zig:

brew install zig

Linux

You should be able to install Zig using your package manager.

snap install zig