Skip to Content
AwakenUnreal pluginOverview

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

PlaceHow to open itChecked on screen
In-game panel, drawn in the game’s own frame when the egui library is builtF10, or console Awaken.Debug 1Yes: 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 builtThe same key and variable, or Awaken.Renderer canvasYes: Unreal Engine 5.9 on macOS, in a 960 by 540 -game window of Floppy Bird.
Gameplay DebuggerThe Awaken categoryNot yet verified. The category compiles and registers.
Editor tabWindow > Tools > Debug > Awaken NPCsNot yet verified.
Output LogConsole Awaken.DumpNot yet verified with live rows.
The NPC file.unrest/awaken/npcs.json in the project folderYes, end to end with the project daemon.

The two classes

ClassUse
UAwakenDebugSubsystemA world subsystem. It holds the registry of a world’s NPCs. It exists in game and Play In Editor worlds.
UAwakenNpcComponentAn 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

PlatformStatus
macOS (Apple silicon), Unreal Engine 5.9Tested.
Windows, LinuxNot yet verified. The code uses only engine APIs, but it has been compiled and run on macOS alone.
Unreal Engine 5.8Not yet verified.
Packaged development buildsNot yet verified. A packaged game writes under its own project directory, which may not be where the Awaken app looks.

In this section

Next steps

Last updated on