https://github.com/godot-extended-libraries/godot-debug-menu-demo

Demo for the in-game FPS/performance/hardware metrics add-on for Godot 4.x
https://github.com/godot-extended-libraries/godot-debug-menu-demo

godot godot-engine godotengine

Last synced: 3 months ago
JSON representation

Demo for the in-game FPS/performance/hardware metrics add-on for Godot 4.x

• Host: GitHub
• URL: https://github.com/godot-extended-libraries/godot-debug-menu-demo
• Owner: godot-extended-libraries
• License: mit
• Created: 2023-04-24T16:40:17.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-08-02T14:55:52.000Z (6 months ago)
• Last Synced: 2024-08-02T16:43:14.216Z (6 months ago)
• Topics: godot, godot-engine, godotengine
• Language: GDScript
• Homepage: https://github.com/godot-extended-libraries/godot-debug-menu
• Size: 102 KB
• Stars: 48
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Debug Menu add-on demo project for Godot 4.x

**Displays performance information in a Godot project during gameplay.**

Can be used when running from the editor and in exported projects.

Inspired by id Tech 6/7's performance overlay.

![Screenshot](https://raw.githubusercontent.com/Calinou/media/master/godot-debug-menu-demo/screenshot.png)

This repository contains the demo project for the

[Debug Menu add-on](https://github.com/godot-extended-libraries/godot-debug-menu).

The add-on's code is included in this repository and is mirrored periodically.

Please report issues specific to the add-on

[here](https://github.com/godot-extended-libraries/godot-debug-menu), not in this repository.

## Try it out

> **Note**

>

> This add-on only supports Godot 4.x, not Godot 3.x.

### Using the Asset Library

- Open the Godot project manager.

- Navigate to the **Templates** tab and search for "debug menu".

- Install the [*Debug Menu Demo*](https://godotengine.org/asset-library/asset/1903) project.

### Manual installation

Manual installation lets you try pre-release versions of this demo by following its

`master` branch.

- Clone this Git repository:

```bash

git clone https://github.com/godot-extended-libraries/godot-debug-menu-demo.git

```

Alternatively, you can

[download a ZIP archive](https://github.com/godot-extended-libraries/godot-debug-menu-demo/archive/master.zip)

if you do not have Git installed.

- Import the Godot project using the project manager and open it in the editor.

- Run the main scene by pressing F5.

## Usage

Press F3 while the project is running. This cycles between no debug

menu, a compact debug menu (only FPS and frametime visible) and a full debug

menu.

The key to cycle the debug menu is set to F3 by default. This can be

changed by setting the `cycle_debug_menu` action in the Input Map to a different

key. This action is not created by the plugin in the editor, so you will have to

create it in the Project Settings if you wish to override the key.

To toggle the debug menu from code, use:

- `DebugMenu.style = DebugMenu.Style.HIDDEN` to hide the debug menu.

- `DebugMenu.style = DebugMenu.Style.VISIBLE_COMPACT` to show the compact debug menu.

- `DebugMenu.style = DebugMenu.Style.VISIBLE_DETAILED` to show the detailed debug menu.

## License

Copyright © 2023-present Hugo Locurcio and contributors

Unless otherwise specified, files in this repository are licensed under the

MIT license. See [LICENSE.md](LICENSE.md) for more information.