Incremented version to 9.0.1

Fixed PSK and PSA export

.github/workflows/main.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        blender-version: [ 4.4 ]
+        blender-version: [ 5.0 ]
     env:
       ADDON_NAME: io_scene_psk_psa
     steps:

Dockerfile

@@ -1,7 +1,5 @@
 FROM ubuntu:22.04
 
-ARG BLENDER_VERSION=4.4
-
 RUN apt-get update -y && \
     apt-get install -y libxxf86vm-dev libxfixes3 libxi-dev libxkbcommon-x11-0 libgl1 libglx-mesa0 python3 python3-pip \
     libxrender1 libsm6
@@ -10,6 +8,8 @@ RUN pip install --upgrade pip
 RUN pip install pytest-blender
 RUN pip install blender-downloader
 
+ARG BLENDER_VERSION=5.0
+
 # Set BLENDER_EXECUTABLE and BLENDER_PYTHON as environment variables
 RUN BLENDER_EXECUTABLE=$(blender-downloader $BLENDER_VERSION --extract --remove-compressed --print-blender-executable) && \
     BLENDER_PYTHON=$(pytest-blender --blender-executable "${BLENDER_EXECUTABLE}") && \
@@ -22,7 +22,7 @@ RUN pip install pytest-cov
 # Source the environment variables and install Python dependencies
 RUN . /etc/environment && \
     $BLENDER_PYTHON -m ensurepip && \
-    $BLENDER_PYTHON -m pip install pytest pytest-cov
+    $BLENDER_PYTHON -m pip install pytest pytest-cov psk-psa-py
 
 # Persist BLENDER_EXECUTABLE as an environment variable
 RUN echo $(cat /blender_executable_path) > /tmp/blender_executable_path_env && \

README.md

@@ -56,7 +56,7 @@ The PSA importer creates [Actions](https://docs.blender.org/manual/en/latest/ani
 ## Why are imported PSKs too big/too small?
 The PSK format, unlike other more modern formats, has no explicit or implicit unit system. Each game has its own convention as to what the base distance unit will represent. As such, this addon makes no assumptions as to the unit scale of the imported PSKs. If you think that your models are being imported into Blender either too big or too small, there are a couple ways to remedy this.
 
-The method I prefer is to simply change the Blender [scene properties](https://docs.blender.org/manual/en/4.4/scene_layout/scene/properties.html#units) to match the unit system and scale for the game you're using. This is non-destructive and ensures that the unit scaling of any PSK or PSA exports from Blender will match the source file from which it was derived.
+The method I prefer is to simply change the Blender [scene properties](https://docs.blender.org/manual/en/5.0/scene_layout/scene/properties.html#units) to match the unit system and scale for the game you're using. This is non-destructive and ensures that the unit scaling of any PSK or PSA exports from Blender will match the source file from which it was derived.
 
 The second option is to simply change the `Scale` value on the PSK import dialog. This will scale the armature by the factor provided. Note that this is more destructive, but may be preferable if you don't intend on exporting PSKs or PSAs to a game engine.
 

io_scene_psk_psa/__init__.py

@@ -1,15 +1,13 @@
 from bpy.app.handlers import persistent
 
-from .shared import data as shared_data, types as shared_types, helpers as shared_helpers
+from .shared import types as shared_types, helpers as shared_helpers
 from .shared import dfs as shared_dfs, ui as shared_ui
 from .psk import (
     builder as psk_builder,
-    data as psk_data,
     importer as psk_importer,
     properties as psk_properties,
-    writer as psk_writer,
 )
-from .psk import reader as psk_reader, ui as psk_ui
+from .psk import ui as psk_ui
 from .psk.export import (
     operators as psk_export_operators,
     properties as psk_export_properties,
@@ -19,9 +17,6 @@ from .psk.import_ import operators as psk_import_operators
 
 from .psa import (
     config as psa_config,
-    data as psa_data,
-    writer as psa_writer,
-    reader as psa_reader,
     builder as psa_builder,
     importer as psa_importer,
 )
@@ -38,15 +33,11 @@ _needs_reload = 'bpy' in locals()
 if _needs_reload:
     import importlib
 
-    importlib.reload(shared_data)
     importlib.reload(shared_helpers)
     importlib.reload(shared_types)
     importlib.reload(shared_dfs)
     importlib.reload(shared_ui)
 
-    importlib.reload(psk_data)
-    importlib.reload(psk_reader)
-    importlib.reload(psk_writer)
     importlib.reload(psk_builder)
     importlib.reload(psk_importer)
     importlib.reload(psk_properties)
@@ -56,10 +47,7 @@ if _needs_reload:
     importlib.reload(psk_export_ui)
     importlib.reload(psk_import_operators)
 
-    importlib.reload(psa_data)
     importlib.reload(psa_config)
-    importlib.reload(psa_reader)
-    importlib.reload(psa_writer)
     importlib.reload(psa_builder)
     importlib.reload(psa_importer)
     importlib.reload(psa_export_properties)

io_scene_psk_psa/blender_manifest.toml

@@ -1,18 +1,21 @@
 schema_version = "1.0.0"
 id = "io_scene_psk_psa"
-version = "8.2.4"
+version = "9.0.1"
 name = "Unreal PSK/PSA (.psk/.psa)"
 tagline = "Import and export PSK and PSA files used in Unreal Engine"
 maintainer = "Colin Basnett <cmbasnett@gmail.com>"
 type = "add-on"
 website = "https://github.com/DarklightGames/io_scene_psk_psa/"
 tags = ["Game Engine", "Import-Export"]
-blender_version_min = "4.4.0"
+blender_version_min = "5.0.0"
 # Optional: maximum supported Blender version
 # blender_version_max = "5.1.0"
 license = [
   "SPDX:GPL-3.0-or-later",
 ]
+wheels = [
+  './wheels/psk_psa_py-0.0.1-py3-none-any.whl'
+]
 
 [build]
 paths_exclude_pattern = [

io_scene_psk_psa/psa/builder.py

@@ -1,10 +1,10 @@
 from bpy.types import Action, AnimData, Context, Object, PoseBone
 
-from .data import Psa
+from psk_psa_py.psa.data import Psa
 from typing import Dict, List, Optional, Tuple
 from mathutils import Matrix, Quaternion, Vector
 
-from ..shared.helpers import create_psx_bones, get_coordinate_system_transform
+from ..shared.helpers import PsxBoneCollection, create_psx_bones, get_coordinate_system_transform
 
 
 class PsaBuildSequence:
@@ -22,6 +22,7 @@ class PsaBuildSequence:
         self.compression_ratio: float = 1.0
         self.key_quota: int = 0
         self.fps: float = 30.0
+        self.group: Optional[str] = None
 
 
 class PsaBuildOptions:
@@ -30,7 +31,7 @@ class PsaBuildOptions:
         self.animation_data: Optional[AnimData] = None
         self.sequences: List[PsaBuildSequence] = []
         self.bone_filter_mode: str = 'ALL'
-        self.bone_collection_indices: List[PsaBoneCollectionIndex] = []
+        self.bone_collection_indices: List[PsxBoneCollection] = []
         self.sequence_name_prefix: str = ''
         self.sequence_name_suffix: str = ''
         self.scale = 1.0
@@ -171,11 +172,20 @@ def build_psa(context: Context, options: PsaBuildOptions) -> Psa:
         sequence_duration = frame_count_raw / export_sequence.fps
 
         psa_sequence = Psa.Sequence()
+        
         try:
             psa_sequence.name = bytes(export_sequence.name, encoding='windows-1252')
         except UnicodeEncodeError:
             raise RuntimeError(
                 f'Sequence name "{export_sequence.name}" contains characters that cannot be encoded in the Windows-1252 codepage')
+        
+        try:
+            if export_sequence.group is not None:
+                psa_sequence.group = bytes(export_sequence.group, encoding='windows-1252')
+        except UnicodeDecodeError:
+            raise RuntimeError(
+                f'Group name "{export_sequence.group} contains characters that cannot be encoded in the Windows-1252 codepage')
+        
         psa_sequence.frame_count = frame_count
         psa_sequence.frame_start_index = frame_start_index
         psa_sequence.fps = frame_count / sequence_duration

io_scene_psk_psa/psa/config.py

@@ -55,7 +55,7 @@ def read_psa_config(psa_sequence_names: List[str], file_path: str) -> PsaConfig:
 
     if config.has_section('RemoveTracks'):
         for key, value in config.items('RemoveTracks'):
-            match = re.match(f'^(.+)\.(\d+)$', key)
+            match = re.match(rf'^(.+)\.(\d+)$', key)
             if not match:
                 continue
             sequence_name = match.group(1)

io_scene_psk_psa/psa/data.py

@@ -1,53 +0,0 @@
-from collections import OrderedDict
-from typing import List, OrderedDict as OrderedDictType
-
-from ctypes import Structure, c_char, c_int32, c_float
-from ..shared.data import PsxBone, Quaternion, Vector3
-
-
-class Psa:
-    """
-    Note that keys are not stored within the Psa object.
-    Use the `PsaReader.get_sequence_keys` to get the keys for a sequence.
-    """
-
-    class Sequence(Structure):
-        _fields_ = [
-            ('name', c_char * 64),
-            ('group', c_char * 64),
-            ('bone_count', c_int32),
-            ('root_include', c_int32),
-            ('compression_style', c_int32),
-            ('key_quotum', c_int32),
-            ('key_reduction', c_float),
-            ('track_time', c_float),
-            ('fps', c_float),
-            ('start_bone', c_int32),
-            ('frame_start_index', c_int32),
-            ('frame_count', c_int32)
-        ]
-
-    class Key(Structure):
-        _fields_ = [
-            ('location', Vector3),
-            ('rotation', Quaternion),
-            ('time', c_float)
-        ]
-
-        @property
-        def data(self):
-            yield self.rotation.w
-            yield self.rotation.x
-            yield self.rotation.y
-            yield self.rotation.z
-            yield self.location.x
-            yield self.location.y
-            yield self.location.z
-
-        def __repr__(self) -> str:
-            return repr((self.location, self.rotation, self.time))
-
-    def __init__(self):
-        self.bones: List[PsxBone] = []
-        self.sequences: OrderedDictType[str, Psa.Sequence] = OrderedDict()
-        self.keys: List[Psa.Key] = []

io_scene_psk_psa/psa/export/operators.py

@@ -15,7 +15,7 @@ from .properties import (
 )
 from .ui import PSA_UL_export_sequences
 from ..builder import build_psa, PsaBuildSequence, PsaBuildOptions
-from ..writer import write_psa
+from psk_psa_py.psa.writer import write_psa_to_file
 from ...shared.helpers import populate_bone_collection_list, get_nla_strips_in_frame_range, PsxBoneCollection
 from ...shared.ui import draw_bone_filter_mode
 
@@ -35,7 +35,7 @@ def get_sequences_propnames_from_source(sequence_source: str) -> Tuple[str, str]
 
 
 def is_action_for_object(obj: Object, action: Action):
-    if len(action.fcurves) == 0:
+    if len(action.layers) == 0:
         return False
 
     if obj is None or obj.animation_data is None or obj.type != 'ARMATURE':
@@ -300,6 +300,7 @@ class PSA_OT_export(Operator, ExportHelper):
 
     def draw(self, context):
         layout = self.layout
+        assert layout
         pg = getattr(context.scene, 'psa_export')
 
         sequences_header, sequences_panel = layout.panel('Sequences', default_closed=False)
@@ -333,7 +334,7 @@ class PSA_OT_export(Operator, ExportHelper):
             sequences_panel.template_list(PSA_UL_export_sequences.bl_idname, '', pg, propname, pg, active_propname,
                                           rows=max(3, min(len(getattr(pg, propname)), 10)))
 
-            name_header, name_panel = layout.panel('Name', default_closed=False)
+            name_header, name_panel = sequences_panel.panel('Name', default_closed=False)
             name_header.label(text='Name')
             if name_panel:
                 flow = name_panel.grid_flow()
@@ -351,7 +352,19 @@ class PSA_OT_export(Operator, ExportHelper):
                         layout.label(text=f'Duplicate action: {action_name}', icon='ERROR')
                         break
         
-            sampling_header, sampling_panel = layout.panel('Data Source', default_closed=False)
+            # Group
+            group_header, group_panel = sequences_panel.panel('Group', default_closed=True)
+            group_header.label(text='Group')
+            if group_panel is not None:
+                group_flow = group_panel.grid_flow()
+                group_flow.use_property_split = True
+                group_flow.use_property_decorate = False
+                group_flow.prop(pg, 'group_source')
+                if pg.group_source == 'CUSTOM':
+                    group_flow.prop(pg, 'group_custom', placeholder='Group')
+
+            # Sampling
+            sampling_header, sampling_panel = sequences_panel.panel('Data Source', default_closed=False)
             sampling_header.label(text='Sampling')
             if sampling_panel:
                 flow = sampling_panel.grid_flow()
@@ -430,6 +443,7 @@ class PSA_OT_export(Operator, ExportHelper):
             self._check_context(context)
         except RuntimeError as e:
             self.report({'ERROR_INVALID_CONTEXT'}, str(e))
+            return {'CANCELLED'}
 
         pg: PSA_PG_export = getattr(context.scene, 'psa_export')
 
@@ -453,7 +467,7 @@ class PSA_OT_export(Operator, ExportHelper):
         return {'RUNNING_MODAL'}
 
     def execute(self, context):
-        pg = getattr(context.scene, 'psa_export')
+        pg = typing_cast(PSA_PG_export, getattr(context.scene, 'psa_export'))
 
         # Populate the export sequence list.
         animation_data_object = get_animation_data_object(context)
@@ -467,13 +481,23 @@ class PSA_OT_export(Operator, ExportHelper):
 
         export_sequences: List[PsaBuildSequence] = []
 
+        def get_export_sequence_group(group_source: str, group_custom: str | None, action: Action | None) -> str | None:
+            match group_source:
+                case 'ACTIONS':
+                    return action.psa_export.group if action else None
+                case 'CUSTOM':
+                    return group_custom
+                case _:
+                    return None
+
         match pg.sequence_source:
             case 'ACTIONS':
                 for action_item in filter(lambda x: x.is_selected, pg.action_list):
-                    if len(action_item.action.fcurves) == 0:
+                    if len(action_item.action.layers) == 0:
                         continue
                     export_sequence = PsaBuildSequence(context.active_object, animation_data)
                     export_sequence.name = action_item.name
+                    export_sequence.group = get_export_sequence_group(pg.group_source, pg.group_custom, action_item.action)
                     export_sequence.nla_state.action = action_item.action
                     export_sequence.nla_state.frame_start = action_item.frame_start
                     export_sequence.nla_state.frame_end = action_item.frame_end
@@ -483,12 +507,15 @@ class PSA_OT_export(Operator, ExportHelper):
                     export_sequences.append(export_sequence)
             case 'TIMELINE_MARKERS':
                 for marker_item in filter(lambda x: x.is_selected, pg.marker_list):
+                    nla_strips_actions: List[Action] = []
+                    for nla_strip in get_nla_strips_in_frame_range(animation_data, marker_item.frame_start, marker_item.frame_end):
+                        if nla_strip.action:
+                            nla_strips_actions.append(nla_strip.action)
                     export_sequence = PsaBuildSequence(context.active_object, animation_data)
                     export_sequence.name = marker_item.name
+                    export_sequence.group = get_export_sequence_group(pg.group_source, pg.group_custom, next(iter(nla_strips_actions), None))
                     export_sequence.nla_state.frame_start = marker_item.frame_start
                     export_sequence.nla_state.frame_end = marker_item.frame_end
-                    nla_strips_actions = set(
-                        map(lambda x: x.action, get_nla_strips_in_frame_range(animation_data, marker_item.frame_start, marker_item.frame_end)))
                     export_sequence.fps = get_sequence_fps(context, pg.fps_source, pg.fps_custom, nla_strips_actions)
                     export_sequence.compression_ratio = get_sequence_compression_ratio(pg.compression_ratio_source, pg.compression_ratio_custom, nla_strips_actions)
                     export_sequences.append(export_sequence)
@@ -496,6 +523,7 @@ class PSA_OT_export(Operator, ExportHelper):
                 for nla_strip_item in filter(lambda x: x.is_selected, pg.nla_strip_list):
                     export_sequence = PsaBuildSequence(context.active_object, animation_data)
                     export_sequence.name = nla_strip_item.name
+                    export_sequence.group = get_export_sequence_group(pg.group_source, pg.group_custom, nla_strip_item.action)
                     export_sequence.nla_state.frame_start = nla_strip_item.frame_start
                     export_sequence.nla_state.frame_end = nla_strip_item.frame_end
                     export_sequence.fps = get_sequence_fps(context, pg.fps_source, pg.fps_custom, [nla_strip_item.action])
@@ -507,6 +535,7 @@ class PSA_OT_export(Operator, ExportHelper):
                     export_sequence = PsaBuildSequence(active_action_item.armature_object, active_action_item.armature_object.animation_data)
                     action = active_action_item.action
                     export_sequence.name = action.name
+                    export_sequence.group = get_export_sequence_group(pg.group_source, pg.group_custom, action)
                     export_sequence.nla_state.action = action
                     export_sequence.nla_state.frame_start = int(action.frame_range[0])
                     export_sequence.nla_state.frame_end = int(action.frame_range[1])
@@ -544,7 +573,7 @@ class PSA_OT_export(Operator, ExportHelper):
             self.report({'ERROR_INVALID_CONTEXT'}, str(e))
             return {'CANCELLED'}
 
-        write_psa(psa, self.filepath)
+        write_psa_to_file(psa, self.filepath)
 
         return {'FINISHED'}
 

io_scene_psk_psa/psa/export/properties.py

@@ -29,6 +29,7 @@ class PSA_PG_export_action_list_item(PropertyGroup):
     frame_start: IntProperty(options={'HIDDEN'})
     frame_end: IntProperty(options={'HIDDEN'})
     is_pose_marker: BoolProperty(options={'HIDDEN'})
+    group: StringProperty()
 
 
 class PSA_PG_export_active_action_list_item(PropertyGroup):
@@ -38,6 +39,7 @@ class PSA_PG_export_active_action_list_item(PropertyGroup):
     is_selected: BoolProperty(default=True)
     frame_start: IntProperty(options={'HIDDEN'})
     frame_end: IntProperty(options={'HIDDEN'})
+    group: StringProperty()
 
 
 class PSA_PG_export_timeline_markers(PropertyGroup):  # TODO: rename this to singular
@@ -46,6 +48,7 @@ class PSA_PG_export_timeline_markers(PropertyGroup):  # TODO: rename this to sin
     is_selected: BoolProperty(default=True)
     frame_start: IntProperty(options={'HIDDEN'})
     frame_end: IntProperty(options={'HIDDEN'})
+    group: StringProperty()
 
 
 class PSA_PG_export_nla_strip_list_item(PropertyGroup):
@@ -54,6 +57,7 @@ class PSA_PG_export_nla_strip_list_item(PropertyGroup):
     frame_start: FloatProperty()
     frame_end: FloatProperty()
     is_selected: BoolProperty(default=True)
+    group: StringProperty()
 
 
 def get_sequences_from_name_and_frame_range(name: str, frame_start: int, frame_end: int):
@@ -129,6 +133,11 @@ sampling_mode_items = (
     ('SUBFRAME', 'Subframe', 'Sampling is performed by evaluating the bone poses at the subframe time.\n\nNot recommended unless you are also animating with subframes enabled.', 'SUBFRAME', 1),
 )
 
+group_source_items = (
+    ('ACTIONS', 'Actions', '', 0),
+    ('CUSTOM', 'Custom', '', 1),
+)
+
 
 def sequence_source_update_cb(self: 'PSA_PG_export', context: Context) -> None:
     armature_objects = []
@@ -228,6 +237,18 @@ class PSA_PG_export(PropertyGroup, TransformMixin, ExportSpaceMixin, PsxBoneExpo
         items=sampling_mode_items,
         default='INTERPOLATED'
     )
+    group_source: EnumProperty(
+        name='Group Source',
+        options=set(),
+        description='The source of the exported sequence\'s group property',
+        items=group_source_items,
+        default='ACTIONS'
+    )
+    group_custom: StringProperty(
+        name='Group',
+        options=set(),
+        description='The group to apply to all exported sequences. Only applicable when Group Source is Custom.'
+    )
 
 
 def filter_sequences(pg: PSA_PG_export, sequences) -> List[int]:

io_scene_psk_psa/psa/import_/operators.py

@@ -9,11 +9,12 @@ from bpy_extras.io_utils import ImportHelper
 from .properties import PsaImportMixin, get_visible_sequences
 from ..config import read_psa_config
 from ..importer import BoneMapping, PsaImportOptions, import_psa
-from ..reader import PsaReader
+from psk_psa_py.psa.reader import PsaReader
 
 
 def psa_import_poll(cls, context: Context):
-    assert context.view_layer and context.view_layer.objects.active
+    if context.view_layer is None or context.view_layer.objects.active is None:
+        return False
     active_object = context.view_layer.objects.active
     if active_object is None or active_object.type != 'ARMATURE':
         cls.poll_message_set('The active object must be an armature')

io_scene_psk_psa/psa/importer.py

@@ -5,10 +5,11 @@ import numpy as np
 import re
 from bpy.types import Armature, Context, FCurve, Object, Bone, PoseBone
 from mathutils import Vector, Quaternion
+from bpy_extras import anim_utils
 
 from .config import PsaConfig, REMOVE_TRACK_LOCATION, REMOVE_TRACK_ROTATION
-from .reader import PsaReader
+from psk_psa_py.psa.reader import PsaReader
-from ..shared.data import PsxBone
+from psk_psa_py.shared.data import PsxBone
 
 class BoneMapping:
     def __init__(self,
@@ -214,6 +215,8 @@ def import_psa(context: Context, psa_reader: PsaReader, armature_object: Object,
         )
     del armature_bone_names
 
+    assert armature_object.pose
+
     # Create intermediate bone data for import operations.
     import_bones = []
     psa_bone_names_to_import_bones = dict()
@@ -277,7 +280,12 @@ def import_psa(context: Context, psa_reader: PsaReader, armature_object: Object,
             action = bpy.data.actions[action_name]
         else:
             action = bpy.data.actions.new(name=action_name)
-            action.slots.new('OBJECT', armature_object.name)
+            action_slot = action.slots.new('OBJECT', armature_object.name)
+
+        # TODO: Wish there was a better way to do this.
+        action_slot = action.slots[f'OB{armature_object.name}']
+
+        assert action_slot
 
         # Calculate the target FPS.
         match options.fps_source:
@@ -292,8 +300,7 @@ def import_psa(context: Context, psa_reader: PsaReader, armature_object: Object,
                 assert False, f'Invalid FPS source: {options.fps_source}'
 
         if options.should_write_keyframes:            
-            # Remove existing f-curves.
+            channelbag = anim_utils.action_ensure_channelbag_for_slot(action, action_slot)
-            action.fcurves.clear()
 
             # Create f-curves for the rotation and location of each bone.
             for psa_bone_index, armature_bone_index in psa_to_armature_bone_indices.items():
@@ -305,13 +312,13 @@ def import_psa(context: Context, psa_reader: PsaReader, armature_object: Object,
                 add_rotation_fcurves = (bone_track_flags & REMOVE_TRACK_ROTATION) == 0
                 add_location_fcurves = (bone_track_flags & REMOVE_TRACK_LOCATION) == 0
                 import_bone.fcurves = [
-                    action.fcurves.new(rotation_data_path, index=0, action_group=pose_bone.name) if add_rotation_fcurves else None,  # Qw
+                    channelbag.fcurves.ensure(rotation_data_path, index=0, group_name=pose_bone.name) if add_rotation_fcurves else None,  # Qw
-                    action.fcurves.new(rotation_data_path, index=1, action_group=pose_bone.name) if add_rotation_fcurves else None,  # Qx
+                    channelbag.fcurves.ensure(rotation_data_path, index=1, group_name=pose_bone.name) if add_rotation_fcurves else None,  # Qx
-                    action.fcurves.new(rotation_data_path, index=2, action_group=pose_bone.name) if add_rotation_fcurves else None,  # Qy
+                    channelbag.fcurves.ensure(rotation_data_path, index=2, group_name=pose_bone.name) if add_rotation_fcurves else None,  # Qy
-                    action.fcurves.new(rotation_data_path, index=3, action_group=pose_bone.name) if add_rotation_fcurves else None,  # Qz
+                    channelbag.fcurves.ensure(rotation_data_path, index=3, group_name=pose_bone.name) if add_rotation_fcurves else None,  # Qz
-                    action.fcurves.new(location_data_path, index=0, action_group=pose_bone.name) if add_location_fcurves else None,  # Lx
+                    channelbag.fcurves.ensure(location_data_path, index=0, group_name=pose_bone.name) if add_location_fcurves else None,  # Lx
-                    action.fcurves.new(location_data_path, index=1, action_group=pose_bone.name) if add_location_fcurves else None,  # Ly
+                    channelbag.fcurves.ensure(location_data_path, index=1, group_name=pose_bone.name) if add_location_fcurves else None,  # Ly
-                    action.fcurves.new(location_data_path, index=2, action_group=pose_bone.name) if add_location_fcurves else None,  # Lz
+                    channelbag.fcurves.ensure(location_data_path, index=2, group_name=pose_bone.name) if add_location_fcurves else None,  # Lz
                 ]
 
             # Read the sequence data matrix from the PSA.
@@ -348,6 +355,7 @@ def import_psa(context: Context, psa_reader: PsaReader, armature_object: Object,
                 for fcurve_index, fcurve in enumerate(import_bone.fcurves):
                     if fcurve is None:
                         continue
+                    fcurve.keyframe_points.clear()
                     fcurve_data[1::2] = resampled_sequence_data_matrix[:, bone_index, fcurve_index]
                     fcurve.keyframe_points.add(target_frame_count)
                     fcurve.keyframe_points.foreach_set('co', fcurve_data)
@@ -375,7 +383,7 @@ def import_psa(context: Context, psa_reader: PsaReader, armature_object: Object,
         if animation_data is None:
             animation_data = armature_object.animation_data_create()
         for action in actions:
-            nla_track = armature_object.animation_data.nla_tracks.new()
+            nla_track = animation_data.nla_tracks.new()
             nla_track.name = action.name
             nla_track.mute = True
             nla_track.strips.new(name=action.name, start=0, action=action)

io_scene_psk_psa/psa/reader.py

@@ -1,126 +0,0 @@
-from ctypes import sizeof
-from typing import List
-
-import numpy as np
-
-from .data import Psa, PsxBone
-from ..shared.data import Section
-
-
-def _try_fix_cue4parse_issue_103(sequences) -> bool:
-    # Detect if the file was exported from CUE4Parse prior to the fix for issue #103.
-    # https://github.com/FabianFG/CUE4Parse/issues/103
-    # The issue was that the frame_start_index was not being set correctly, and was always being set to the same value
-    # as the frame_count.
-    # This fix will eventually be deprecated as it is only necessary for files exported prior to the fix.
-    if len(sequences) > 0 and sequences[0].frame_start_index == sequences[0].frame_count:
-        # Manually set the frame_start_index for each sequence. This assumes that the sequences are in order with
-        # no shared frames between sequences (all exporters that I know of do this, so it's a safe assumption).
-        frame_start_index = 0
-        for i, sequence in enumerate(sequences):
-            sequence.frame_start_index = frame_start_index
-            frame_start_index += sequence.frame_count
-        return True
-    return False
-
-
-class PsaReader(object):
-    """
-    This class reads the sequences and bone information immediately upon instantiation and holds onto a file handle.
-    The keyframe data is not read into memory upon instantiation due to its potentially very large size.
-    To read the key data for a particular sequence, call :read_sequence_keys.
-    """
-
-    def __init__(self, path):
-        self.keys_data_offset: int = 0
-        self.fp = open(path, 'rb')
-        self.psa: Psa = self._read(self.fp)
-
-    def __enter__(self):
-        return self
-
-    def __exit__(self, exc_type, exc_val, exc_tb):
-        self.fp.close()
-
-    @property
-    def bones(self):
-        return self.psa.bones
-
-    @property
-    def sequences(self):
-        return self.psa.sequences
-
-    def read_sequence_data_matrix(self, sequence_name: str) -> np.ndarray:
-        """
-        Reads and returns the data matrix for the given sequence.
-        
-        @param sequence_name: The name of the sequence.
-        @return: An FxBx7 matrix where F is the number of frames, B is the number of bones.
-        """
-        sequence = self.psa.sequences[sequence_name]
-        keys = self.read_sequence_keys(sequence_name)
-        bone_count = len(self.bones)
-        matrix_size = sequence.frame_count, bone_count, 7
-        matrix = np.zeros(matrix_size)
-        keys_iter = iter(keys)
-        for frame_index in range(sequence.frame_count):
-            for bone_index in range(bone_count):
-                matrix[frame_index, bone_index, :] = list(next(keys_iter).data)
-        return matrix
-
-    def read_sequence_keys(self, sequence_name: str) -> List[Psa.Key]:
-        """
-        Reads and returns the key data for a sequence.
-
-        @param sequence_name: The name of the sequence.
-        @return: A list of Psa.Keys.
-        """
-        # Set the file reader to the beginning of the keys data
-        sequence = self.psa.sequences[sequence_name]
-        data_size = sizeof(Psa.Key)
-        bone_count = len(self.psa.bones)
-        buffer_length = data_size * bone_count * sequence.frame_count
-        sequence_keys_offset = self.keys_data_offset + (sequence.frame_start_index * bone_count * data_size)
-        self.fp.seek(sequence_keys_offset, 0)
-        buffer = self.fp.read(buffer_length)
-        offset = 0
-        keys = []
-        for _ in range(sequence.frame_count * bone_count):
-            key = Psa.Key.from_buffer_copy(buffer, offset)
-            keys.append(key)
-            offset += data_size
-        return keys
-
-    @staticmethod
-    def _read_types(fp, data_class, section: Section, data):
-        buffer_length = section.data_size * section.data_count
-        buffer = fp.read(buffer_length)
-        offset = 0
-        for _ in range(section.data_count):
-            data.append(data_class.from_buffer_copy(buffer, offset))
-            offset += section.data_size
-
-    def _read(self, fp) -> Psa:
-        psa = Psa()
-        while fp.read(1):
-            fp.seek(-1, 1)
-            section = Section.from_buffer_copy(fp.read(sizeof(Section)))
-            if section.name == b'ANIMHEAD':
-                pass
-            elif section.name == b'BONENAMES':
-                PsaReader._read_types(fp, PsxBone, section, psa.bones)
-            elif section.name == b'ANIMINFO':
-                sequences = []
-                PsaReader._read_types(fp, Psa.Sequence, section, sequences)
-                # Try to fix CUE4Parse bug, if necessary.
-                _try_fix_cue4parse_issue_103(sequences)
-                for sequence in sequences:
-                    psa.sequences[sequence.name.decode()] = sequence
-            elif section.name == b'ANIMKEYS':
-                # Skip keys on this pass. We will keep this file open and read from it as needed.
-                self.keys_data_offset = fp.tell()
-                fp.seek(section.data_size * section.data_count, 1)
-            else:
-                fp.seek(section.data_size * section.data_count, 1)
-                print(f'Unrecognized section in PSA: "{section.name}"')
-        return psa

io_scene_psk_psa/psa/writer.py

@@ -1,25 +0,0 @@
-from ctypes import Structure, sizeof
-from typing import Optional, Type, Collection
-
-from .data import Psa
-from ..shared.data import PsxBone, Section
-
-
-def write_section(fp, name: bytes, data_type: Optional[Type[Structure]] = None, data: Optional[Collection] = None):
-    section = Section()
-    section.name = name
-    if data_type is not None and data is not None:
-        section.data_size = sizeof(data_type)
-        section.data_count = len(data)
-    fp.write(section)
-    if data is not None:
-        for datum in data:
-            fp.write(datum)
-
-
-def write_psa(psa: Psa, path: str):
-    with open(path, 'wb') as fp:
-        write_section(fp, b'ANIMHEAD')
-        write_section(fp, b'BONENAMES', PsxBone, psa.bones)
-        write_section(fp, b'ANIMINFO', Psa.Sequence, list(psa.sequences.values()))
-        write_section(fp, b'ANIMKEYS', Psa.Key, psa.keys)

io_scene_psk_psa/psk/builder.py

@@ -4,9 +4,9 @@ import numpy as np
 from bpy.types import Armature, Collection, Context, Depsgraph, Object, ArmatureModifier, Mesh
 from mathutils import Matrix
 from typing import Dict, Iterable, List, Optional, Set, cast as typing_cast
-from .data import Psk
+from psk_psa_py.shared.data import Vector3
+from psk_psa_py.psk.data import Psk
 from .properties import triangle_type_and_bit_flags_to_poly_flags
-from ..shared.data import Vector3
 from ..shared.dfs import DfsObject, dfs_collection_objects, dfs_view_layer_objects
 from ..shared.helpers import (
     PsxBoneCollection,

io_scene_psk_psa/psk/data.py

@@ -1,153 +0,0 @@
-from ctypes import Structure, c_uint32, c_float, c_int32, c_uint8, c_int8, c_int16, c_char, c_uint16
-from typing import List
-
-from ..shared.data import Vector3, Quaternion, Color, Vector2, PsxBone
-
-
-class Psk(object):
-    class Wedge(object):
-        def __init__(self, point_index: int, u: float, v: float, material_index: int = 0):
-            self.point_index: int = point_index
-            self.u: float = u
-            self.v: float = v
-            self.material_index = material_index
-
-        def __hash__(self):
-            return hash(f'{self.point_index}-{self.u}-{self.v}-{self.material_index}')
-
-    class Wedge16(Structure):
-        _fields_ = [
-            ('point_index', c_uint32),
-            ('u', c_float),
-            ('v', c_float),
-            ('material_index', c_uint8),
-            ('reserved', c_int8),
-            ('padding2', c_int16)
-        ]
-
-    class Wedge32(Structure):
-        _fields_ = [
-            ('point_index', c_uint32),
-            ('u', c_float),
-            ('v', c_float),
-            ('material_index', c_uint32)
-        ]
-
-    class Face(Structure):
-        _fields_ = [
-            ('wedge_indices', c_uint16 * 3),
-            ('material_index', c_uint8),
-            ('aux_material_index', c_uint8),
-            ('smoothing_groups', c_int32)
-        ]
-
-    class Face32(Structure):
-        _pack_ = 1
-        _fields_ = [
-            ('wedge_indices', c_uint32 * 3),
-            ('material_index', c_uint8),
-            ('aux_material_index', c_uint8),
-            ('smoothing_groups', c_int32)
-        ]
-
-    class Material(Structure):
-        _fields_ = [
-            ('name', c_char * 64),
-            ('texture_index', c_int32),
-            ('poly_flags', c_int32),
-            ('aux_material', c_int32),
-            ('aux_flags', c_int32),
-            ('lod_bias', c_int32),
-            ('lod_style', c_int32)
-        ]
-
-    class Bone(Structure):
-        _fields_ = [
-            ('name', c_char * 64),
-            ('flags', c_int32),
-            ('children_count', c_int32),
-            ('parent_index', c_int32),
-            ('rotation', Quaternion),
-            ('location', Vector3),
-            ('length', c_float),
-            ('size', Vector3)
-        ]
-
-    class Weight(Structure):
-        _fields_ = [
-            ('weight', c_float),
-            ('point_index', c_int32),
-            ('bone_index', c_int32),
-        ]
-
-    class MorphInfo(Structure):
-        _fields_ = [
-            ('name', c_char * 64),
-            ('vertex_count', c_int32)
-        ]
-
-    class MorphData(Structure):
-        _fields_ = [
-            ('position_delta', Vector3),
-            ('tangent_z_delta', Vector3),
-            ('point_index', c_int32)
-        ]
-
-    @property
-    def has_extra_uvs(self):
-        return len(self.extra_uvs) > 0
-
-    @property
-    def has_vertex_colors(self):
-        return len(self.vertex_colors) > 0
-
-    @property
-    def has_vertex_normals(self):
-        return len(self.vertex_normals) > 0
-
-    @property
-    def has_material_references(self):
-        return len(self.material_references) > 0
-
-    @property
-    def has_morph_data(self):
-        return len(self.morph_infos) > 0
-    
-    def sort_and_normalize_weights(self):
-        self.weights.sort(key=lambda x: x.point_index)
-
-        weight_index = 0
-        weight_total = len(self.weights)
-
-        while weight_index < weight_total:
-            point_index = self.weights[weight_index].point_index
-            weight_sum = self.weights[weight_index].weight
-            point_weight_total = 1
-
-            # Calculate the sum of weights for the current point_index.
-            for i in range(weight_index + 1, weight_total):
-                if self.weights[i].point_index != point_index:
-                    break
-                weight_sum += self.weights[i].weight
-                point_weight_total += 1
-
-            # Normalize the weights for the current point_index.
-            for i in range(weight_index, weight_index + point_weight_total):
-                self.weights[i].weight /= weight_sum
-
-            # Move to the next group of weights.
-            weight_index += point_weight_total
-    
-    def __init__(self):
-        self.points: List[Vector3] = []
-        self.wedges: List[Psk.Wedge] = []
-        self.faces: List[Psk.Face] = []
-        self.materials: List[Psk.Material] = []
-        self.weights: List[Psk.Weight] = []
-        self.bones: List[PsxBone] = []
-        self.extra_uvs: List[Vector2] = []
-        self.vertex_colors: List[Color] = []
-        self.vertex_normals: List[Vector3] = []
-        self.morph_infos: List[Psk.MorphInfo] = []
-        self.morph_data: List[Psk.MorphData] = []
-        self.material_references: List[str] = []

io_scene_psk_psa/psk/export/operators.py

@@ -1,5 +1,5 @@
 from pathlib import Path
-from typing import Iterable, List, Optional, cast as typing_cast
+from typing import Iterable, List
 
 import bpy
 from bpy.props import BoolProperty, StringProperty
@@ -14,7 +14,7 @@ from ..builder import (
     get_psk_input_objects_for_collection,
     get_psk_input_objects_for_context,
 )
-from ..writer import write_psk
+from psk_psa_py.psk.writer import write_psk_to_path
 from ...shared.helpers import PsxBoneCollection, get_collection_export_operator_from_context, populate_bone_collection_list
 from ...shared.ui import draw_bone_filter_mode
 
@@ -270,8 +270,8 @@ class PSK_OT_export_collection(Operator, ExportHelper, PskExportMixin):
     def execute(self, context):
         collection = bpy.data.collections.get(self.collection, None)
 
-        if collection is not None:
+        assert collection is not None
-            return {'CANCELLED'}
+        assert context.scene is not None
 
         try:
             input_objects = get_psk_input_objects_for_collection(collection)
@@ -286,7 +286,7 @@ class PSK_OT_export_collection(Operator, ExportHelper, PskExportMixin):
             result = build_psk(context, input_objects, options)
             for warning in result.warnings:
                 self.report({'WARNING'}, warning)
-            write_psk(result.psk, filepath)
+            write_psk_to_path(result.psk, filepath)
             if len(result.warnings) > 0:
                 self.report({'WARNING'}, f'PSK export successful with {len(result.warnings)} warnings')
             else:
@@ -526,7 +526,7 @@ class PSK_OT_export(Operator, ExportHelper):
             result = build_psk(context, input_objects, options)
             for warning in result.warnings:
                 self.report({'WARNING'}, warning)
-            write_psk(result.psk, self.filepath)
+            write_psk_to_path(result.psk, self.filepath)
             if len(result.warnings) > 0:
                 self.report({'WARNING'}, f'PSK export successful with {len(result.warnings)} warnings')
             else:

io_scene_psk_psa/psk/export/properties.py

@@ -1,4 +1,3 @@
-from bpy.types import Context
 from bpy.props import (
     BoolProperty,
     CollectionProperty,
@@ -9,7 +8,6 @@ from bpy.props import (
 )
 from bpy.types import Material, PropertyGroup
 
-from ...shared.helpers import get_collection_export_operator_from_context
 from ...shared.types import ExportSpaceMixin, TransformMixin, PsxBoneExportMixin
 
 object_eval_state_items = (

io_scene_psk_psa/psk/import_/operators.py

@@ -7,7 +7,7 @@ from bpy_extras.io_utils import ImportHelper
 
 from ..importer import PskImportOptions, import_psk
 from ..properties import PskImportMixin
-from ..reader import read_psk
+from psk_psa_py.psk.reader import read_psk_from_file
 
 
 def get_psk_import_options_from_properties(property_group: PskImportMixin):
@@ -91,7 +91,7 @@ class PSK_OT_import(Operator, ImportHelper, PskImportMixin):
 
     def execute(self, context):
         try:
-            psk = read_psk(self.filepath)
+            psk = read_psk_from_file(self.filepath)
         except OSError as e:
             self.report({'ERROR'}, f'Failed to read "{self.filepath}". The file may be corrupted or not a valid PSK file: {e}')
             return {'CANCELLED'}
@@ -144,7 +144,7 @@ class PSK_OT_import_drag_and_drop(Operator, PskImportMixin):
         for file in self.files:
             filepath = Path(self.directory) / file.name
             try:
-                psk = read_psk(filepath)
+                psk = read_psk_from_file(filepath)
             except OSError as e:
                 self.report({'ERROR'}, f'Failed to read "{filepath}". The file may be corrupted or not a valid PSK file: {e}')
                 return {'CANCELLED'}

io_scene_psk_psa/psk/importer.py

@@ -2,13 +2,13 @@ import bmesh
 import bpy
 import numpy as np
 
-from bpy.types import Context, Object, VertexGroup
+from bpy.types import Context, Object, VertexGroup, ArmatureModifier, FloatColorAttribute
 from mathutils import Matrix, Quaternion, Vector
-from typing import List, Optional
+from typing import List, Optional, cast as typing_cast
 
-from .data import Psk
+from psk_psa_py.psk.data import Psk
+from psk_psa_py.shared.data import PsxBone
 from .properties import poly_flags_to_triangle_type_and_bit_flags
-from ..shared.data import PsxBone
 from ..shared.helpers import is_bdk_addon_loaded, rgb_to_srgb
 
 
@@ -151,7 +151,6 @@ def import_psk(psk: Psk, context: Context, name: str, options: PskImportOptions)
                     mesh_triangle_type, mesh_triangle_bit_flags = poly_flags_to_triangle_type_and_bit_flags(psk_material.poly_flags)
                     material.psk.mesh_triangle_type = mesh_triangle_type
                     material.psk.mesh_triangle_bit_flags = mesh_triangle_bit_flags
-                    material.use_nodes = True
                 
                 mesh_data.materials.append(material)
 
@@ -202,16 +201,15 @@ def import_psk(psk: Psk, context: Context, name: str, options: PskImportOptions)
 
         # Extra UVs
         if psk.has_extra_uvs and options.should_import_extra_uvs:
-            extra_uv_channel_count = int(len(psk.extra_uvs) / len(psk.wedges))
             wedge_index_offset = 0
-            uv_layer_data = np.zeros((face_count * 3, 2), dtype=np.float32)
+            for extra_uv_index, extra_uvs in enumerate(psk.extra_uvs):
-            for extra_uv_index in range(extra_uv_channel_count):
+                uv_layer_data = np.zeros((face_count * 3, 2), dtype=np.float32)
                 uv_layer_data_index = 0
                 for face_index, face in enumerate(psk.faces):
                     if face_index in invalid_face_indices:
                         continue
                     for wedge_index in reversed(face.wedge_indices):
-                        u, v = psk.extra_uvs[wedge_index_offset + wedge_index]
+                        u, v = extra_uvs[wedge_index_offset + wedge_index]
                         uv_layer_data[uv_layer_data_index] = u, 1.0 - v
                         uv_layer_data_index += 1
                 wedge_index_offset += len(psk.wedges)
@@ -242,6 +240,7 @@ def import_psk(psk: Psk, context: Context, name: str, options: PskImportOptions)
 
             # Create the vertex color attribute.
             face_corner_color_attribute = mesh_data.attributes.new(name='VERTEXCOLOR', type='FLOAT_COLOR', domain='CORNER')
+            face_corner_color_attribute = typing_cast(FloatColorAttribute, face_corner_color_attribute)
             face_corner_color_attribute.data.foreach_set('color', face_corner_colors.ravel())
 
         # Vertex Normals
@@ -276,6 +275,7 @@ def import_psk(psk: Psk, context: Context, name: str, options: PskImportOptions)
 
             for morph_info in psk.morph_infos:
                 shape_key = mesh_object.shape_key_add(name=morph_info.name.decode('windows-1252'), from_mix=False)
+                shape_key.value = 0.0
 
                 for _ in range(morph_info.vertex_count):
                     morph_data = next(morph_data_iterator)
@@ -287,10 +287,12 @@ def import_psk(psk: Psk, context: Context, name: str, options: PskImportOptions)
         # Add armature modifier to our mesh object.
         if options.should_import_armature:
             armature_modifier = mesh_object.modifiers.new(name='Armature', type='ARMATURE')
+            armature_modifier = typing_cast(ArmatureModifier, armature_modifier)
             armature_modifier.object = armature_object
             mesh_object.parent = armature_object
 
     root_object = armature_object if options.should_import_armature else mesh_object
+    assert root_object
     root_object.scale = (options.scale, options.scale, options.scale)
 
     try:

io_scene_psk_psa/psk/reader.py

@@ -1,95 +0,0 @@
-import ctypes
-import os
-import re
-import warnings
-from pathlib import Path
-from typing import List
-from ..shared.data import Section
-from .data import Color, Psk, PsxBone, Vector2, Vector3
-
-
-def _read_types(fp, data_class, section: Section, data):
-    buffer_length = section.data_size * section.data_count
-    buffer = fp.read(buffer_length)
-    offset = 0
-    for _ in range(section.data_count):
-        data.append(data_class.from_buffer_copy(buffer, offset))
-        offset += section.data_size
-
-
-def _read_material_references(path: str) -> List[str]:
-    property_file_path = Path(path).with_suffix('.props.txt')
-    if not property_file_path.is_file():
-        # Property file does not exist.
-        return []
-    # Do a crude regex match to find the Material list entries.
-    contents = property_file_path.read_text()
-    pattern = r'Material\s*=\s*([^\s^,]+)'
-    return re.findall(pattern, contents)
-
-
-def read_psk(path: str) -> Psk:
-    psk = Psk()
-
-    # Read the PSK file sections.
-    with open(path, 'rb') as fp:
-        while fp.read(1):
-            fp.seek(-1, 1)
-            section = Section.from_buffer_copy(fp.read(ctypes.sizeof(Section)))
-            match section.name:
-                case b'ACTRHEAD':
-                    pass
-                case b'PNTS0000':
-                    _read_types(fp, Vector3, section, psk.points)
-                case b'VTXW0000':
-                    if section.data_size == ctypes.sizeof(Psk.Wedge16):
-                        _read_types(fp, Psk.Wedge16, section, psk.wedges)
-                    elif section.data_size == ctypes.sizeof(Psk.Wedge32):
-                        _read_types(fp, Psk.Wedge32, section, psk.wedges)
-                    else:
-                        raise RuntimeError('Unrecognized wedge format')
-                case b'FACE0000':
-                    _read_types(fp, Psk.Face, section, psk.faces)
-                case b'MATT0000':
-                    _read_types(fp, Psk.Material, section, psk.materials)
-                case b'REFSKELT':
-                    _read_types(fp, PsxBone, section, psk.bones)
-                case b'RAWWEIGHTS':
-                    _read_types(fp, Psk.Weight, section, psk.weights)
-                case b'FACE3200':
-                    _read_types(fp, Psk.Face32, section, psk.faces)
-                case b'VERTEXCOLOR':
-                    _read_types(fp, Color, section, psk.vertex_colors)
-                case b'VTXNORMS':
-                    _read_types(fp, Vector3, section, psk.vertex_normals)
-                case b'MRPHINFO':
-                    _read_types(fp, Psk.MorphInfo, section, psk.morph_infos)
-                case b'MRPHDATA':
-                    _read_types(fp, Psk.MorphData, section, psk.morph_data)
-                case _:
-                    if section.name.startswith(b'EXTRAUV'):
-                        _read_types(fp, Vector2, section, psk.extra_uvs)
-                    else:
-                        # Section is not handled, skip it.
-                        fp.seek(section.data_size * section.data_count, os.SEEK_CUR)
-                        warnings.warn(f'Unrecognized section "{section.name} at position {fp.tell():15}"')
-
-    """
-    UEViewer exports a sidecar file (*.props.txt) with fully-qualified reference paths for each material
-    (e.g., Texture'Package.Group.Object').
-    """
-    psk.material_references = _read_material_references(path)
-
-    """
-    Tools like UEViewer and CUE4Parse write the point index as a 32-bit integer, exploiting the fact that due to struct
-    alignment, there were 16-bits of padding following the original 16-bit point index in the wedge struct.
-    However, this breaks compatibility with PSK files that were created with older tools that treated the
-    point index as a 16-bit integer and might have junk data written to the padding bits.
-    To work around this, we check if each point is still addressable using a 16-bit index, and if it is, assume the
-    point index is a 16-bit integer and truncate the high bits.
-    """
-    if len(psk.points) <= 65536:
-        for wedge in psk.wedges:
-            wedge.point_index &= 0xFFFF
-
-    return psk

io_scene_psk_psa/psk/writer.py

@@ -1,61 +0,0 @@
-import os
-from ctypes import Structure, sizeof
-from typing import Type
-
-from .data import Psk
-from ..shared.data import PsxBone, Section, Vector3
-
-MAX_WEDGE_COUNT = 65536
-MAX_POINT_COUNT = 4294967296
-MAX_BONE_COUNT = 2147483647
-MAX_MATERIAL_COUNT = 256
-
-
-def _write_section(fp, name: bytes, data_type: Type[Structure] = None, data: list = None):
-    section = Section()
-    section.name = name
-    if data_type is not None and data is not None:
-        section.data_size = sizeof(data_type)
-        section.data_count = len(data)
-    fp.write(section)
-    if data is not None:
-        for datum in data:
-            fp.write(datum)
-
-
-def write_psk(psk: Psk, path: str):
-    if len(psk.wedges) > MAX_WEDGE_COUNT:
-        raise RuntimeError(f'Number of wedges ({len(psk.wedges)}) exceeds limit of {MAX_WEDGE_COUNT}')
-    if len(psk.points) > MAX_POINT_COUNT:
-        raise RuntimeError(f'Numbers of vertices ({len(psk.points)}) exceeds limit of {MAX_POINT_COUNT}')
-    if len(psk.materials) > MAX_MATERIAL_COUNT:
-        raise RuntimeError(f'Number of materials ({len(psk.materials)}) exceeds limit of {MAX_MATERIAL_COUNT}')
-    if len(psk.bones) > MAX_BONE_COUNT:
-        raise RuntimeError(f'Number of bones ({len(psk.bones)}) exceeds limit of {MAX_BONE_COUNT}')
-    if len(psk.bones) == 0:
-        raise RuntimeError(f'At least one bone must be marked for export')
-
-    # Make the directory for the file if it doesn't exist.
-    os.makedirs(os.path.dirname(path), exist_ok=True)
-
-    try:
-        with open(path, 'wb') as fp:
-            _write_section(fp, b'ACTRHEAD')
-            _write_section(fp, b'PNTS0000', Vector3, psk.points)
-
-            wedges = []
-            for index, w in enumerate(psk.wedges):
-                wedge = Psk.Wedge16()
-                wedge.material_index = w.material_index
-                wedge.u = w.u
-                wedge.v = w.v
-                wedge.point_index = w.point_index
-                wedges.append(wedge)
-
-            _write_section(fp, b'VTXW0000', Psk.Wedge16, wedges)
-            _write_section(fp, b'FACE0000', Psk.Face, psk.faces)
-            _write_section(fp, b'MATT0000', Psk.Material, psk.materials)
-            _write_section(fp, b'REFSKELT', PsxBone, psk.bones)
-            _write_section(fp, b'RAWWEIGHTS', Psk.Weight, psk.weights)
-    except PermissionError as e:
-        raise RuntimeError(f'The current user "{os.getlogin()}" does not have permission to write to "{path}"') from e

io_scene_psk_psa/shared/data.py

@@ -1,113 +0,0 @@
-from ctypes import Structure, c_char, c_int32, c_float, c_ubyte
-from typing import Tuple
-
-
-class Color(Structure):
-    _fields_ = [
-        ('r', c_ubyte),
-        ('g', c_ubyte),
-        ('b', c_ubyte),
-        ('a', c_ubyte),
-    ]
-
-    def __iter__(self):
-        yield self.r
-        yield self.g
-        yield self.b
-        yield self.a
-
-    def __eq__(self, other):
-        return self.r == other.r and self.g == other.g and self.b == other.b and self.a == other.a
-
-    def __repr__(self):
-        return repr(tuple(self))
-
-    def normalized(self) -> Tuple:
-        return (
-            self.r / 255.0,
-            self.g / 255.0,
-            self.b / 255.0,
-            self.a / 255.0
-        )
-
-
-class Vector2(Structure):
-    _fields_ = [
-        ('x', c_float),
-        ('y', c_float),
-    ]
-
-    def __iter__(self):
-        yield self.x
-        yield self.y
-
-    def __repr__(self):
-        return repr(tuple(self))
-
-
-class Vector3(Structure):
-    _fields_ = [
-        ('x', c_float),
-        ('y', c_float),
-        ('z', c_float),
-    ]
-
-    def __iter__(self):
-        yield self.x
-        yield self.y
-        yield self.z
-
-    def __repr__(self):
-        return repr(tuple(self))
-
-    @classmethod
-    def zero(cls):
-        return Vector3(0, 0, 0)
-
-
-class Quaternion(Structure):
-    _fields_ = [
-        ('x', c_float),
-        ('y', c_float),
-        ('z', c_float),
-        ('w', c_float),
-    ]
-
-    def __iter__(self):
-        yield self.w
-        yield self.x
-        yield self.y
-        yield self.z
-
-    def __repr__(self):
-        return repr(tuple(self))
-
-    @classmethod
-    def identity(cls):
-        return Quaternion(0, 0, 0, 1)
-
-
-class PsxBone(Structure):
-    _fields_ = [
-        ('name', c_char * 64),
-        ('flags', c_int32),
-        ('children_count', c_int32),
-        ('parent_index', c_int32),
-        ('rotation', Quaternion),
-        ('location', Vector3),
-        ('length', c_float),
-        ('size', Vector3)
-    ]
-
-
-class Section(Structure):
-    _fields_ = [
-        ('name', c_char * 20),
-        ('type_flags', c_int32),
-        ('data_size', c_int32),
-        ('data_count', c_int32)
-    ]
-
-    def __init__(self, *args, **kw):
-        super().__init__(*args, **kw)
-        self.type_flags = 1999801

io_scene_psk_psa/shared/helpers.py

@@ -3,8 +3,7 @@ from collections import Counter
 from typing import List, Iterable, Optional, Dict, Tuple, cast as typing_cast
 from bpy.types import Armature, AnimData, Collection, Context, Object, ArmatureModifier, SpaceProperties
 from mathutils import Matrix, Vector, Quaternion as BpyQuaternion
-from .data import Vector3, Quaternion
+from psk_psa_py.shared.data import PsxBone, Vector3, Quaternion
-from ..shared.data import PsxBone
 
 
 def rgb_to_srgb(c: float) -> float:
@@ -345,7 +344,10 @@ def create_psx_bones(
     coordinate_system_matrix = get_coordinate_system_transform(forward_axis, up_axis)
     coordinate_system_default_rotation = coordinate_system_matrix.to_quaternion()
 
-    total_bone_count = sum(len(armature_object.data.bones) for armature_object in armature_objects)
+    total_bone_count = 0
+    for armature_object in filter(lambda x: x.data is not None, armature_objects):
+        armature_data = typing_cast(Armature, armature_object.data)
+        total_bone_count += len(armature_data.bones)
 
     # Store the bone names to be exported for each armature object.
     armature_object_bone_names: Dict[Object, List[str]] = dict()

io_scene_psk_psa/shared/types.py

@@ -29,6 +29,7 @@ class PSX_PG_bone_collection_list_item(PropertyGroup):
 
 
 class PSX_PG_action_export(PropertyGroup):
+    group: StringProperty(name='Group', description='The group of the sequence', maxlen=64)
     compression_ratio: FloatProperty(name='Compression Ratio', default=1.0, min=0.0, max=1.0, subtype='FACTOR', description='The key sampling ratio of the exported sequence.\n\nA compression ratio of 1.0 will export all frames, while a compression ratio of 0.5 will export half of the frames')
     key_quota: IntProperty(name='Key Quota', default=0, min=1, description='The minimum number of frames to be exported')
     fps: FloatProperty(name='FPS', default=30.0, min=0.0, description='The frame rate of the exported sequence')
@@ -49,12 +50,16 @@ class PSX_PT_action(Panel):
     def draw(self, context: 'Context'):
         action = context.active_action
         layout = self.layout
+        assert layout is not None
         flow = layout.grid_flow(columns=1)
         flow.use_property_split = True
         flow.use_property_decorate = False
-        flow.prop(action.psa_export, 'compression_ratio')
+        psa_export = getattr(action, 'psa_export')
-        flow.prop(action.psa_export, 'key_quota')
+        assert psa_export
-        flow.prop(action.psa_export, 'fps')
+        flow.prop(psa_export, 'compression_ratio')
+        flow.prop(psa_export, 'key_quota')
+        flow.prop(psa_export, 'fps')
+        flow.prop(psa_export, 'group', placeholder='Group')
 
 
 bone_filter_mode_items = (

test.sh

@@ -1,2 +1,35 @@
-# usr/bin/env bash
+#!/usr/bin/env bash
-docker run -it --volume ${PWD}:/io_scene_psk_psa --volume ${PWD}/io_scene_psk_psa:/addons/io_scene_psk_psa --volume ${PWD}/tests:/tests  $(docker build -q .)
+
+# Exit immediately if a command exits with a non-zero status
+set -e
+
+# Function to find an available container command (podman or docker)
+find_container_cli() {
+    if command -v podman &> /dev/null; then
+        echo "podman"
+    elif command -v docker &> /dev/null; then
+        echo "docker"
+    else
+        echo ""
+    fi
+}
+
+CONTAINER_CLI=$(find_container_cli)
+
+if [ -z "$CONTAINER_CLI" ]; then
+    echo "Error: Neither Podman nor Docker was found. Please install one of them to proceed."
+    exit 1
+fi
+
+echo "Using container CLI: $CONTAINER_CLI"
+
+# Build the image and capture its ID
+# The '-q' flag is supported by both podman and docker build to suppress output and return only the image ID.
+IMAGE_ID=$($CONTAINER_CLI build -q .)
+
+# Run the container using the selected CLI and captured image ID
+$CONTAINER_CLI run -it \
+    --volume "${PWD}:/io_scene_psk_psa:z" \
+    --volume "${PWD}/io_scene_psk_psa:/addons/io_scene_psk_psa:z" \
+    --volume "${PWD}/tests:/tests:z" \
+    "$IMAGE_ID"

tests/psk_import_test.py

@@ -1,6 +1,9 @@
 import bpy
 import pytest
 
+from typing import cast as typing_cast
+from bpy.types import Mesh, Armature
+
 SUZANNE_FILEPATH = 'tests/data/Suzanne.psk'
 SARGE_FILEPATH = 'tests/data/CS_Sarge_S0_Skelmesh.pskx'
 SLURP_MONSTER_AXE_FILEPATH = 'tests/data/Slurp_Monster_Axe_LOD0.psk'
@@ -29,14 +32,14 @@ def test_psk_import_all():
     assert armature_object is not None, "Armature object not found in the scene"
     assert len(armature_object.children) == 1, "Armature object should have one child"
 
-    armature_data = armature_object.data
+    armature_data = typing_cast(Armature, armature_object.data)
 
     assert len(armature_data.bones) == 1, "Armature should have one bone"
 
     mesh_object = bpy.data.objects.get('Suzanne.001', None)
     assert mesh_object is not None, "Mesh object not found in the scene"
 
-    mesh_data = mesh_object.data
+    mesh_data = typing_cast(Mesh, mesh_object.data)
 
     assert len(mesh_data.vertices) == 507
     assert len(mesh_data.polygons) == 968
@@ -50,11 +53,11 @@ def test_psk_import_armature_only():
 
     armature_object = bpy.data.objects.get('Suzanne', None)
 
-    assert armature_object.type == 'ARMATURE', "Armature object type should be ARMATURE"
     assert armature_object is not None, "Armature object not found in the scene"
+    assert armature_object.type == 'ARMATURE', "Armature object type should be ARMATURE"
     assert len(armature_object.children) == 0, "Armature object should have no children"
 
-    armature_data = armature_object.data
+    armature_data = typing_cast(Armature, armature_object.data)
 
     assert len(armature_data.bones) == 1, "Armature should have one bone"
 
@@ -66,10 +69,10 @@ def test_psk_import_mesh_only():
         ) == {'FINISHED'}
 
     mesh_object = bpy.data.objects.get('Suzanne', None)
-    assert mesh_object.type == 'MESH', "Mesh object type should be MESH"
     assert mesh_object is not None, "Mesh object not found in the scene"
+    assert mesh_object.type == 'MESH', "Mesh object type should be MESH"
 
-    mesh_data = mesh_object.data
+    mesh_data = typing_cast(Mesh, mesh_object.data)
 
     assert len(mesh_data.vertices) == 507
     assert len(mesh_data.polygons) == 968
@@ -105,7 +108,7 @@ def test_psk_import_bone_length():
     assert armature_object is not None, "Armature object not found in the scene"
     assert armature_object.type == 'ARMATURE', "Armature object type should be ARMATURE"
 
-    armature_data = armature_object.data
+    armature_data = typing_cast(Armature, armature_object.data)
     assert armature_data is not None, "Armature data not found in the scene"
     assert len(armature_data.bones) == 1, "Armature should have one bone"
     assert 'ROOT' in armature_data.bones, "Armature should have a bone named 'ROOT'"
@@ -126,7 +129,7 @@ def test_psk_import_with_vertex_normals():
     assert mesh_object is not None, "Mesh object not found in the scene"
     assert mesh_object.type == 'MESH', "Mesh object type should be MESH"
 
-    mesh_data = mesh_object.data
+    mesh_data = typing_cast(Mesh, mesh_object.data)
     assert mesh_data is not None, "Mesh data not found in the scene"
     assert mesh_data.has_custom_normals, "Mesh should have custom normals"
 
@@ -142,7 +145,7 @@ def test_psk_import_without_vertex_normals():
     assert mesh_object is not None, "Mesh object not found in the scene"
     assert mesh_object.type == 'MESH', "Mesh object type should be MESH"
 
-    mesh_data = mesh_object.data
+    mesh_data = typing_cast(Mesh, mesh_object.data)
     assert mesh_data is not None, "Mesh data not found in the scene"
     assert not mesh_data.has_custom_normals, "Mesh should not have custom normals"
 
@@ -159,7 +162,7 @@ def test_psk_import_with_vertex_colors_srgba():
     assert mesh_object is not None, "Mesh object not found in the scene"
     assert mesh_object.type == 'MESH', "Mesh object type should be MESH"
 
-    mesh_data = mesh_object.data
+    mesh_data = typing_cast(Mesh, mesh_object.data)
     assert mesh_data is not None, "Mesh data not found in the scene"
     assert len(mesh_data.color_attributes) == 1, "Mesh should have one vertex color layer"
     assert mesh_data.color_attributes[0].name == 'VERTEXCOLOR', "Vertex color layer should be named 'VERTEXCOLOR'"
@@ -178,7 +181,7 @@ def test_psk_import_vertex_colors_linear():
     assert mesh_object is not None, "Mesh object not found in the scene"
     assert mesh_object.type == 'MESH', "Mesh object type should be MESH"
 
-    mesh_data = mesh_object.data
+    mesh_data = typing_cast(Mesh, mesh_object.data)
     assert mesh_data is not None, "Mesh data not found in the scene"
     assert len(mesh_data.color_attributes) == 1, "Mesh should have one vertex color layer"
     assert mesh_data.color_attributes[0].name == 'VERTEXCOLOR', "Vertex color layer should be named 'VERTEXCOLOR'"
@@ -196,7 +199,7 @@ def test_psk_import_without_vertex_colors():
     assert mesh_object is not None, "Mesh object not found in the scene"
     assert mesh_object.type == 'MESH', "Mesh object type should be MESH"
 
-    mesh_data = mesh_object.data
+    mesh_data = typing_cast(Mesh, mesh_object.data)
     assert mesh_data is not None, "Mesh data not found in the scene"
     assert len(mesh_data.color_attributes) == 0, "Mesh should not have any vertex color layers"
 
@@ -213,7 +216,7 @@ def test_psk_import_extra_uvs():
     assert mesh_object is not None, "Mesh object not found in the scene"
     assert mesh_object.type == 'MESH', "Mesh object type should be MESH"
 
-    mesh_data = mesh_object.data
+    mesh_data = typing_cast(Mesh, mesh_object.data)
     assert mesh_data is not None, "Mesh data not found in the scene"
     assert len(mesh_data.uv_layers) == 2, "Mesh should have two UV layers"
 
@@ -237,7 +240,7 @@ def test_psk_import_materials():
     assert mesh_object is not None, "Mesh object not found in the scene"
     assert mesh_object.type == 'MESH', "Mesh object type should be MESH"
 
-    mesh_data = mesh_object.data
+    mesh_data = typing_cast(Mesh, mesh_object.data)
 
     assert mesh_data is not None, "Mesh data not found in the scene"
     assert len(mesh_data.materials) == 4, "Mesh should have four materials"
@@ -248,6 +251,7 @@ def test_psk_import_materials():
         'CS_Sarge_S0_MI'
     )
     for i, material in enumerate(mesh_data.materials):
+        assert material is not None, f"Material {i} should not be None"
         assert material.name == material_names[i], f"Material {i} name should be {material_names[i]}"
 
 
@@ -260,7 +264,9 @@ def test_psk_import_shape_keys():
     mesh_object = bpy.data.objects.get('Slurp_Monster_Axe_LOD0', None)
     assert mesh_object is not None, "Mesh object not found in the scene"
     assert mesh_object.type == 'MESH', "Mesh object type should be MESH"
-    assert mesh_object.data.shape_keys is not None, "Mesh object should have shape keys"
+    mesh_data = typing_cast(Mesh, mesh_object.data)
+    assert mesh_data is not None, "Mesh data should not be None"
+    assert mesh_data.shape_keys is not None, "Mesh object should have shape keys"
 
     shape_key_names = (
         'MORPH_BASE',
@@ -270,10 +276,13 @@ def test_psk_import_shape_keys():
         'Blob02',
         'Blob01',
     )
-    shape_keys = mesh_object.data.shape_keys.key_blocks
+    shape_keys = mesh_data.shape_keys.key_blocks
     assert len(shape_keys) == 6, "Mesh object should have 6 shape keys"
     for i, shape_key in enumerate(shape_keys):
-        assert shape_key.name == shape_key_names[i], f"Shape key {i} name should be {shape_key_names[i]}"
+        expected_value = 1.0 if i == 0 else 0.0
+        assert shape_key.value == expected_value, f"Shape key {shape_key.name} should have a value of {expected_value} (found {shape_key.value})"
+        assert shape_key.name == shape_key_names[i], f"Shape key {i} name should be named {shape_key_names[i]}"
+
 
 def test_psk_import_without_shape_keys():
     assert bpy.ops.psk.import_file(
@@ -285,7 +294,10 @@ def test_psk_import_without_shape_keys():
     mesh_object = bpy.data.objects.get('Slurp_Monster_Axe_LOD0', None)
     assert mesh_object is not None, "Mesh object not found in the scene"
     assert mesh_object.type == 'MESH', "Mesh object type should be MESH"
-    assert mesh_object.data.shape_keys is None, "Mesh object should not have shape keys"
+
+    mesh_data = typing_cast(Mesh, mesh_object.data)
+    assert mesh_data is not None, "Mesh data should not be None"
+    assert mesh_data.shape_keys is None, "Mesh object should not have shape keys"
 
 
 def test_psk_import_with_invalid_faces():

tests/requirements.txt

@@ -1 +1,3 @@
 pytest
+pytest-cov
+psk-psa-py

tests/test.sh

@@ -5,4 +5,4 @@ export BLENDER_EXECUTABLE=$(cat /blender_executable_path)
 pytest --cov-report xml --cov=/root/.config/blender -svv tests --blender-executable $BLENDER_EXECUTABLE --blender-addons-dirs ../addons
 # Fixes the paths in the coverage report to be relative to the current directory.
 sed -i 's|/root/.config/blender||g' coverage.xml
-sed -i 's|4.4/scripts/addons/io_scene_psk_psa/||g' coverage.xml
+sed -i 's|5.0/scripts/addons/io_scene_psk_psa/||g' coverage.xml