Skip to Content
GameGenUnreal EngineThe Unreal view

The Unreal view

The Unreal view shows the state of the open Unreal project on one page: the project file, the engine, the editor, the last build and test, the agents’ runs, and four action buttons. It appears in the sidebar only when the open project is an Unreal project.

The view rereads its status every ten seconds while the window is visible. The header shows when it last checked. Choose Refresh to check now.

Project

RowStatesMeaning
The .uproject file nameWants Unreal Engine and a versionThe file was read. The version is its EngineAssociation.
UnreadableThe file exists but could not be read. The reason is shown.
No .uproject fileNothing at the project root for the engine to open or build. The Unreal coder creates one when it scaffolds the game.
GameGen engine settingunreal.unrest/gamegen.json names the engine.
Not set or No gamegen.jsonGameGen treats the folder as an Unreal project because of its .uproject file. Set "engine": "unreal" in gamegen.json to make that explicit.

If more than one .uproject file sits at the root, the first by name is shown.

Engine install

RowStatesMeaning
EngineUnreal Engine and a versionThe engine the actions use, its folder, and where it was found.
Found (version unknown)The engine folder was found, but its version file could not be read.
Not foundNo engine was found, or UE_ROOT points at a folder with no Engine folder.
VersionA sentence comparing versionsWhether the installed engine matches the one the project asks for.

Other installs are listed after “Also installed”. See Engine setup.

Editor connection

One row, Unreal Editor, with one of three states.

StateMeaning
ConnectedRemote Control answers. The Unreal agents can inspect and drive this editor.
Not connectedNothing answers at the Remote Control address, or a running editor has another project open or its Remote Control server off.
UnknownThe address cannot be checked from here.

See Editor connection.

Last build and test

This section reads the result report that Scripts/ue.mjs writes after a build or a test.

StateMeaning
PassedThe run finished with no failure.
FailedThe build failed or a test failed.
IncompleteNo test was selected, or a selected test did not report a result.
Unknown resultThe report has no result.
No runs yetNothing has built or tested this project through Scripts/ue.mjs yet.

The detail line says what ran, for example how many tests passed and how long the run took. Failed tests are listed after “Failed”, and tests with no result after “Did not report”. Each log has its path with a Copy button and Show the end of this log.

“None of this project’s sources were compiled (already up to date)” means the build succeeded without compiling your code. That is normal after an unchanged build.

Unreal agent runs

The ten latest Unreal coder and Unreal QA runs, newest first. Each row shows the agent, the state, the task and the start time, with Open run and Open task. With no runs it reads “No Unreal coder or Unreal QA runs yet. They start when a task on the board is picked up.”

See Agents.

Actions

Four buttons: Build, Run tests, Open editor and Stop editor. When a button cannot be pressed, the reason appears under the buttons and in the button’s tooltip. See Build, test and open the editor.

When the view shows something else

MessageMeaning
“Reading the Unreal project…”The first check has not finished.
Not an Unreal projectThe project has no .uproject file at its root and its gamegen.json does not name the unreal engine.
Unreal status unavailableThe project could not be read. Choose Try again. See Troubleshooting.
“The last check failed (…); what is shown is from the check before it.”One check failed. The page still shows the last good status.

Next steps

Last updated on