Debugging and tools
Logging, diagnostics, gizmos, profiling, developer overlays and the remote protocol in the NEO engine, and which of them are in NEO's builds.
The engine has tools for seeing what a running game does: log messages, measured numbers such as frame time, lines drawn in the world, timing traces, on-screen overlays and a protocol for inspecting a game from outside. Some are in every NEO build; others need a cargo feature you turn on while you work.
What's in NEO's builds#
| Tool | In NEO's default builds | Page |
|---|---|---|
Logging (info!, warn!, RUST_LOG) | Yes | Logging |
| Diagnostics (FPS, frame time, entity count, CPU and memory) | Yes, once you add the plugins | Diagnostics |
| Gizmos (debug lines, shapes and text) | Yes | Gizmos |
| Profiling spans and Tracy | No: needs trace and a backend feature | Profiling |
| FPS overlay, picking debug, infinite grid, render debug overlay | No: needs neo_dev_tools | Developer tools |
| Remote protocol (inspect a running game over HTTP) | No: needs neo_remote | Remote protocol |
Turning a feature on is a change to your game crate's Cargo.toml or a --features flag; see Cargo features. Keep development-only features out of the builds you publish.
The Studio's tools#
When you play a game in the NEO Studio, you get more than the engine's tools: pause and single-step, eject to fly around the live game and inspect objects, the Scene panel showing the live world, the Console with the game's log, and the Plugins panel with each plugin's health and what it added. Every Studio feature is also a command that the command line and AI agents can call. See Play in the Studio and Plugins and neo.toml.