Skip to Content
AwakenAwaken appOverview

The Awaken app

The Awaken app is a native desktop app for watching the characters in a running game. It opens a game project, connects to the project’s AgentLoop daemon, and shows the NPC roster and an inspector in an overlay over the game. It has no chat interface: characters act in the game, and Awaken is where you see what they are doing.

For an Unreal game, the primary way to see NPCs is the in-game panel that the AwakenDebug plugin draws inside the game’s own frame. The Awaken app’s overlay is the path for a game whose plugin was built without the egui library.

Availability

The Awaken app is not installable from the Unrest Launcher yet; the launcher lists Awaken as Coming soon. Today you run it from the awaken source folder with a Rust toolchain. Attaching the overlay to a game window works on macOS only. See Platform support.

The three surfaces

SurfaceUse
Launcher windowPick a project, start or attach to the daemon, and open the overlay. Its pages are Overview, NPCs, State, Console and Settings.
OverlayA transparent, always-on-top window over the game, with the NPC roster and the inspector.
Tray iconKeeps Awaken running in the background. Its menu has Show Awaken, Show Overlay or Hide Overlay, the daemon’s status, Restart Daemon and Quit Awaken.

Awaken and the daemon

The agent runtime is not part of Awaken. It is the AgentLoop daemon, a separate process, and Awaken talks to it over a local socket. The socket is derived from the project’s path, so Awaken and GameGen share one daemon when they open the same project.

If no daemon is listening for the project, Awaken starts one. It looks for the agentloop-daemon program in this order:

  1. The path in AWAKEN_DAEMON_BIN.
  2. The path in AGENTLOOP_RUST_DAEMON.
  3. agentloop-daemon next to the awaken program.
  4. On macOS, inside Awaken.app, in Contents/Resources.
  5. agentloop-daemon on your PATH.

Awaken also works with no daemon at all: it then reads the game’s NPC file itself.

Run Awaken from source

Get the prerequisites

You need a Rust toolchain, and an AgentLoop checkout beside the awaken folder. Set AGENTLOOP_DIR if it is somewhere else.

Build and run

In the awaken folder:

make run

Awaken starts a daemon if none is running. To open a project straight away, see Open a project.

Other make targets:

CommandEffect
make buildDebug build of Awaken.
make testRun the workspace’s tests.
make daemonRelease build of agentloop-daemon.
make devBuild a debug daemon and run Awaken against it.
make packageBuild a package into dist/.

Command-line flags

FlagEffect
--project <path>Open this project folder or its .uproject file. Overrides AWAKEN_PROJECT_PATH.
--overlayStart with the overlay shown. For an Unreal game it attaches to the game’s window.
--no-autostartNever start a daemon; only attach to a running one.
--no-trayRun without the tray icon.
--hiddenStart with the launcher window hidden in the tray.

The environment variables are listed in the reference.

In this section

Next steps

Last updated on