Skip to Content
GameGenUnreal EngineBuild, test and open the editor

Build, test and open the editor

The Unreal view has four action buttons. Each one runs the project’s own script, Scripts/ue.mjs, from the project folder with no other arguments. You can run the same commands in a terminal.

Before you start

  • The project needs Scripts/ue.mjs. The Floppy Bird tutorial includes it.
  • Node 18 or newer must be installed.
  • An engine must be found for Build, Run tests and Open editor. See Engine setup.

The four actions

ButtonWhat it doesCommand
BuildCompiles the editor target.node Scripts/ue.mjs build
Run testsBuilds, then runs the automation tests.node Scripts/ue.mjs test
Open editorStarts Unreal Editor on this project with Remote Control on.node Scripts/ue.mjs editor-start
Stop editorStops the editor that Open editor started.node Scripts/ue.mjs editor-stop

One action runs at a time. While it runs, its output appears under the buttons and updates as it goes. When it ends, the line above the output reads, for example, “Build finished.” or “Run tests failed (exit code 1).”

Build the project

Close the project’s editor

A full build needs the editor closed, because the open editor holds the module binaries. The script does not close editors for you.

Choose Build

In the Unreal view, under Actions, choose Build.

Read the result

When the build ends, Last build and test updates. Passed means the build succeeded.

Run the tests

Choose Run tests

The script builds first, then runs the project’s automation tests without a window.

Read the result

Last build and test shows how many tests passed and failed. A failed test is named after “Failed”. A test that produced no result is named after “Did not report”.

A run counts as Passed only when every selected test reports its own success. One passing test cannot hide a missing one.

Open and stop the editor

Open editor starts Unreal Editor with Remote Control on and waits until Remote Control answers. Only one such editor runs on a machine at a time, because Remote Control uses one port. If another editor already holds the port, the action stops with “EDITOR NOT STARTED” and asks you to close that editor first.

Stop editor stops only the editor that Open editor started. It leaves an editor you opened yourself alone.

Run Open editor after Build, so the editor loads the binaries you just built.

Run the commands in a terminal

Under Actions, open The same commands, for a terminal. It lists a cd command for the project folder and the four commands, each with a Copy button.

node Scripts/ue.mjs build node Scripts/ue.mjs test node Scripts/ue.mjs editor-start node Scripts/ue.mjs editor-stop

A terminal gives you options the buttons do not, such as rebuild, --filter and --clean-build. See the ue.mjs reference.

When a button is disabled

Reason shownFix
“This project has no Scripts/ue.mjs.”The project has no build script. The buttons work on projects that include one, such as the tutorial.
“Node.js was not found. Install Node 18 or newer.”Install Node, then choose Refresh.
“No Unreal Engine install was found.”See Engine setup.
“An Unreal action from another project is still running.”Wait for it to end.
“This desktop build has not been granted Unreal actions. Run the command in a terminal instead.”Run the command in a terminal.

Next steps

Last updated on