feat: import custom rigs from external folder

Author: eigen-value

__init__.py

@@ -45,6 +45,7 @@
 import os
 from bpy.types import AddonPreferences
 from bpy.props import BoolProperty
+from bpy.props import StringProperty
 
 
 class RigifyPreferences(AddonPreferences):
@@ -118,15 +119,48 @@ def update_legacy(self, context):
 
             register()
 
+    def update_external_rigs(self, context):
+
+        if self.legacy_mode:
+            return
+
+        custom_rigs_folder = bpy.context.user_preferences.addons['rigify'].preferences.custom_rigs_folder
+
+        if custom_rigs_folder not in sys.path:
+            sys.path.append(bpy.context.user_preferences.addons['rigify'].preferences.custom_rigs_folder)
+
+        external_rigs_dict = rig_lists.get_external_rigs()
+        if external_rigs_dict:
+
+            rig_lists.rigs_dict['external'] = external_rigs_dict
+
+            # Add external rig parameters
+            for rig in external_rigs_dict['rig_list']:
+                r = utils.get_rig_type(rig, custom_rigs_folder)
+                try:
+                    r.add_parameters(RigifyParameters)
+                except AttributeError:
+                    pass
+
     legacy_mode = BoolProperty(
         name='Rigify Legacy Mode',
         description='Select if you want to use Rigify in legacy mode',
         default=False,
         update=update_legacy
     )
 
+    custom_rigs_folder = StringProperty(
+        name='Rigify Custom Rigs',
+        description='Folder Containing User Defined Rig Types',
+        default='',
+        subtype='DIR_PATH',
+        update=update_external_rigs
+    )
+
     show_expanded = BoolProperty()
 
+    show_rigs_folder_expanded = BoolProperty()
+
     def draw(self, context):
         layout = self.layout
         column = layout.column()
@@ -149,6 +183,24 @@ def draw(self, context):
         sub.prop(self, 'legacy_mode')
 
         if expand:
+            split = col.row().split(percentage=0.15)
+            split.label('Description:')
+            split.label(text='This is the folder containing user defined Rig Types')
+
+        box = column.box()
+        rigs_expand = getattr(self, 'show_rigs_folder_expanded')
+        icon = 'TRIA_DOWN' if rigs_expand else 'TRIA_RIGHT'
+        col = box.column()
+        row = col.row()
+        sub = row.row()
+        sub.context_pointer_set('addon_prefs', self)
+        sub.alignment = 'LEFT'
+        op = sub.operator('wm.context_toggle', text='', icon=icon,
+                          emboss=False)
+        op.data_path = 'addon_prefs.show_rigs_folder_expanded'
+        row.prop(self, 'custom_rigs_folder')
+
+        if rigs_expand:
             split = col.row().split(percentage=0.15)
             split.label('Description:')
             split.label(text='When enabled the add-on will run in legacy mode using the old 2.76b feature set.')
@@ -333,6 +385,10 @@ def update_mode(self, context):
         except AttributeError:
             pass
 
+    external_rigs_folder = bpy.context.user_preferences.addons['rigify'].preferences.custom_rigs_folder
+    if external_rigs_folder and not 'external' in rig_lists.rigs_dict:
+        bpy.context.user_preferences.addons['rigify'].preferences.custom_rigs_folder = external_rigs_folder
+
 
 def unregister():
     del bpy.types.PoseBone.rigify_type
@@ -361,6 +417,9 @@ def unregister():
     bpy.utils.unregister_class(RigifySelectionColors)
 
     bpy.utils.unregister_class(RigifyArmatureLayer)
+
+    if bpy.context.user_preferences.addons['rigify'].preferences.custom_rigs_folder in sys.path:
+        sys.path.remove(bpy.context.user_preferences.addons['rigify'].preferences.custom_rigs_folder)
     bpy.utils.unregister_class(RigifyPreferences)
 
     metarig_menu.unregister()

rig_lists.py

@@ -17,19 +17,35 @@
 #======================= END GPL LICENSE BLOCK ========================
 
 import os
+import bpy
 
 from . import utils
 
 
-def get_rig_list(path):
+def get_rig_list(path, mode='relative'):
     """ Recursively searches for rig types, and returns a list.
+
+    :param path
+    :type path:str
+    :param mode: path is absolute or relative?
+    :type mode: str
     """
+
+    if mode == 'relative':
+        base_path = ''
+        MODULE_DIR = os.path.dirname(__file__)
+        RIG_DIR_ABS = os.path.join(MODULE_DIR, utils.RIG_DIR)
+        SEARCH_DIR_ABS = os.path.join(RIG_DIR_ABS, path)
+    elif mode == 'absolute':
+        base_path = path
+        SEARCH_DIR_ABS = path
+    else:
+        return
+
     rigs_dict = dict()
     rigs = []
-    implementation_rigs = []
-    MODULE_DIR = os.path.dirname(__file__)
-    RIG_DIR_ABS = os.path.join(MODULE_DIR, utils.RIG_DIR)
-    SEARCH_DIR_ABS = os.path.join(RIG_DIR_ABS, path)
+    impl_rigs = []
+
     files = os.listdir(SEARCH_DIR_ABS)
     files.sort()
 
@@ -45,29 +61,36 @@ def get_rig_list(path):
 
         if is_dir:
             # Check directories
-            module_name = os.path.join(path, f).replace(os.sep, ".")
-            rig = utils.get_rig_type(module_name)
+            if mode == 'relative':
+                module_name = os.path.join(path, f).replace(os.sep, ".")
+                rig = utils.get_rig_type(module_name, base_path=base_path)
+            else:
+                module_name = "__init__"
+                rig = utils.get_rig_type(module_name, base_path=base_path + f + os.sep)
             # Check if it's a rig itself
             if hasattr(rig, "Rig"):
                 rigs += [f]
             else:
                 # Check for sub-rigs
-                sub_dict = get_rig_list(os.path.join(path, f, ""))  # "" adds a final slash
+                sub_dict = get_rig_list(os.path.join(path, f, ""), mode=mode)  # "" adds a final slash
                 rigs.extend(["%s.%s" % (f, l) for l in sub_dict['rig_list']])
-                implementation_rigs.extend(["%s.%s" % (f, l) for l in sub_dict['implementation_rigs']])
+                impl_rigs.extend(["%s.%s" % (f, l) for l in sub_dict['implementation_rigs']])
         elif f.endswith(".py"):
             # Check straight-up python files
             t = f[:-3]
-            module_name = os.path.join(path, t).replace(os.sep, ".")
-            rig = utils.get_rig_type(module_name)
+            if mode == 'relative':
+                module_name = os.path.join(path, t).replace(os.sep, ".")
+            else:
+                module_name = t
+            rig = utils.get_rig_type(module_name, base_path=base_path)
             if hasattr(rig, "Rig"):
                 rigs += [t]
             if hasattr(rig, 'IMPLEMENTATION') and rig.IMPLEMENTATION:
-                implementation_rigs += [t]
+                impl_rigs += [t]
     rigs.sort()
 
     rigs_dict['rig_list'] = rigs
-    rigs_dict['implementation_rigs'] = implementation_rigs
+    rigs_dict['implementation_rigs'] = impl_rigs
 
     return rigs_dict
 
@@ -87,3 +110,12 @@ def get_collection_list(rig_list):
 implementation_rigs = rigs_dict['implementation_rigs']
 collection_list = get_collection_list(rig_list)
 col_enum_list = [("All", "All", ""), ("None", "None", "")] + [(c, c, "") for c in collection_list]
+
+
+def get_external_rigs():
+    external_folder = bpy.context.user_preferences.addons['rigify'].preferences.custom_rigs_folder
+    if external_folder:
+        external_rigs_dict = get_rig_list(external_folder, mode='absolute')
+        external_rig_list = external_rigs_dict['rig_list']
+        external_implementation_rigs = external_rigs_dict['implementation_rigs']
+        return external_rigs_dict

ui.py

@@ -173,6 +173,18 @@ def draw(self, context):
                     a = id_store.rigify_types.add()
                     a.name = r
 
+            if 'external' in rig_lists.rigs_dict:
+                for r in rig_lists.rigs_dict['external']['rig_list']:
+                    if collection_name == "All":
+                        a = id_store.rigify_types.add()
+                        a.name = r
+                    elif r.startswith(collection_name + '.'):
+                        a = id_store.rigify_types.add()
+                        a.name = r
+                    elif (collection_name == "None") and ("." not in r):
+                        a = id_store.rigify_types.add()
+                        a.name = r
+
             # Rig type list
             row = layout.row()
             row.template_list("UI_UL_list", "rigify_types", id_store, "rigify_types", id_store, 'rigify_active_type')
@@ -598,14 +610,32 @@ def draw(self, context):
                 a = id_store.rigify_types.add()
                 a.name = r
 
+        if 'external' in rig_lists.rigs_dict:
+            for r in rig_lists.rigs_dict['external']['rig_list']:
+                if r in rig_lists.rigs_dict['external']['implementation_rigs']:
+                    continue
+                if collection_name == "All":
+                    a = id_store.rigify_types.add()
+                    a.name = r
+                elif r.startswith(collection_name + '.'):
+                    a = id_store.rigify_types.add()
+                    a.name = r
+                elif collection_name == "None" and len(r.split('.')) == 1:
+                    a = id_store.rigify_types.add()
+                    a.name = r
+
         # Rig type field
         row = layout.row()
         row.prop_search(bone, "rigify_type", id_store, "rigify_types", text="Rig type:")
 
         # Rig type parameters / Rig type non-exist alert
         if rig_name != "":
             try:
-                rig = get_rig_type(rig_name)
+                if rig_name in rig_lists.rigs_dict['external']['rig_list']:
+                    custom_rigs_folder = bpy.context.user_preferences.addons['rigify'].preferences.custom_rigs_folder
+                    rig = get_rig_type(rig_name, custom_rigs_folder)
+                else:
+                    rig = get_rig_type(rig_name)
                 rig.Rig
             except (ImportError, AttributeError):
                 row = layout.row()
@@ -812,7 +842,11 @@ def execute(self, context):
             use_global_undo = context.user_preferences.edit.use_global_undo
             context.user_preferences.edit.use_global_undo = False
             try:
-                rig = get_rig_type(self.metarig_type)
+                if 'external' in rig_lists.rigs_dict and self.metarig_type in rig_lists.rigs_dict['external']['rig_list']:
+                    custom_rigs_folder = bpy.context.user_preferences.addons['rigify'].preferences.custom_rigs_folder
+                    rig = get_rig_type(self.metarig_type, custom_rigs_folder)
+                else:
+                    rig = get_rig_type(self.metarig_type)
                 create_sample = rig.create_sample
             except (ImportError, AttributeError):
                 raise Exception("rig type '" + self.metarig_type + "' has no sample.")

utils.py

@@ -21,6 +21,7 @@
 import bpy
 import imp
 import importlib
+import importlib.util
 import math
 import random
 import time
@@ -904,12 +905,19 @@ def copy_attributes(a, b):
                 pass
 
 
-def get_rig_type(rig_type):
+def get_rig_type(rig_type, base_path=''):
     """ Fetches a rig module by name, and returns it.
     """
-    name = ".%s.%s" % (RIG_DIR, rig_type)
-    submod = importlib.import_module(name, package=MODULE_NAME)
-    importlib.reload(submod)
+    if not base_path:
+        name = ".%s.%s" % (RIG_DIR, rig_type)
+        submod = importlib.import_module(name, package=MODULE_NAME)
+        importlib.reload(submod)
+    else:
+        if '.' in rig_type:
+            rig_type = str.join(os.sep, rig_type.split('.'))
+        spec = importlib.util.spec_from_file_location(rig_type, base_path + rig_type + '.py')
+        submod = importlib.util.module_from_spec(spec)
+        spec.loader.exec_module(submod)
     return submod