Runtime debugging

BornEngine’s developer inspector is configured on the Game instance. Enable it for local builds and keep it off for ordinary game builds:

const game = new Game({
  debug: {
    enabled: true,
    metrics: true,
    sceneHierarchy: true,
    assets: true,
  },
});

The inspector draws after the game’s render hook through the Dear ImGui debug surface. It reports frame timing, scene objects, and asset usage. Each panel can be disabled separately. debug: true turns on all built-in panels.

Desktop feature

Dear ImGui is opt-in on native desktop targets. Add debug-ui to the engine features in your project’s existing perry.toml configuration:

[native-library."@bornengine/engine"]
features = ["debug-ui"]

Check game.debugUi.isAvailable() before drawing custom panels. On other targets, or when the desktop feature is off, it returns false; gameplay can keep using the same Game options without platform checks.

Project-specific windows

Use game.debugUi for developer-only widgets such as state labels and live counters. Keep IDs stable and unique, and use game.ui only for player-facing interface.

if (game.debugUi.isAvailable()) {
  game.debugUi.beginWindow(9100, 'Combat');
  game.debugUi.label(9101, 'Wave: ' + wave);
  game.debugUi.label(9102, 'Enemies: ' + enemies.length);
  game.debugUi.endWindow(9100);
}

See Debug tools for the complete configuration and backend details.