Move to an add-on, add demo project structure

- Display `application/config/version` project setting on the debug menu if present.

Author: Calinou

.editorconfig

@@ -0,0 +1,13 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.gd]
+indent_style = tab
+indent_size = 4

.gitattributes

@@ -0,0 +1,5 @@
+# The add-on code in this repository is copied from
+# <https://github.com/godot-extended-libraries/godot-debug-menu> regularly.
+# Please open pull requests for the add-on code itself there, not in
+# this demo repository.
+/addons linguist-vendored

.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: fix-byte-order-marker
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+
+      - id: mixed-line-ending
+        args: [--fix=lf]

README.md

@@ -1,33 +1,47 @@
-# Godot Debug Menu
-
-Displays performance information in a Godot project during gameplay. Inspired by
-id Tech 6/7's performance overlay.
-
-## Why use this debug menu?
-
-- Compared to the Godot editor's Profiler, Monitors and Visual Profiler bottom
-  panels, you can look at an in-game debug menu while the project is running,
-  even in fullscreen if you only have a single monitor.
-    - Rendering performance is highly dependent on window size, so resizing the
-      window is not advised for reliable performance measurements in real world
-      scenarios.
-- This debug menu accurately displays graphs and best/worst frametime metrics
-  over a period of the last 150 rendered frames, which is useful to diagnose
-  stuttering issues. The Monitor bottom panel is only updated once a second and
-  doesn't feature a 1% low FPS metric, which makes tracking stuttering
-  difficult when relying solely on the monitors.
-- This debug menu can be used in exported projects to reliably test performance
-  without any editor interference. This includes testing on mobile and Web
-  platforms, which tend to be more difficult to set up for profiling within
-  Godot (if it's even possible).
-- This debug menu can be used in exported projects for tech support purposes.
-  For example, in a bug report, you could ask a player to upload screenshots
-  with the debug menu visible to troubleshoot performance issues.
-
-External tools such as RTSS or [MangoHud](https://github.com/flightlessmango/MangoHud)
-provide some insight on how well a project actually runs. However, they lack
-information on engine-specific things such as per-frame CPU/GPU time and
-graphics settings.
+# 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 <kbd>F5</kbd>.
 
 ## License
 

addons/debug_menu/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright © 2023-present Hugo Locurcio and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

debug_menu.gd renamed to addons/debug_menu/debug_menu.gd

@@ -1,6 +1,5 @@
 extends Control
 
-
 @export var fps: Label
 @export var frame_time: Label
 @export var frame_number: Label
@@ -110,12 +109,19 @@ func _ready() -> void:
 	update_information_label()
 	update_settings_label()
 
-func _input(event):
-	if event.is_action_pressed(&"cycle_debug_menu"):
+
+func _input(event: InputEvent) -> void:
+	#if event.is_action_pressed(&"cycle_debug_menu"):
+	if Input.is_key_pressed(KEY_F3):
 		style = wrapi(style + 1, 0, Style.MAX) as Style
 
+
 ## Update hardware information label (this can change at runtime based on window size and graphics settings).
 func update_settings_label() -> void:
+	settings.text = ""
+	if ProjectSettings.has_setting("application/config/version"):
+		settings.text += "Project Version: %s\n" % ProjectSettings.get_setting("application/config/version")
+
 	var rendering_method_string := ""
 	match str(ProjectSettings.get_setting("rendering/renderer/rendering_method")):
 		"forward_plus":
@@ -124,7 +130,7 @@ func update_settings_label() -> void:
 			rendering_method_string = "Forward Mobile"
 		"gl_compatibility":
 			rendering_method_string = "Compatibility"
-	settings.text = "Rendering Method: %s\n" % rendering_method_string
+	settings.text += "Rendering Method: %s\n" % rendering_method_string
 
 	var viewport := get_viewport()
 

debug_menu.tscn renamed to addons/debug_menu/debug_menu.tscn

@@ -1,6 +1,6 @@
-[gd_scene load_steps=3 format=3 uid="uid://bg41amwjmcapd"]
+[gd_scene load_steps=3 format=3 uid="uid://cggqb75a8w8r"]
 
-[ext_resource type="Script" path="res://debug_menu.gd" id="1_g6ocd"]
+[ext_resource type="Script" path="res://addons/debug_menu/debug_menu.gd" id="1_p440y"]
 
 [sub_resource type="StyleBoxFlat" id="StyleBoxFlat_ki0n8"]
 bg_color = Color(0, 0, 0, 0.25098)
@@ -18,7 +18,7 @@ offset_bottom = 408.0
 grow_horizontal = 0
 size_flags_horizontal = 8
 size_flags_vertical = 4
-script = ExtResource("1_g6ocd")
+script = ExtResource("1_p440y")
 fps = NodePath("VBoxContainer/FPS")
 frame_time = NodePath("VBoxContainer/FrameTime")
 frame_number = NodePath("VBoxContainer/FrameNumber")
@@ -369,7 +369,8 @@ layout_mode = 2
 theme_override_colors/font_outline_color = Color(0, 0, 0, 1)
 theme_override_constants/outline_size = 3
 theme_override_font_sizes/font_size = 12
-text = "Rendering Method: Forward+
+text = "Project Version: 1.2.3
+Rendering Method: Forward+
 Window: 1234×567, Viewport: 1234×567
 3D Scale (FSR 1.0): 100% = 1234×567
 3D Antialiasing: TAA + 2× MSAA + FXAA

addons/debug_menu/plugin.cfg

@@ -0,0 +1,7 @@
+[plugin]
+
+name="Debug Menu"
+description="In-game debug menu displaying performance metrics and hardware information"
+author="Calinou"
+version="1.0.0"
+script="plugin.gd"

addons/debug_menu/plugin.gd

@@ -0,0 +1,29 @@
+@tool
+extends EditorPlugin
+
+func _enter_tree() -> void:
+	add_autoload_singleton("DebugMenu", "res://addons/debug_menu/debug_menu.tscn")
+
+	# FIXME: This appears to do nothing.
+#	if not ProjectSettings.has_setting("application/config/version"):
+#		ProjectSettings.set_setting("application/config/version", "1.0.0")
+#
+#	ProjectSettings.set_initial_value("application/config/version", "1.0.0")
+#	ProjectSettings.add_property_info({
+#		name = "application/config/version",
+#		type = TYPE_STRING,
+#	})
+#
+#	if not InputMap.has_action("cycle_debug_menu"):
+#		InputMap.add_action("cycle_debug_menu")
+#		var event := InputEventKey.new()
+#		event.keycode = KEY_F3
+#		InputMap.action_add_event("cycle_debug_menu", event)
+#
+#	ProjectSettings.save()
+
+
+func _exit_tree() -> void:
+	remove_autoload_singleton("DebugMenu")
+	# Don't remove the project setting's value and input map action,
+	# as the plugin may be re-enabled in the future.