Install AwakenDebug into a project
A project that GameGen creates already has AwakenDebug. For any other Unreal C++ project you copy the plugin in, enable it, and rebuild.
Before you start
| You need | Detail |
|---|---|
| Unreal Engine 5.9 | The plugin is tested on 5.9 on macOS (Apple silicon). Windows, Linux and 5.8 are not yet verified. |
| A C++ project | The plugin is built from source with your project. |
| The plugin’s source | vendor/unreal-plugins/AwakenDebug in the AgentLoop repository. |
Projects made in GameGen
GameGen puts the plugin in every new Unreal project, in Plugins/AwakenDebug/, and turns it on in the .uproject. You have nothing to install. Go to Register NPCs in C++.
Any other C++ project
Copy the plugin
From the AgentLoop repository, run the install script with your project folder (the folder that holds the .uproject file):
vendor/unreal-plugins/AwakenDebug/Scripts/install-into-project.sh /path/to/MyGameThe script copies the plugin to MyGame/Plugins/AwakenDebug/. It copies rather than links, and leaves out Binaries/ and Intermediate/.
Enable the plugin
Add the plugin to the Plugins list in MyGame.uproject:
"Plugins": [ { "Name": "AwakenDebug", "Enabled": true } ]Add the module dependency
Do this only if your game calls the plugin from C++. In your game module’s Build.cs:
PrivateDependencyModuleNames.Add("AwakenDebug");Rebuild the project
Close the editor and build the editor target.
Check that it works
Start a Play In Editor session
Or run the project with -game.
Show the HUD
Press F10, or enter Awaken.Debug 1 in the console. With Awaken’s egui library built, the in-game panel appears with the roster. Without it, the text HUD appears, and its first line starts with Awaken NPCs and the number of registered NPCs.
Check the file
While play runs, .unrest/awaken/npcs.json exists in the project folder. It is deleted when play ends.
You can also run the plugin’s automation tests without a window:
"$UE/Engine/Binaries/Mac/UnrealEditor-Cmd" /path/to/MyGame/MyGame.uproject \
-ExecCmds="Automation RunTests AwakenDebug; Quit" \
-unattended -nullrhi -nosplash -nosound -nopause -stdoutIn a GameGen Floppy Bird project, node Scripts/ue.mjs test --filter AwakenDebug does the same.
Keep the file out of version control
The NPC file is rewritten while the game runs. Add .unrest/awaken/ to your ignore rules. The Floppy Bird tutorial project already ignores it.