GameTests

experimental

WARNING

The Script API is currently in active development, and breaking changes are frequent. This page assumes the format of Minecraft beta 1.19.70

The GameTest Framework allows us to create unit tests ("GameTests") which make it easier to test if game mechanics work.

GameTests can be used with the /gametest command.

  • /gametest runthis - Runs the nearest GameTest in range.
  • /gametest runthese - Runs all GameTests in range.
  • /gametest pos - It tells you the relative coordinates of the nearest GameTest.
  • /gametest clearall [radius: int] - Removes all GameTests in the specified radius.
  • /gametest run <testName: GameTestName> [rotationSteps: int] - Creates and runs the specified GameTest.
  • /gametest runset [tagTag: GameTestTag] [rotationSteps: int] - Creates and runs all GameTests with the specified tag.
  • /gametest create <testName: string> [width: int] [height: int] [depth: int] - Creates a blank GameTest area with the specified dimensions.
  • /reload - Reloads all function and script files from all behavior packs. (1.19+)

(1.19.40+) Vanilla GameTests are removed from the Minecraft game files, so you cannot run any gametests without adding your own custom behavior pack. You can find them in the official repo.

Get started with GameTest

To get started, you'll want to begin with your own behavior pack and decent knowledge of scripting and API. If you're getting started check out this article.

To use the GameTest Framework, the @minecraft/server-gametest module is required. The GameTest API module also requires the @minecraft/server module, so in your dependency in your manifest.json requires the following:

BP/manifest.json/Copy
json
"dependencies": [
    {
        "module_name": "@minecraft/server",
        "version": "1.1.0-beta"
    },
    {
        "module_name": "@minecraft/server-gametest",
        "version": "1.0.0-beta"
    }
]
1
2
3
4
5
6
7
8
9
10

To run a GameTest, a structure file is required on your behavior pack and the command needs to be registered via register function.

BP/scripts/Main.jsCopy
js
import * as GameTest from "@minecraft/server-gametest";

// Registration Code for our test
GameTest.register(
    "wiki",         // Name of the class of tests.
    "simpleTest",   // Name of this test.
    (test) => {     // Implementation of the test
        /**
         * @type {import("@minecraft/server").Vector3}
         * location from the test of where the cow should spawn in
         */
        const location = { x: 0, y: 0, z: 0 };
        const cow = test.spawn("minecraft:cow", location); // returns Entity instance

        test.succeedWhen(() => {
          test.assertEntityPresentInArea("minecraft:cow", true);
        });
    }
)
    .maxTicks(410)
    .structureName("mystructure:wiki"); /* use the wiki.mcstructure file */
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

The test function is locked when the command is registered, meaning the test function can not access to variables outside the test function after the command is registered.

If you're having issues with the Script API, consider checking out an article of Building your first GameTest in Microsoft learn, or joining Bedrock Add-Ons for support, which you can find alongside a vast array of other resources on the Useful Links page!

Contributors