The Awaken view in GameGen
GameGen has a view named Awaken (NPCs & QA). It shows the QA agents’ runs for the selected project and the NPCs its game runs. It has two tabs, QA and NPCs, and it is read-only: nothing in it changes the game.
Open the view
Open your project in GameGen
Choose Awaken (NPCs & QA)
Choose Awaken in GameGen’s sidebar. The view’s heading reads Awaken (NPCs & QA), and it opens on the QA tab.
The QA tab
The QA tab has two sections.
QA runs
QA runs lists the recent runs of the project’s QA agent for Unreal, unreal-simulation. These are the same rows GameGen’s Unreal view lists. Each row shows the agent, the run’s status, its task and when it started.
| To | Do |
|---|---|
| Open a run | Choose Open run on its row. The run opens in the Agents view. |
| Open the task a run belongs to | Choose Open task #N on its row. The task opens on the board. |
| Read the runs again now | Choose Refresh. The button reads Checking… while it reads. |
The list is read again every 10 seconds while the window is visible, and when you switch projects.
| Message | Meaning |
|---|---|
| Reading QA runs… | The first read is still out. |
| No QA runs yet. QA runs start when a task reaches Review. | The project has no QA run. |
| The QA runs could not be read: followed by a reason | The read failed. Rows already shown stay under the message. |
Recorded play runs
The row Recorded play runs: open Lou → Review points to GameGen’s Lou view, listed in the sidebar as Lou (Decision Model), where recorded play runs are reviewed. Choose Open Lou to go there.
The NPCs tab
The NPCs tab shows the NPCs a running game publishes for the project, live. It reads the npcs slice of the project’s daemon, the same slice the Awaken app reads. The daemon fills that slice from the game’s NPC file.
The status line
The first line under NPCs says what the tab knows. It is one of five.
| Status line | Second line | Meaning |
|---|---|---|
| This project’s daemon is not running. | “NPCs appear here while the project is running and a game publishes them.” | Nothing is known, because there is no daemon to ask. |
| No game has published NPCs for this project yet. | None. The tab also shows How to see NPCs here. | The daemon has no npcs slice. It publishes one once it has seen the project’s .unrest/awaken folder. |
| No game is publishing NPCs for this project right now. | “A game has published here before. Run it again to see its NPCs.” | The slice is empty, and it has held no row since GameGen started. |
| The game stopped publishing. | “Its last roster had N NPCs. Rows return when the game runs again.” | The slice is empty after it held rows since GameGen started. The game stopped, or its file went stale or was refused. |
| Live: N NPCs | None. | The slice holds rows. With one row the line reads Live: 1 NPC. |
How to see NPCs here
While no game has published for the project, the tab lists three steps:
- “Add the AwakenDebug plugin to the game. An Unreal project created in GameGen already has it in Plugins/AwakenDebug.”
- “Run the game. While it runs, the plugin writes .unrest/awaken/npcs.json in this project a few times a second, and this view lists the rows.”
- “Stop the game and the rows go away within about five seconds.”
The roster
While the tab is live, Roster lists one row per NPC, up to 64.
| Part | Content |
|---|---|
| Name | The NPC’s name, or its id when the name is empty. |
| Status | The NPC’s status, or Status unknown. |
| Goal | The current goal, or No current goal reported. |
Click a row to select it. Until you pick one, the first row is selected. If the NPC you picked leaves the roster and comes back, it is shown again.
The inspector
Selected NPC shows the selected row in full.
| Part | Content |
|---|---|
| Heading | The name, the status and the position as x, y and z with one decimal, or No position reported. |
| Current goal | The goal, or No current goal reported. |
| Goals | The goal list, each with its status when it has one, or No goals reported. Up to 100 are listed. |
| Blackboard | One key and value per entry, in the game’s order, or No blackboard reported. Up to 100 are listed. |
| Behaviour tree | The tree as indented lines, each with the node’s type and status when it reports them, or No behaviour tree reported. Up to 200 nodes are listed. |
A value longer than 80 characters is cut and ends in …. Click it to show all of it, and click again to show less.
The roster and the inspector repaint at most four times a second.
The NPCs tab was verified in the real app with a fixture publisher that writes the NPC file. A real Unreal game as the publisher into this tab is not yet verified.
Next steps
- QA runs.
- Quickstart.
- A tour of GameGen for the rest of GameGen’s views.