AwakenDebug, the Unreal plugin
AwakenDebug is an Unreal Engine plugin that shows what a game’s NPCs and agents are doing: who they are, their status, current goal, goal list, behaviour tree and blackboard. Your game tells the plugin about its NPCs; the plugin shows them and writes them to a file for the other Awaken viewers.
The plugin only reads what the game gives it. It reads nothing back from the file and changes no game state. It is plain C++. Its one third-party library, Awaken’s egui panels, is optional. Shipping builds draw nothing and write nothing.
Where the plugin shows NPCs
| Place | How to open it | Checked on screen |
|---|---|---|
| In-game panel, drawn in the game’s own frame when the egui library is built | F10, or console Awaken.Debug 1 | Yes: Unreal Engine 5.9 on macOS arm64, in a 1280 by 720 -game window of Floppy Bird. Windows and Linux are not yet verified. |
| In-game text HUD, when the library is not built | The same key and variable, or Awaken.Renderer canvas | Yes: Unreal Engine 5.9 on macOS, in a 960 by 540 -game window of Floppy Bird. |
| Gameplay Debugger | The Awaken category | Not yet verified. The category compiles and registers. |
| Editor tab | Window > Tools > Debug > Awaken NPCs | Not yet verified. |
| Output Log | Console Awaken.Dump | Not yet verified with live rows. |
| The NPC file | .unrest/awaken/npcs.json in the project folder | Yes, end to end with the project daemon. |
The two classes
| Class | Use |
|---|---|
UAwakenDebugSubsystem | A world subsystem. It holds the registry of a world’s NPCs. It exists in game and Play In Editor worlds. |
UAwakenNpcComponent | An actor component, Awaken Npc. It registers its owner when play begins and removes it when play ends. |
Both are available from C++ and from Blueprint.
Platform status
| Platform | Status |
|---|---|
| macOS (Apple silicon), Unreal Engine 5.9 | Tested. |
| Windows, Linux | Not yet verified. The code uses only engine APIs, but it has been compiled and run on macOS alone. |
| Unreal Engine 5.8 | Not yet verified. |
| Packaged development builds | Not yet verified. A packaged game writes under its own project directory, which may not be where the Awaken app looks. |
In this section
Install into a projectRegister NPCs in C++Register NPCs in BlueprintThe Awaken Npc componentBehaviour trees with AgentLoopBTIn-game panel, HUD and debuggerConsole commands
Next steps
- Install the plugin into a project.
- New to Awaken? Start with the quickstart.
Last updated on