Add a custom logging demo

This demo showcases a custom logger implementation, which runs in parallel
to the built-in logging facilities (including file logging). The custom logger
displays all messages printed by the engine in an in-game console.

Author: Calinou

misc/custom_logging/JetBrainsMono-Bold.woff2

@@ -0,0 +1,36 @@
+[remap]
+
+importer="font_data_dynamic"
+type="FontFile"
+uid="uid://g800tr1mba1m"
+path="res://.godot/imported/JetBrainsMono-Bold.woff2-90b8bb02e1d6b1e6d33bf7df4e6cecb8.fontdata"
+
+[deps]
+
+source_file="res://JetBrainsMono-Bold.woff2"
+dest_files=["res://.godot/imported/JetBrainsMono-Bold.woff2-90b8bb02e1d6b1e6d33bf7df4e6cecb8.fontdata"]
+
+[params]
+
+Rendering=null
+antialiasing=1
+generate_mipmaps=false
+disable_embedded_bitmaps=true
+multichannel_signed_distance_field=false
+msdf_pixel_range=8
+msdf_size=48
+allow_system_fallback=true
+force_autohinter=false
+modulate_color_glyphs=false
+hinting=1
+subpixel_positioning=4
+keep_rounding_remainders=true
+oversampling=0.0
+Fallbacks=null
+fallbacks=[]
+Compress=null
+compress=true
+preload=[]
+language_support={}
+script_support={}
+opentype_features={}

misc/custom_logging/JetBrainsMono-Bold.woff2.import

@@ -0,0 +1,36 @@
+[remap]
+
+importer="font_data_dynamic"
+type="FontFile"
+uid="uid://jrduhl6723o1"
+path="res://.godot/imported/JetBrainsMono-Regular.woff2-7c9f8b67058abc1b94f68d1d046bf79f.fontdata"
+
+[deps]
+
+source_file="res://JetBrainsMono-Regular.woff2"
+dest_files=["res://.godot/imported/JetBrainsMono-Regular.woff2-7c9f8b67058abc1b94f68d1d046bf79f.fontdata"]
+
+[params]
+
+Rendering=null
+antialiasing=1
+generate_mipmaps=false
+disable_embedded_bitmaps=true
+multichannel_signed_distance_field=false
+msdf_pixel_range=8
+msdf_size=48
+allow_system_fallback=true
+force_autohinter=false
+modulate_color_glyphs=false
+hinting=1
+subpixel_positioning=4
+keep_rounding_remainders=true
+oversampling=0.0
+Fallbacks=null
+fallbacks=[]
+Compress=null
+compress=true
+preload=[]
+language_support={}
+script_support={}
+opentype_features={}

misc/custom_logging/JetBrainsMono-Regular.woff2

@@ -0,0 +1,17 @@
+# Custom Logging
+
+This demo showcases a custom logger implementation, which runs in parallel
+to the built-in logging facilities (including file logging). The custom logger
+displays all messages printed by the engine in an in-game console.
+
+See [Logging](https://docs.godotengine.org/en/latest/tutorials/scripting/logging.html)
+in the documentation for more information about configuring the engine's logging
+and writing custom loggers.
+
+Language: GDScript
+
+Renderer: Compatibility
+
+## Screenshots
+
+![Screenshot](screenshots/custom_logging.webp)

misc/custom_logging/JetBrainsMono-Regular.woff2.import

@@ -0,0 +1,56 @@
+extends RichTextLabel
+
+
+class CustomLogger extends Logger:
+	func _log_message(message: String, _error: bool) -> void:
+		CustomLoggerUI.get_node("Panel/RichTextLabel").text += message
+
+
+	func _log_error(
+			function: String,
+			file: String,
+			line: int,
+			code: String,
+			rationale: String,
+			_editor_notify: bool,
+			error_type: int,
+			script_backtraces: Array[ScriptBacktrace]
+	) -> void:
+		var prefix := ""
+		# The column at which to print the trace. Should match the length of the
+		# unformatted text above it.
+		var trace_indent := 0
+
+		match error_type:
+			ERROR_TYPE_ERROR:
+				prefix = "[color=#f54][b]ERROR:[/b]"
+				trace_indent = 6
+			ERROR_TYPE_WARNING:
+				prefix = "[color=#fd4][b]WARNING:[/b]"
+				trace_indent = 8
+			ERROR_TYPE_SCRIPT:
+				prefix = "[color=#f4f][b]SCRIPT ERROR:[/b]"
+				trace_indent = 13
+			ERROR_TYPE_SHADER:
+				prefix = "[color=#4bf][b]SHADER ERROR:[/b]"
+				trace_indent = 13
+
+		var trace := "%*s %s (%s:%s)" % [trace_indent, "at:", function, file, line]
+		var script_backtraces_text := ""
+		for backtrace in script_backtraces:
+			script_backtraces_text += backtrace.format(trace_indent - 3) + "\n"
+
+		CustomLoggerUI.get_node("Panel/RichTextLabel").text += "%s %s %s[/color]\n[color=#999]%s[/color]\n[color=#999]%s[/color]" % [
+			prefix,
+			code,
+			rationale,
+			trace,
+			script_backtraces_text,
+		]
+
+
+# Use `_init()` to initialize the logger as early as possible, which ensures that messages
+# printed early are taken into account. However, even when using `_init()`, the engine's own
+# initialization messages are not accessible.
+func _init() -> void:
+	OS.add_logger(CustomLogger.new())

misc/custom_logging/README.md

@@ -0,0 +1 @@
+uid://cgdbfnmbujg61

misc/custom_logging/custom_logger_ui.gd

@@ -0,0 +1,38 @@
+[gd_scene load_steps=5 format=3 uid="uid://cpdcq55mdqx5o"]
+
+[ext_resource type="FontFile" uid="uid://jrduhl6723o1" path="res://JetBrainsMono-Regular.woff2" id="1_c73ru"]
+[ext_resource type="FontFile" uid="uid://g800tr1mba1m" path="res://JetBrainsMono-Bold.woff2" id="2_nsaj1"]
+[ext_resource type="Script" uid="uid://cgdbfnmbujg61" path="res://custom_logger_ui.gd" id="3_5eal2"]
+
+[sub_resource type="StyleBoxFlat" id="StyleBoxFlat_c73ru"]
+content_margin_left = 20.0
+content_margin_top = 0.0
+content_margin_right = 0.0
+content_margin_bottom = 10.0
+bg_color = Color(0.1, 0.1, 0.1, 0.6)
+corner_radius_top_left = 3
+corner_radius_top_right = 3
+corner_radius_bottom_right = 3
+corner_radius_bottom_left = 3
+corner_detail = 5
+
+[node name="CanvasLayer" type="CanvasLayer"]
+layer = 1024
+
+[node name="Panel" type="PanelContainer" parent="."]
+anchors_preset = 15
+anchor_right = 1.0
+anchor_bottom = 1.0
+offset_bottom = -194.0
+grow_horizontal = 2
+grow_vertical = 2
+theme_override_styles/panel = SubResource("StyleBoxFlat_c73ru")
+
+[node name="RichTextLabel" type="RichTextLabel" parent="Panel"]
+layout_mode = 2
+theme_override_fonts/normal_font = ExtResource("1_c73ru")
+theme_override_fonts/bold_font = ExtResource("2_nsaj1")
+theme_override_fonts/mono_font = ExtResource("1_c73ru")
+bbcode_enabled = true
+scroll_following = true
+script = ExtResource("3_5eal2")

misc/custom_logging/custom_logger_ui.gd.uid

@@ -0,0 +1,58 @@
+extends Control
+
+var message_counter := 0
+var message_raw_counter := 0
+var message_stderr_counter := 0
+var warning_counter := 0
+var error_counter := 0
+
+
+func _ready() -> void:
+	print("Normal message 1.")
+	push_error("Error 1.")
+	push_warning("Warning 1.")
+	push_error("Error 2.")
+	push_warning("Warning 2.")
+	print("Normal message 2.")
+	printerr("Normal message 1 (stderr).")
+	printerr("Normal message 2 (stderr).")
+	printraw("Normal message 1 (raw). ")
+	printraw("Normal message 2 (raw).\n--------\n")
+
+	if bool(ProjectSettings.get_setting_with_override("application/run/flush_stdout_on_print")):
+		$FlushStdoutOnPrint.text = "Flush stdout on print: Yes (?)"
+	else:
+		$FlushStdoutOnPrint.text = "Flush stdout on print: No (?)"
+
+
+func _on_print_message_pressed() -> void:
+	message_counter += 1
+	print("Printing message #%d." % message_counter)
+
+
+func _on_print_message_raw_pressed() -> void:
+	message_raw_counter += 1
+	printraw("Printing message #%d (raw). " % message_raw_counter)
+
+
+func _on_print_message_stderr_pressed() -> void:
+	message_stderr_counter += 1
+	printerr("Printing message #%d (stderr)." % message_stderr_counter)
+
+
+func _on_print_warning_pressed() -> void:
+	warning_counter += 1
+	push_warning("Printing warning #%d." % warning_counter)
+
+
+func _on_print_error_pressed() -> void:
+	error_counter += 1
+	push_error("Printing error #%d." % error_counter)
+
+
+func _on_open_logs_folder_pressed() -> void:
+	OS.shell_open(ProjectSettings.globalize_path(String(ProjectSettings.get_setting_with_override("debug/file_logging/log_path")).get_base_dir()))
+
+
+func _on_crash_engine_pressed() -> void:
+	OS.crash("Crashing the engine on user request (the Crash Engine button was pressed). Do not report this as a bug.")

misc/custom_logging/custom_logger_ui.tscn

@@ -0,0 +1 @@
+uid://715k1racyrfh