Merge pull request #379 from Maaack/add-update-autoload-paths-option

Add update autoload paths option

Author: Maaack

addons/maaacks_game_template/docs/NewProject.md

@@ -10,7 +10,11 @@ These instructions assume starting with the entire contents of the project folde
         2.  In the `Setup Wizard` window next to "Delete Example Files", click `Run`.
         3.  In the next window, select `Yes` to continue with removing the example files.
 
-    2.  Set a default theme.
+    2.  Update autoload file paths.
+        1.  Go to `Project > Tools > Run Maaack's Game Template Setup...`.
+        2.  In the `Setup Wizard` window next to "Update Autoload Paths", click `Run`.
+
+    3.  Set a default theme.
         1.  Go to `Project > Tools > Run Maaack's Game Template Setup...`.
         2.  In the `Setup Wizard` window next to "Set the Default Theme", click `Run`.
         3.  In the next window, select the desired theme from the preview and select `Yes` to set it as the project's default theme.

addons/maaacks_game_template/installer/setup_wizard.gd

@@ -12,6 +12,8 @@ extends AcceptDialog
 @onready var copy_button : Button = %CopyButton
 @onready var delete_check_box : CheckBox = %DeleteCheckBox
 @onready var delete_button : Button = %DeleteButton
+@onready var update_paths_check_box : CheckBox = %UpdatePathsCheckBox
+@onready var update_paths_button : Button = %UpdatePathsButton
 @onready var set_main_scene_check_box : CheckBox = %SetMainSceneCheckBox
 @onready var set_main_scene_button : Button = %SetMainSceneButton
 @onready var set_default_theme_check_box : CheckBox = %SetDefaultThemeCheckBox
@@ -65,6 +67,10 @@ func _refresh_copy_and_delete_examples() -> void:
 	else:
 		delete_check_box.button_pressed = true
 
+func _refresh_update_autoload_paths() -> void:
+	update_paths_check_box.button_pressed = MaaacksGameTemplatePlugin.instance.are_autoload_paths_updated()
+	update_paths_button.disabled = false
+
 func _refresh_main_scene() -> void:
 	if MaaacksGameTemplatePlugin.instance.is_main_scene_set():
 		set_main_scene_check_box.button_pressed = true
@@ -88,6 +94,7 @@ func _refresh_options():
 	_refresh_plugin_details()
 	_open_check_plugin_version()
 	_refresh_copy_and_delete_examples()
+	_refresh_update_autoload_paths()
 	_refresh_main_scene()
 	_refresh_default_theme()
 	_refresh_input_prompts()
@@ -112,6 +119,13 @@ func _on_delete_button_pressed():
 	tree_exited.connect(func(): MaaacksGameTemplatePlugin.instance.open_delete_examples_short_confirmation_dialog())
 	queue_free()
 
+func _on_update_paths_button_pressed():
+	MaaacksGameTemplatePlugin.instance.update_autoload_paths(MaaacksGameTemplatePlugin.get_copy_path())
+	_refresh_update_autoload_paths()
+	update_paths_button.disabled = true
+	await get_tree().create_timer(1.0).timeout
+	update_paths_button.disabled = false
+
 func _on_set_main_scene_button_pressed():
 	tree_exited.connect(func(): MaaacksGameTemplatePlugin.instance.open_main_scene_confirmation_dialog(MaaacksGameTemplatePlugin.get_copy_path()))
 	queue_free()

addons/maaacks_game_template/installer/setup_wizard.tscn

@@ -3,6 +3,7 @@
 [ext_resource type="Script" uid="uid://coq26stqrim51" path="res://addons/maaacks_game_template/installer/setup_wizard.gd" id="1_jck5m"]
 
 [node name="SetupWizardDialog" type="AcceptDialog"]
+oversampling_override = 1.0
 title = "Setup Wizard"
 initial_position = 2
 size = Vector2i(576, 540)
@@ -93,6 +94,23 @@ layout_mode = 2
 disabled = true
 text = "Run"
 
+[node name="UpdatePathsLabel" type="Label" parent="VBoxContainer/StepsContainer"]
+layout_mode = 2
+size_flags_horizontal = 3
+text = "Update Autoload Paths"
+
+[node name="UpdatePathsCheckBox" type="CheckBox" parent="VBoxContainer/StepsContainer"]
+unique_name_in_owner = true
+layout_mode = 2
+disabled = true
+
+[node name="UpdatePathsButton" type="Button" parent="VBoxContainer/StepsContainer"]
+unique_name_in_owner = true
+custom_minimum_size = Vector2(100, 0)
+layout_mode = 2
+disabled = true
+text = "Run"
+
 [node name="SetMainSceneLabel" type="Label" parent="VBoxContainer/StepsContainer"]
 layout_mode = 2
 size_flags_horizontal = 3
@@ -147,6 +165,7 @@ text = "Run"
 [connection signal="pressed" from="VBoxContainer/StepsContainer/UpdateButton" to="." method="_on_update_button_pressed"]
 [connection signal="pressed" from="VBoxContainer/StepsContainer/CopyButton" to="." method="_on_copy_button_pressed"]
 [connection signal="pressed" from="VBoxContainer/StepsContainer/DeleteButton" to="." method="_on_delete_button_pressed"]
+[connection signal="pressed" from="VBoxContainer/StepsContainer/UpdatePathsButton" to="." method="_on_update_paths_button_pressed"]
 [connection signal="pressed" from="VBoxContainer/StepsContainer/SetMainSceneButton" to="." method="_on_set_main_scene_button_pressed"]
 [connection signal="pressed" from="VBoxContainer/StepsContainer/SetDefaultThemeButton" to="." method="_on_set_default_theme_button_pressed"]
 [connection signal="pressed" from="VBoxContainer/StepsContainer/AddInputIconsButton" to="." method="_on_add_input_icons_button_pressed"]

addons/maaacks_game_template/maaacks_game_template.gd

@@ -42,6 +42,9 @@ static func get_plugin_examples_path() -> String:
 static func get_app_config_path() -> String:
 	return get_plugin_path() + APP_CONFIG_RELATIVE_PATH
 
+static func get_scene_loader_path() -> String:
+	return get_plugin_path() + SCENE_LOADER_RELATIVE_PATH
+
 static func get_copy_path() -> String:
 	var copy_path = ProjectSettings.get_setting(PROJECT_SETTINGS_PATH + "copy_path", get_plugin_examples_path())
 	if not copy_path.ends_with("/"):
@@ -192,18 +195,18 @@ func _update_app_config_paths(target_path : String) -> void:
 		]
 	for prefix in prefixes:
 		prefix += " = \""
-		var target_string =  prefix + get_plugin_examples_path()
+		var target_string = prefix + get_plugin_examples_path()
 		var replacing_string = prefix + target_path
 		file_text = file_text.replace(target_string, replacing_string)
 	var file = FileAccess.open(file_path, FileAccess.WRITE)
 	file.store_string(file_text)
 	file.close()
 
 func _update_scene_loader_path(target_path : String) -> void:
-	var file_path : String = get_plugin_path() + SCENE_LOADER_RELATIVE_PATH
+	var file_path : String = get_scene_loader_path()
 	var file_text : String = FileAccess.get_file_as_string(file_path)
 	var prefix : String = "loading_screen_path = \""
-	var target_string =  prefix + get_plugin_path() + "base/"
+	var target_string = prefix + get_plugin_path() + "base/"
 	var replacing_string = prefix + target_path
 	file_text = file_text.replace(target_string, replacing_string)
 	var file = FileAccess.open(file_path, FileAccess.WRITE)
@@ -219,11 +222,29 @@ func _add_translations() -> void:
 			translations.append(translation_path)
 	ProjectSettings.set_setting("internationalization/locale/translations", translations)
 
+func _is_app_config_path_updated(target_path) -> bool:
+	var file_text : String = FileAccess.get_file_as_string(get_app_config_path())
+	var target_string = "main_menu_scene_path = \"" + get_plugin_examples_path()
+	return !file_text.contains(target_string)
+
+func _is_scene_loader_path_updated(target_path) -> bool:
+	var file_text : String = FileAccess.get_file_as_string(get_scene_loader_path())
+	var target_string = "loading_screen_path = \"" + get_plugin_path() + "base/"
+	return !file_text.contains(target_string)
+
+func are_autoload_paths_updated() -> bool:
+	var copy_path := get_copy_path()
+	if copy_path == get_plugin_examples_path(): return false
+	return _is_app_config_path_updated(copy_path) and _is_scene_loader_path_updated(copy_path)
+
+func update_autoload_paths(target_path : String) -> void:
+	_update_app_config_paths(target_path)
+	_update_scene_loader_path(target_path)
+
 func _on_completed_copy_to_directory(target_path : String) -> void:
 	ProjectSettings.set_setting(PROJECT_SETTINGS_PATH + "copy_path", target_path)
 	ProjectSettings.save()
-	_update_app_config_paths(target_path)
-	_update_scene_loader_path(target_path)
+	update_autoload_paths(target_path)
 	_copy_override_file()
 	_open_play_opening_confirmation_dialog(target_path)