Install
GUT is a Godot Plugin. You can download it directly or install it from the Asset Lib in the Godot Editor.
Installing from in-editor Godot Asset Lib
Click the AssetLib button at the top of the editor
Search for “Gut”
Click it.
Click “Install”. This will kick off the download.
Click the 2nd “Install” button that appears when the download finishes. It will be in a little dialog at the bottom of the AssetLib window.
Click the 3rd “Install” button.
You did it!
Finish the install by following the instructions in Setup below.
Download and install
Download the zip from the releases or from the Godot Asset Library.
Extract the zip and place the gut
directory into your addons
directory in your project. If you don’t have an addons
folder at the root of your project, then make one and THEN put the gut
directory in there.
Finish the install by following the instructions in Setup below.
Setup
Activate
From the menu choose Project->Project Settings, click the Plugins tab and activate Gut.
Setup directories for tests
The next few steps cover the suggested configuration. Feel free to deviate where you see fit.
Create directories to store your tests and test related code (suggested config)
res://test
res://test/unit
res://test/integration
Running Tests
Run tests from the GUT Panel
Set the test directories in the settings subpanel (below) and click “Run All”. That’s all there is to it.
Run tests from the command line
GUT comes with a command line interface, more info can be found on the Command Line page.
Run tests through VSCode
There is also a VSCode plugin that you can use to run tests directly from VSCode. You can find the plugin and related documentation here.