Skip to content

Install

Jump to bottom
Butch Wesley edited this page Jun 23, 2020 · 15 revisions

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

Follow the instructions or checkout this tutorial by Rainware: https://www.youtube.com/watch?v=vBbqlfmcAlc

  1. Click the AssetLib button at the top of the editor
  2. Search for "Gut"
  3. Click it.
  4. Click "Install". This will kick off the download.
  5. 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.
  6. Click the 3rd "Install" button.
  7. You did it!

Finish the install by following the instructions in Setup below.

Installing Download

Download and extract 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

  1. From the menu choose Project->Project Settings, click the Plugins tab and activate Gut.

Setup Your Project to Run Tests

The next few steps cover the suggested configuration. Feel free to deviate where you see fit.

  1. Create directories to store your tests and test related code
    • res://test
    • res://test/unit
    • res://test/integration

You can run test through a scene or from the Command Line. The next instructions are for running with a scene.

  1. Create a scene that will use Gut to run your tests at res://test/tests.tscn
    • Add a Gut object the same way you would any other object.
    • Click "Add/Create Node"
    • type "Gut"
    • press enter.
  2. Configure Gut to find your tests. Select it in the Scene Tree and set the following settings in the Inspector:
    • In the Directory1 setting enter res://test/unit
    • In the Directory2 setting enter res://test/integration

A full description of all GUT settings can be found here.

That's it. The next step is to make some tests.

Where to next?

Clone this wiki locally