Merge pull request #67 from Maaack/updates-from-game-template

Maaack · web-flow · commit 247d2bab9b30 · 2025-09-17T20:48:18.000-04:00
Updates from game template
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 # Godot Menus Template
-For Godot 4.4 (4.3+ compatible)
+For Godot 4.5 (4.3+ compatible)
 
 This template has a main menu, options menus, credits, and a scene loader.
 
@@ -132,6 +132,7 @@ These instructions assume starting with just the contents of `addons/`. This wil
 [Loading Scenes](/addons/maaacks_menus_template/docs/LoadingScenes.md)  
 [Input Icon Mapping](/addons/maaacks_menus_template/docs/InputIconMapping.md)  
 [Joypad Inputs](/addons/maaacks_menus_template/docs/JoypadInputs.md)  
+[Blending Music](/addons/maaacks_menus_template/docs/BlendingMusic.md)  
 [Add Custom Options](/addons/maaacks_menus_template/docs/AddingCustomOptions.md)  
 [How Parts Work](/addons/maaacks_menus_template/docs/HowPartsWork.md)  
 [Automatic Updating](/addons/maaacks_menus_template/docs/AutomaticUpdating.md)  
diff --git a/addons/maaacks_menus_template/README.md b/addons/maaacks_menus_template/README.md
@@ -1,5 +1,5 @@
 # Godot Menus Template
-For Godot 4.4 (4.3+ compatible)
+For Godot 4.5 (4.3+ compatible)
 
 This template has a main menu, options menus, credits, and a scene loader.
 
@@ -132,6 +132,7 @@ These instructions assume starting with just the contents of `addons/`. This wil
 [Loading Scenes](/addons/maaacks_menus_template/docs/LoadingScenes.md)  
 [Input Icon Mapping](/addons/maaacks_menus_template/docs/InputIconMapping.md)  
 [Joypad Inputs](/addons/maaacks_menus_template/docs/JoypadInputs.md)  
+[Blending Music](/addons/maaacks_menus_template/docs/BlendingMusic.md)  
 [Add Custom Options](/addons/maaacks_menus_template/docs/AddingCustomOptions.md)  
 [How Parts Work](/addons/maaacks_menus_template/docs/HowPartsWork.md)  
 [Automatic Updating](/addons/maaacks_menus_template/docs/AutomaticUpdating.md)  
diff --git a/addons/maaacks_menus_template/base/scripts/player_config.gd b/addons/maaacks_menus_template/base/scripts/player_config.gd
@@ -7,9 +7,6 @@ const CONFIG_FILE_LOCATION := "user://player_config.cfg"
 
 static var config_file : ConfigFile
 
-static func _init() -> void:
-	load_config_file()
-
 static func _save_config_file() -> void:
 	var save_error : int = config_file.save(CONFIG_FILE_LOCATION)
 	if save_error:
diff --git a/addons/maaacks_menus_template/docs/BlendingMusic.md b/addons/maaacks_menus_template/docs/BlendingMusic.md
@@ -0,0 +1,42 @@
+# Blending Music Between Scenes
+
+This page covers the `ProjectMusicController`, which is used to blend music in between scenes, that would otherwise abruptly stop the music when they get unloaded.
+
+## Setup
+
+1.  Verify the `Music` audio bus.
+
+    1.  Open the Audio bus editor.
+    2.  Confirm that `Music` audio bus is available.
+        1.  If the last bus is `New Bus`, try restarting the editor and checking again.
+    3.  If the audio bus doesn't exist, add it and save the project.
+
+2.  Verify the `ProjectMusicController` autoload.
+
+    1.  Open the Project Settings.
+    2.  Open the `Globals` tab.
+    3.  Confirm that the `ProjectMusicController` is listed as an autoload.
+
+3.  Setup music blending between scenes.
+
+    1.  Open up the `project_music_controller.tscn` scene.
+    2.  Inspect the root node of the scene tree (`ProjectMusicController`).
+    3.  Confirm that the `audio_bus` is set to `Music`.
+    4.  Expand the `Blending` variable group.
+    5.  Set a `fade_out_duration` or `fade_in_duration`, in seconds.
+
+4.  Add background music to your scenes.
+
+    1.  Import the music asset into the project.
+    2.  Add a `BackgroundMusicPlayer`.
+    3.  Assign the music asset to the `stream` property.
+    4.  Make sure that the `bus` property is set to `Music` and `autoplay` is `true`.
+    5.  Save the scene.
+
+## Internal Details 
+
+When a background music player is about to exit the scene tree, it gets reparented to the autoload node. This allows it to continue playing until the next scene is ready and a new background music player is detected. If the audio stream players share the same stream, then the controller will seek the next player to the same position on the stream, before removing the previous one. If a different stream is detected and a fade out duration is set, then the previous player will blend into the next one, by having its volume lowered to zero over the fade out duration.
+
+The autload adds the "BlendMusic" audio bus is added at runtime. If a fade in duration is set, then the temporary bus is used to combine the increasing volume of the player with any other animations local to the scene.
+
+The autoload will work with any `AudioStreamPlayer` with `bus` set to `Music` and `autoplay` set to `true`. These are detected up as they enter the scene tree. To dynamically add an `AudioStreamPlayer` to the background music, call `ProjectMusicController.play_stream(background_music_player)`.
diff --git a/addons/maaacks_menus_template/examples/scenes/end_credits/end_credits.gd b/addons/maaacks_menus_template/examples/scenes/end_credits/end_credits.gd
@@ -4,37 +4,49 @@ extends ScrollingCredits
 ## This option forces the mouse to be visible when the menu shows up.
 ## Useful for games that capture the mouse, and don't automatically return it.
 @export var force_mouse_mode_visible : bool = false
+
+@onready var end_message_panel = %EndMessagePanel
+@onready var exit_button = %ExitButton
+@onready var menu_button = %MenuButton
 @onready var init_mouse_filter : MouseFilter = mouse_filter
 
 func _on_scroll_container_end_reached() -> void:
-	%EndMessagePanel.show()
+	end_message_panel.show()
 	mouse_filter = Control.MOUSE_FILTER_STOP
 	if force_mouse_mode_visible:
 		Input.mouse_mode = Input.MOUSE_MODE_VISIBLE
 	super._on_scroll_container_end_reached()
 
-func _on_MenuButton_pressed() -> void:
+func load_main_menu() -> void:
 	SceneLoader.load_scene(main_menu_scene)
 
-func _on_ExitButton_pressed() -> void:
+func exit_game() -> void:
+	if OS.has_feature("web"):
+		load_main_menu()
 	get_tree().quit()
 
 func _on_visibility_changed() -> void:
 	if visible:
-		%EndMessagePanel.hide()
+		end_message_panel.hide()
 		mouse_filter = init_mouse_filter
 
 func _ready() -> void:
 	visibility_changed.connect(_on_visibility_changed)
 	if main_menu_scene.is_empty():
-		%MenuButton.hide()
+		menu_button.hide()
 	if OS.has_feature("web"):
-		%ExitButton.hide()
+		exit_button.hide()
 	super._ready()
 
 func _unhandled_input(event : InputEvent) -> void:
-	if event.is_action_pressed("ui_cancel"):
-		if not %EndMessagePanel.visible:
+	if event.is_action_released("ui_cancel"):
+		if not end_message_panel.visible:
 			_on_scroll_container_end_reached()
 		else:
-			get_tree().quit()
+			exit_game()
+
+func _on_exit_button_pressed():
+	exit_game()
+
+func _on_menu_button_pressed():
+	load_main_menu()
diff --git a/addons/maaacks_menus_template/examples/scenes/end_credits/end_credits.tscn b/addons/maaacks_menus_template/examples/scenes/end_credits/end_credits.tscn
@@ -87,5 +87,5 @@ size_flags_horizontal = 3
 size_flags_vertical = 3
 text = "Menu"
 
-[connection signal="pressed" from="CenterContainer/EndMessagePanel/VBoxContainer/CenterContainer/HBoxContainer/ExitButton" to="." method="_on_ExitButton_pressed"]
-[connection signal="pressed" from="CenterContainer/EndMessagePanel/VBoxContainer/CenterContainer/HBoxContainer/MenuButton" to="." method="_on_MenuButton_pressed"]
+[connection signal="pressed" from="CenterContainer/EndMessagePanel/VBoxContainer/CenterContainer/HBoxContainer/ExitButton" to="." method="_on_exit_button_pressed"]
+[connection signal="pressed" from="CenterContainer/EndMessagePanel/VBoxContainer/CenterContainer/HBoxContainer/MenuButton" to="." method="_on_menu_button_pressed"]
diff --git a/addons/maaacks_menus_template/plugin.cfg b/addons/maaacks_menus_template/plugin.cfg
@@ -5,5 +5,5 @@ description="Template with main menu, options menu, credits, and a scene loader.
 
 Created in collaboration with members of the Godot Wild Jam community."
 author="Marek Belski"
-version="1.2.0"
+version="1.2.1"
 script="maaacks_menus_template.gd"
diff --git a/scenes/end_credits/end_credits.gd b/scenes/end_credits/end_credits.gd
@@ -4,37 +4,49 @@ extends ScrollingCredits
 ## This option forces the mouse to be visible when the menu shows up.
 ## Useful for games that capture the mouse, and don't automatically return it.
 @export var force_mouse_mode_visible : bool = false
+
+@onready var end_message_panel = %EndMessagePanel
+@onready var exit_button = %ExitButton
+@onready var menu_button = %MenuButton
 @onready var init_mouse_filter : MouseFilter = mouse_filter
 
 func _on_scroll_container_end_reached() -> void:
-	%EndMessagePanel.show()
+	end_message_panel.show()
 	mouse_filter = Control.MOUSE_FILTER_STOP
 	if force_mouse_mode_visible:
 		Input.mouse_mode = Input.MOUSE_MODE_VISIBLE
 	super._on_scroll_container_end_reached()
 
-func _on_MenuButton_pressed() -> void:
+func load_main_menu() -> void:
 	SceneLoader.load_scene(main_menu_scene)
 
-func _on_ExitButton_pressed() -> void:
+func exit_game() -> void:
+	if OS.has_feature("web"):
+		load_main_menu()
 	get_tree().quit()
 
 func _on_visibility_changed() -> void:
 	if visible:
-		%EndMessagePanel.hide()
+		end_message_panel.hide()
 		mouse_filter = init_mouse_filter
 
 func _ready() -> void:
 	visibility_changed.connect(_on_visibility_changed)
 	if main_menu_scene.is_empty():
-		%MenuButton.hide()
+		menu_button.hide()
 	if OS.has_feature("web"):
-		%ExitButton.hide()
+		exit_button.hide()
 	super._ready()
 
 func _unhandled_input(event : InputEvent) -> void:
-	if event.is_action_pressed("ui_cancel"):
-		if not %EndMessagePanel.visible:
+	if event.is_action_released("ui_cancel"):
+		if not end_message_panel.visible:
 			_on_scroll_container_end_reached()
 		else:
-			get_tree().quit()
+			exit_game()
+
+func _on_exit_button_pressed():
+	exit_game()
+
+func _on_menu_button_pressed():
+	load_main_menu()
diff --git a/scenes/end_credits/end_credits.tscn b/scenes/end_credits/end_credits.tscn
@@ -87,5 +87,5 @@ size_flags_horizontal = 3
 size_flags_vertical = 3
 text = "Menu"
 
-[connection signal="pressed" from="CenterContainer/EndMessagePanel/VBoxContainer/CenterContainer/HBoxContainer/ExitButton" to="." method="_on_ExitButton_pressed"]
-[connection signal="pressed" from="CenterContainer/EndMessagePanel/VBoxContainer/CenterContainer/HBoxContainer/MenuButton" to="." method="_on_MenuButton_pressed"]
+[connection signal="pressed" from="CenterContainer/EndMessagePanel/VBoxContainer/CenterContainer/HBoxContainer/ExitButton" to="." method="_on_exit_button_pressed"]
+[connection signal="pressed" from="CenterContainer/EndMessagePanel/VBoxContainer/CenterContainer/HBoxContainer/MenuButton" to="." method="_on_menu_button_pressed"]
