Antz's Debug Menu

Overview

Displays performance information in a Godot project during gameplay. Can be used when running from the editor and in exported projects.

This is an updated and maintained version of Calinou's original plugin.

Includes an updated demo - no more separate repositories for the plugin and demo.

New Features

• Added Draw Calls, Primitives, and total VRAM usage stats for the current frame.
• Crisp font-based scaling of the overlay. Supported font sizes range from 3 to 72, accommodating very small viewports, stretch_mode=canvas, and large 4K viewports with stretch_mode=disabled.
• Font size can now be set via a Project Setting or by calling DebugMenu.set_font_size() in code.
• Startup visibility (hidden, visible_compact, or visible_detailed) can be configured in the Project Settings. Default is hidden.
• Pressing F4 cycles through predefined font sizes, including your custom Project Setting value.

Original features

• Features compact and full display modes, with the compact mode only displaying FPS, frametime and framerate cap.
• Displays FPS, frametime, CPU time and GPU time graphs with a summary of the best/worst/average frametimes over recently drawn frames.
• Displays hardware information, including graphics driver version.
• Displays software information, including project version (if specified in the application/config/version custom project setting) and graphics settings.
• Works with the Forward+, Mobile and Compatibility rendering methods.
• Works with 2D and 3D projects.
• Works when running the project from the editor, but also in exported projects (debug and release).

Installation

1. Copy the addons/debug-menu/ folder into your Godot project.
2. Enable the plugin in Project Settings -> Plugins -> Antz's Debug Menu.
3. Optional: Set the default font size and overlay visibility in the Project Settings > General > Debug Menu.
4. Optional: A test scene is included in the demo folder. Right click test.tscn, then select: Set as Main Scene and run.

What happened to Calinou's Debug Menu?

I submitted several Pull Requests to the original project. After waiting 6 months on the last PR with no feedback, I decided to continue development on my own fork.

Calinou is doing great work on the Godot Engine itself, which is fantastic for the community. My goal was to keep this useful debugging tool alive and improved for everyone.

More Information

Visit the plugin's GitHub repository: https://github.com/antzGames/Antz-Debug-Menu