Feature/bfme tool integration

.github/workflows/publish.yml

@@ -15,7 +15,7 @@ jobs:
         submodules: 'true'
     - name: Bundle archive
       run: |
-        zip -r io_mesh_w3d.zip io_mesh_w3d -x io_mesh_w3d/blender_addon_updater/.git
+        zip -r io_mesh_w3d.zip io_mesh_w3d -x io_mesh_w3d/blender_addon_updater/.git io_mesh_w3d/bfme/vendor/pyBIG/.git
 
     - name: Create Release
       id: create_release

.gitmodules

@@ -1,3 +1,6 @@
 [submodule "io_mesh_w3d/blender_addon_updater"]
 	path = io_mesh_w3d/blender_addon_updater
 	url = https://github.com/OpenSAGE/blender-addon-updater.git
+[submodule "io_mesh_w3d/bfme/vendor/pyBIG"]
+	path = io_mesh_w3d/bfme/vendor/pyBIG
+	url = https://github.com/ClementJ18/pyBIG.git

README.md

@@ -18,6 +18,14 @@ Supported Blender versions are 2.93 up to 5.2. On Blender 4.2 and newer the rele
 can be dropped into Blender to install it as an extension, older versions install it as a legacy add-on
 via *Edit > Preferences > Add-ons > Install*.
 
+## BfMe Tools
+
+The add-on also ships the BfMe modding tools (originally a separate add-on by Brechstange), found in the
+3D viewport sidebar (press *N*) under the *W3D Tools* tab, alongside the geometry/bone-volume export
+panel. They cover asset search paths and `.big` extraction,
+a `.w3d` model browser with previews, finding animations that fit a skeleton, build-up and destroy
+animation generators, UV/structure/collision-geometry/bone helpers and a simplified export panel.
+
 ## Setting up for development
 
 Please see [Setting up for development](https://github.com/OpenSAGE/OpenSAGE.BlenderPlugin/wiki/Development-Setup)

io_mesh_w3d/__init__.py

@@ -9,10 +9,12 @@
 from .custom_properties import *
 from .geometry_export import *
 from .bone_volume_export import *
+from .common.utils.material_import import flatten_materials, zero_specular
 
+from . import bfme
 from .blender_addon_updater import addon_updater_ops
 
-VERSION = (0, 7, 4)
+VERSION = (0, 9, 0)
 
 # add-ons installed through the extension system (Blender 4.2+) live in the
 # 'bl_ext' package and are kept up to date by Blender itself
@@ -22,7 +24,7 @@
 bl_info = {
     'name': 'Import/Export Westwood W3D Format (.w3d/.w3x)',
     'author': 'OpenSage Developers',
-    'version': (0, 7, 4),
+    'version': (0, 9, 0),
     "blender": (2, 90, 0),
     'location': 'File > Import/Export > Westwood W3D (.w3d/.w3x)',
     'description': 'Import or Export the Westwood W3D-Format (.w3d/.w3x)',
@@ -204,6 +206,8 @@ class ImportW3D(bpy.types.Operator, ImportHelper, ReportHelper):
 
     def execute(self, context):
         print_version(self.info)
+        objects_before = set(bpy.data.objects)
+
         if self.filepath.lower().endswith('.w3d'):
             from .w3d.import_w3d import load
             file_format = 'W3D'
@@ -213,6 +217,9 @@ def execute(self, context):
             file_format = 'W3X'
             load(self)
 
+        imported = [obj for obj in bpy.data.objects if obj not in objects_before]
+        zero_specular(flatten_materials(imported))
+
         self.info('finished')
         return {'FINISHED'}
 
@@ -424,16 +431,6 @@ def draw(self, context):
             col.prop(mat, 'multi_texture_enable')
 
 
-class TOOLS_PANEL_PT_w3d(bpy.types.Panel):
-    bl_label = 'W3D Tools'
-    bl_space_type = 'VIEW_3D'
-    bl_region_type = 'UI'
-
-    def draw(self, context):
-        self.layout.operator('scene.export_geometry_data', icon='CUBE', text='Export Geometry Data')
-        self.layout.operator('scene.export_bone_volume_data', icon='BONE_DATA', text='Export Bone Volume Data')
-
-
 class OBJECT_PT_DemoUpdaterPanel(bpy.types.Panel):
     bl_label = 'Updater Demo Panel'
     bl_idname = 'OBJECT_PT_hello'
@@ -518,7 +515,6 @@ def draw(self, context):
     MATERIAL_PROPERTIES_PANEL_PT_w3d,
     ExportGeometryData,
     ExportBoneVolumeData,
-    TOOLS_PANEL_PT_w3d
 )
 
 # the bundled updater would overwrite the add-on behind Blender's back,
@@ -550,6 +546,9 @@ def register():
 
     Material.shader = PointerProperty(type=ShaderProperties)
 
+    # the BfMe tools build on the operators and custom properties registered above
+    bfme.register()
+
     bpy.types.TOPBAR_MT_file_import.append(menu_func_import)
     bpy.types.TOPBAR_MT_file_export.append(menu_func_export)
 
@@ -561,6 +560,8 @@ def unregister():
         for class_ in reversed(UPDATER_CLASSES):
             bpy.utils.unregister_class(class_)
 
+    bfme.unregister()
+
     for class_ in reversed(CLASSES):
         bpy.utils.unregister_class(class_)
     bpy.types.TOPBAR_MT_file_import.remove(menu_func_import)

io_mesh_w3d/bfme/__init__.py

@@ -0,0 +1,45 @@
+# <pep8 compliant>
+"""BfMe modding tools.
+
+Originally a separate add-on built on top of the W3D importer/exporter, now part of
+it: the tools call this add-on's own import and export operators directly and reuse
+its custom mesh and material properties.
+"""
+
+from . import settings
+from .tools import (
+    bindings,
+    bindings_and_animation,
+    build_up_animation,
+    destroy_animation,
+    existing_animations,
+    export_settings,
+    model_browser,
+    texture_finder,
+    w3d_tools)
+
+# registration order within the 'W3D Tools' sidebar tab. 'bindings' and
+# 'existing_animations' own no panel of their own, their operators and
+# properties are drawn as the two sub-tabs of 'bindings_and_animation'
+MODULES = (
+    texture_finder,
+    model_browser,
+    existing_animations,
+    bindings,
+    bindings_and_animation,
+    build_up_animation,
+    destroy_animation,
+    export_settings,
+    w3d_tools)
+
+
+def register():
+    settings.register()
+    for module in MODULES:
+        module.register()
+
+
+def unregister():
+    for module in reversed(MODULES):
+        module.unregister()
+    settings.unregister()