Refactor

README.md

@@ -20,15 +20,15 @@ This plugin simplifies the process of importing and retargeting Mixamo animation
 1. Import your Mixamo FBX file(s) into your Godot project using ufbx.
 2. In the FileSystem dock, right-click on the FBX file(s) you want to retarget.
 3. Select "Retarget Mixamo Animation" from the context menu.
-4. Choose a destination folder for the exported animation(s).
+4. Retargeted animations will be saved in the same folder as original FBX files.
 5. The plugin will automatically update the import settings, retarget the animation(s), and save them as .res files in the specified folder.
 6. Ensure your character model has a Skeleton3D node named "Skeleton" for the exported animations to work correctly. 
 7. Ensure your Character Skeleton is also retargeted using Bone Mapping. This ensures both the animation and the skeleton will share the same bone names.
 8. Add the exported .res files to an AnimationLibrary and you should be able to play the animations in your scene.
 
 ## Requirements
 
-- Godot 4.3
+- Godot 4.3+
 
 ## Configuration
 

addons/mixamo_animation_retargeter/context_menu.gd

@@ -0,0 +1,86 @@
+@tool
+extends EditorContextMenuPlugin
+
+
+const ICON = preload("res://addons/mixamo_animation_retargeter/icon.png")
+
+
+func _popup_menu(paths: PackedStringArray) -> void:
+	if not _validate_paths(paths):
+		return
+
+	add_context_menu_item("Retarget Mixamo Animations", _retarget, ICON)
+
+
+func _retarget(paths: Array) -> void:
+	for path: String in paths:
+		if path.get_extension() == "fbx":
+			_process_fbx_file(path)
+
+
+func _validate_paths(paths: Array) -> bool:
+	for path: String in paths:
+		if path.get_extension() == "fbx":
+			return true
+
+	return false
+
+
+func _process_fbx_file(fbx_path: String) -> void:
+	var dir_path: String = fbx_path.get_base_dir()
+	print("Exporting animations from ", fbx_path)
+
+	var import_file_path: String = fbx_path + ".import"
+	var config := ConfigFile.new()
+	var err := config.load(import_file_path)
+	if err == OK:
+		var subresources: Dictionary = config.get_value("params", "_subresources", {})
+		if "nodes" not in subresources:
+			subresources["nodes"] = {}
+		if "PATH:Skeleton3D" not in subresources["nodes"]:
+			subresources["nodes"]["PATH:Skeleton3D"] = {}
+
+		# Update the specific settings for Skeleton3D
+		subresources["nodes"]["PATH:Skeleton3D"]["retarget/bone_map"] = load("res://addons/mixamo_animation_retargeter/mixamo_bone_map.tres")
+		subresources["nodes"]["PATH:Skeleton3D"]["retarget/bone_renamer/unique_node/skeleton_name"] = "Skeleton"
+		subresources["nodes"]["PATH:Skeleton3D"]["retarget/remove_tracks/unmapped_bones"] = true
+
+		# Add or update the animations section
+		if not "animations" in subresources:
+			subresources["animations"] = {}
+		if not "mixamo_com" in subresources["animations"]:
+			subresources["animations"]["mixamo_com"] = {}
+
+		# Get the FBX file name and convert it to snake case
+		var fbx_file_name = fbx_path.get_file().get_basename()
+		var snake_case_name = fbx_file_name.to_snake_case()
+
+		# Create the relative path (already starts with res://)
+		var relative_res_path = dir_path.path_join(snake_case_name + ".res")
+
+		# Update the save to file settings for mixamo_com animation
+		subresources["animations"]["mixamo_com"]["save_to_file/enabled"] = true
+		subresources["animations"]["mixamo_com"]["save_to_file/keep_custom_tracks"] = ""
+		subresources["animations"]["mixamo_com"]["save_to_file/path"] = relative_res_path
+		subresources["animations"]["mixamo_com"]["settings/loop_mode"] = 0
+
+		# Save the updated subresources back to the config
+		config.set_value("params", "_subresources", subresources)
+
+		# Save the changes to the .import file
+		err = config.save(import_file_path)
+		if err == OK:
+			print("Import settings updated successfully for ", fbx_path)
+			# Trigger reimport immediately after saving
+			_trigger_reimport(fbx_path)
+		else:
+			print("Failed to save import settings for ", fbx_path)
+	else:
+		print("Failed to load import file for editing: ", fbx_path)
+
+
+func _trigger_reimport(fbx_path: String) -> void:
+	# Trigger reimport of the FBX file
+	var file_system = EditorInterface.get_resource_filesystem()
+	file_system.reimport_files([fbx_path])
+	print("Triggered reimport of FBX file")

addons/mixamo_animation_retargeter/mixamo_animation_retargeter.gd

@@ -1,211 +1,16 @@
 @tool
 extends EditorPlugin
 
-var filesystem = get_editor_interface().get_resource_filesystem()
 
-var popupFilesystem : PopupMenu
+var context_menu_plugin_instance: EditorContextMenuPlugin
 
-var retarget_menu_id = 10002
 
-func _enter_tree():
-    FindFilesystemPopup()
+func _enter_tree() -> void:
+	context_menu_plugin_instance = preload("res://addons/mixamo_animation_retargeter/context_menu.gd").new()
+	add_context_menu_plugin(EditorContextMenuPlugin.CONTEXT_SLOT_FILESYSTEM, context_menu_plugin_instance)
+	print("Mixamo Animation Retargeter loaded.")
 
-func _exit_tree():
-    if popupFilesystem:
-        popupFilesystem.disconnect("about_to_popup", Callable(self, "AddItemToPopup"))
-        popupFilesystem.disconnect("id_pressed", Callable(self, "RetargetMixamoAnimation"))
 
-func FindFilesystemPopup():
-    var file_system:FileSystemDock = get_editor_interface().get_file_system_dock()
-
-    for child in file_system.get_children():
-        var pop:PopupMenu = child as PopupMenu
-        if not pop: continue
-
-        popupFilesystem = pop
-        popupFilesystem.connect("about_to_popup", Callable(self, "AddItemToPopup"))
-        popupFilesystem.connect("id_pressed", Callable(self, "RetargetMixamoAnimation"))
-
-func AddItemToPopup():
-    popupFilesystem.add_separator("Mixamo Animation Retargeter")
-    popupFilesystem.add_item("Retarget Mixamo Animation(s)", retarget_menu_id)
-
-func RetargetMixamoAnimation(id : int):
-    if id == retarget_menu_id:
-        var selected_paths = get_selected_paths(get_filesystem_tree(self))
-        var fbx_files = selected_paths.filter(func(path): return path.ends_with(".fbx"))
-        if fbx_files.size() > 0:
-            _show_save_dialog(fbx_files)
-
-func _show_save_dialog(fbx_paths: Array) -> void:
-    var file_dialog = EditorFileDialog.new()
-    file_dialog.file_mode = EditorFileDialog.FILE_MODE_OPEN_DIR
-    file_dialog.access = EditorFileDialog.ACCESS_RESOURCES
-    file_dialog.title = "Select Export Folder for Animations"
-
-    file_dialog.connect("dir_selected", Callable(self, "_on_export_folder_selected").bind(fbx_paths))
-    file_dialog.connect("canceled", Callable(self, "_on_file_dialog_closed"))
-
-    get_editor_interface().get_base_control().add_child(file_dialog)
-    file_dialog.popup_centered_ratio(0.6)
-
-func _on_export_folder_selected(dir_path: String, fbx_paths: Array) -> void:
-    for fbx_path in fbx_paths:
-        _process_fbx_file(fbx_path, dir_path)
-
-    _on_file_dialog_closed()
-
-func _process_fbx_file(fbx_path: String, dir_path: String) -> void:
-    print("Exporting animations from ", fbx_path, " to ", dir_path)
-
-    var import_file_path: String = fbx_path + ".import"
-    var config := ConfigFile.new()
-    var err := config.load(import_file_path)
-    if err == OK:
-        var subresources: Dictionary = config.get_value("params", "_subresources", {})
-        if "nodes" not in subresources:
-            subresources["nodes"] = {}
-        if "PATH:Skeleton3D" not in subresources["nodes"]:
-            subresources["nodes"]["PATH:Skeleton3D"] = {}
-
-        # Update the specific settings for Skeleton3D
-        subresources["nodes"]["PATH:Skeleton3D"]["retarget/bone_map"] = load("res://addons/mixamo_animation_retargeter/mixamo_bone_map.tres")
-        subresources["nodes"]["PATH:Skeleton3D"]["retarget/bone_renamer/unique_node/skeleton_name"] = "Skeleton"
-        subresources["nodes"]["PATH:Skeleton3D"]["retarget/remove_tracks/unmapped_bones"] = true
-
-        # Add or update the animations section
-        if not "animations" in subresources:
-            subresources["animations"] = {}
-        if not "mixamo_com" in subresources["animations"]:
-            subresources["animations"]["mixamo_com"] = {}
-
-        # Get the FBX file name and convert it to snake case
-        var fbx_file_name = fbx_path.get_file().get_basename()
-        var snake_case_name = to_snake_case(fbx_file_name)
-
-        # Create the relative path (already starts with res://)
-        var relative_res_path = dir_path.path_join(snake_case_name + ".res")
-
-        # Update the save to file settings for mixamo_com animation
-        subresources["animations"]["mixamo_com"]["save_to_file/enabled"] = true
-        subresources["animations"]["mixamo_com"]["save_to_file/keep_custom_tracks"] = ""
-        subresources["animations"]["mixamo_com"]["save_to_file/path"] = relative_res_path
-        subresources["animations"]["mixamo_com"]["settings/loop_mode"] = 0
-
-        # Save the updated subresources back to the config
-        config.set_value("params", "_subresources", subresources)
-
-        # Save the changes to the .import file
-        err = config.save(import_file_path)
-        if err == OK:
-            print("Import settings updated successfully for ", fbx_path)
-            # Trigger reimport immediately after saving
-            _trigger_reimport(fbx_path)
-        else:
-            print("Failed to save import settings for ", fbx_path)
-    else:
-        print("Failed to load import file for editing: ", fbx_path)
-
-# Helper function to convert string to snake_case
-func to_snake_case(string: String) -> String:
-    var result = ""
-    var prev_is_lowercase = false
-    for i in range(string.length()):
-        var c = string[i]
-        if c == ' ':
-            if result and result[-1] != '_':
-                result += '_'
-        elif c >= 'A' and c <= 'Z':
-            if prev_is_lowercase and result and result[-1] != '_':
-                result += '_'
-            result += c.to_lower()
-            prev_is_lowercase = false
-        else:
-            result += c.to_lower()
-            prev_is_lowercase = true
-    return result
-
-func _trigger_reimport(fbx_path: String) -> void:
-    # Trigger reimport of the FBX file
-    var file_system = get_editor_interface().get_resource_filesystem()
-    file_system.reimport_files([fbx_path])
-    print("Triggered reimport of FBX file")
-
-func _get_import_settings(file_path: String) -> ConfigFile:
-    var import_settings = ConfigFile.new()
-    var err = import_settings.load(file_path + ".import")
-    if err == OK:
-        return import_settings
-    else:
-        print("Failed to load import settings for: ", file_path)
-        return null
-
-# Helper function to find Skeleton3D in the scene
-func find_skeleton(node: Node) -> Skeleton3D:
-    if node is Skeleton3D:
-        return node
-    for child in node.get_children():
-        var result = find_skeleton(child)
-        if result:
-            return result
-    return null
-
-func _on_file_dialog_closed() -> void:
-    var file_dialog = get_editor_interface().get_base_control().get_node_or_null("FileDialog")
-    if file_dialog:
-        file_dialog.queue_free()
-
-# Helper functions from AutoMat
-static func get_selected_paths(fs_tree:Tree)->Array:
-    var sel_items: = tree_get_selected_items(fs_tree)
-    var result: = []
-    for i in sel_items:
-        i = i as TreeItem
-        result.push_back(i.get_metadata(0))
-    return result
-
-static func get_filesystem_tree(plugin:EditorPlugin)->Tree:
-    var dock = plugin.get_editor_interface().get_file_system_dock()
-    return find_node_by_class_path(dock, ['SplitContainer','Tree']) as Tree
-
-static func tree_get_selected_items(tree:Tree)->Array:
-    var res = []
-    var item = tree.get_next_selected(tree.get_root())
-    while true:
-        if item == null: break
-        res.push_back(item)
-        item = tree.get_next_selected(item)
-    return res
-
-static func find_node_by_class_path(node:Node, class_path:Array)->Node:
-    var res:Node
-
-    var stack = []
-    var depths = []
-
-    var first = class_path[0]
-    for c in node.get_children():
-        if c.get_class() == first:
-            stack.push_back(c)
-            depths.push_back(0)
-
-    if stack == null: return res
-
-    var max_ = class_path.size()-1
-
-    while stack:
-        var d = depths.pop_back()
-        var n = stack.pop_back()
-
-        if d>max_:
-            continue
-        if n.get_class() == class_path[d]:
-            if d == max_:
-                res = n
-                return res
-
-            for c in n.get_children():
-                stack.push_back(c)
-                depths.push_back(d+1)
-
-    return res
+func _exit_tree() -> void:
+	remove_context_menu_plugin(context_menu_plugin_instance)
+	print("Mixamo Animation Retargeter unloaded.")