[SM64] Settings Rework

__init__.py

@@ -1,15 +1,23 @@
 import bpy
 from bpy.utils import register_class, unregister_class
+from bpy.path import abspath
+
 from . import addon_updater_ops
-from .fast64_internal.operators import AddWaterBox
-from .fast64_internal.panels import SM64_Panel
-from .fast64_internal.utility import PluginError, raisePluginError, attemptModifierApply, prop_split, multilineLabel
 
-from .fast64_internal.sm64 import SM64_Properties, sm64_register, sm64_unregister
+from .fast64_internal.utility import filepath_ui_warnings, prop_split, multilineLabel
+
+from .fast64_internal.repo_settings import (
+    SM64_LoadRepoSettings,
+    SM64_SaveRepoSettings,
+    load_repo_settings,
+    repo_settings_operators_register,
+    repo_settings_operators_unregister,
+)
+
+from .fast64_internal.sm64.settings.properties import SM64_Properties
+from .fast64_internal.sm64 import sm64_register, sm64_unregister
 from .fast64_internal.sm64.sm64_geolayout_bone import SM64_BoneProperties
 from .fast64_internal.sm64.sm64_objects import SM64_ObjectProperties
-from .fast64_internal.sm64.sm64_geolayout_utility import createBoneGroups
-from .fast64_internal.sm64.sm64_geolayout_parser import generateMetarig
 
 from .fast64_internal.oot import OOT_Properties, oot_register, oot_unregister
 from .fast64_internal.oot.props_panel_main import OOT_ObjectProperties
@@ -54,97 +62,6 @@
 )
 
 
-class AddBoneGroups(bpy.types.Operator):
-    # set bl_ properties
-    bl_description = (
-        "Add bone groups respresenting other node types in " + "SM64 geolayouts (ex. Shadow, Switch, Function)."
-    )
-    bl_idname = "object.add_bone_groups"
-    bl_label = "Add Bone Groups"
-    bl_options = {"REGISTER", "UNDO", "PRESET"}
-
-    # Called on demand (i.e. button press, menu item)
-    # Can also be called from operator search menu (Spacebar)
-    def execute(self, context):
-        try:
-            if context.mode != "OBJECT" and context.mode != "POSE":
-                raise PluginError("Operator can only be used in object or pose mode.")
-            elif context.mode == "POSE":
-                bpy.ops.object.mode_set(mode="OBJECT")
-
-            if len(context.selected_objects) == 0:
-                raise PluginError("Armature not selected.")
-            elif type(context.selected_objects[0].data) is not bpy.types.Armature:
-                raise PluginError("Armature not selected.")
-
-            armatureObj = context.selected_objects[0]
-            createBoneGroups(armatureObj)
-        except Exception as e:
-            raisePluginError(self, e)
-            return {"CANCELLED"}
-
-        self.report({"INFO"}, "Created bone groups.")
-        return {"FINISHED"}  # must return a set
-
-
-class CreateMetarig(bpy.types.Operator):
-    # set bl_ properties
-    bl_description = (
-        "SM64 imported armatures are usually not good for "
-        + "rigging. There are often intermediate bones between deform bones "
-        + "and they don't usually point to their children. This operator "
-        + "creates a metarig on armature layer 4 useful for IK."
-    )
-    bl_idname = "object.create_metarig"
-    bl_label = "Create Animatable Metarig"
-    bl_options = {"REGISTER", "UNDO", "PRESET"}
-
-    # Called on demand (i.e. button press, menu item)
-    # Can also be called from operator search menu (Spacebar)
-    def execute(self, context):
-        try:
-            if context.mode != "OBJECT":
-                bpy.ops.object.mode_set(mode="OBJECT")
-
-            if len(context.selected_objects) == 0:
-                raise PluginError("Armature not selected.")
-            elif type(context.selected_objects[0].data) is not bpy.types.Armature:
-                raise PluginError("Armature not selected.")
-
-            armatureObj = context.selected_objects[0]
-            generateMetarig(armatureObj)
-        except Exception as e:
-            raisePluginError(self, e)
-            return {"CANCELLED"}
-
-        self.report({"INFO"}, "Created metarig.")
-        return {"FINISHED"}  # must return a set
-
-
-class SM64_AddWaterBox(AddWaterBox):
-    bl_idname = "object.sm64_add_water_box"
-
-    scale: bpy.props.FloatProperty(default=10)
-    preset: bpy.props.StringProperty(default="Shaded Solid")
-    matName: bpy.props.StringProperty(default="sm64_water_mat")
-
-    def setEmptyType(self, emptyObj):
-        emptyObj.sm64_obj_type = "Water Box"
-
-
-class SM64_ArmatureToolsPanel(SM64_Panel):
-    bl_idname = "SM64_PT_armature_tools"
-    bl_label = "SM64 Tools"
-
-    # called every frame
-    def draw(self, context):
-        col = self.layout.column()
-        col.operator(ArmatureApplyWithMeshOperator.bl_idname)
-        col.operator(AddBoneGroups.bl_idname)
-        col.operator(CreateMetarig.bl_idname)
-        col.operator(SM64_AddWaterBox.bl_idname)
-
-
 class F3D_GlobalSettingsPanel(bpy.types.Panel):
     bl_idname = "F3D_PT_global_settings"
     bl_label = "F3D Global Settings"
@@ -201,14 +118,52 @@ class Fast64_GlobalSettingsPanel(bpy.types.Panel):
     def poll(cls, context):
         return True
 
+    def draw_repo_settings(self, layout, context):
+        col = layout.column()
+
+        scene = context.scene
+        fast64_settings = scene.fast64.settings
+
+        col.prop(
+            fast64_settings,
+            "repo_settings_tab",
+            text="Repo Settings",
+            icon="TRIA_DOWN" if fast64_settings.repo_settings_tab else "TRIA_RIGHT",
+        )
+        if not fast64_settings.repo_settings_tab:
+            return
+
+        col.box().label(text="World defaults will be saved and loaded.")
+
+        prop_split(col, fast64_settings, "repo_settings_path", "Repo Settings Path")
+
+        path = abspath(fast64_settings.repo_settings_path)
+        if filepath_ui_warnings(col, path):
+            load_op = col.operator(SM64_LoadRepoSettings.bl_idname)
+            load_op.path = fast64_settings.repo_settings_path
+
+        save_op = col.operator(SM64_SaveRepoSettings.bl_idname)
+        save_op.path = fast64_settings.repo_settings_path
+
+        prop_split(col, scene, "f3d_type", "F3D Microcode")
+        col.prop(scene, "saveTextures")
+        col.prop(fast64_settings, "auto_repo_load_settings")
+
     # called every frame
     def draw(self, context):
         col = self.layout.column()
         col.scale_y = 1.1  # extra padding
-        prop_split(col, context.scene, "gameEditorMode", "Game")
-        col.prop(context.scene, "exportHiddenGeometry")
-        col.prop(context.scene, "fullTraceback")
-        prop_split(col, context.scene.fast64.settings, "anim_range_choice", "Anim Range")
+
+        scene = context.scene
+        fast64_settings = scene.fast64.settings
+
+        prop_split(col, scene, "gameEditorMode", "Game")
+        col.prop(scene, "exportHiddenGeometry")
+        col.prop(scene, "fullTraceback")
+
+        prop_split(col, fast64_settings, "anim_range_choice", "Anim Range")
+
+        self.draw_repo_settings(col.box(), context)
 
 
 class Fast64_GlobalToolsPanel(bpy.types.Panel):
@@ -231,6 +186,10 @@ def draw(self, context):
         addon_updater_ops.update_notice_box_ui(self, context)
 
 
+def repo_path_update(self, context):
+    load_repo_settings(context.scene, abspath(self.repo_settings_path), True)
+
+
 class Fast64Settings_Properties(bpy.types.PropertyGroup):
     """Settings affecting exports for all games found in scene.fast64.settings"""
 
@@ -264,6 +223,16 @@ class Fast64Settings_Properties(bpy.types.PropertyGroup):
         default="intersect_action_and_scene",
     )
 
+    repo_settings_tab: bpy.props.BoolProperty(default=True)
+    repo_settings_path: bpy.props.StringProperty(
+        name="Repo Settings Path", subtype="FILE_PATH", update=repo_path_update
+    )
+    auto_repo_load_settings: bpy.props.BoolProperty(
+        name="Auto Load Repo's Settings",
+        description="When enabled, this will make fast64 automatically load repo settings if they are found after picking a decomp path",
+        default=True,
+    )
+
 
 class Fast64_Properties(bpy.types.PropertyGroup):
     """
@@ -384,13 +353,9 @@ def draw(self, context):
     Fast64_Properties,
     Fast64_BoneProperties,
     Fast64_ObjectProperties,
-    AddBoneGroups,
-    CreateMetarig,
-    SM64_AddWaterBox,
     # Fast64_GlobalObjectPanel,
     F3D_GlobalSettingsPanel,
     Fast64_GlobalSettingsPanel,
-    SM64_ArmatureToolsPanel,
     Fast64_GlobalToolsPanel,
     UpgradeF3DMaterialsDialog,
 )
@@ -452,6 +417,8 @@ def register():
     sm64_register(True)
     oot_register(True)
 
+    repo_settings_operators_register()
+
     for cls in classes:
         register_class(cls)
 
@@ -515,6 +482,8 @@ def unregister():
     del bpy.types.Bone.fast64
     del bpy.types.Object.fast64
 
+    repo_settings_operators_unregister()
+
     for cls in classes:
         unregister_class(cls)
 

fast64-animations_updater/fast64-animations_updater_status.json

@@ -0,0 +1,9 @@
+{
+    "last_check": "",
+    "backup_date": "",
+    "update_ready": false,
+    "ignore": false,
+    "just_restored": false,
+    "just_updated": false,
+    "version_text": {}
+}

fast64_internal/f3d/f3d_material.py

@@ -2099,10 +2099,6 @@ def load_handler(dummy):
 
 bpy.app.handlers.load_post.append(load_handler)
 
-# bpy.context.mode returns the keys here, while the values are required by bpy.ops.object.mode_set
-BLENDER_MODE_TO_MODE_SET = {"PAINT_VERTEX": "VERTEX_PAINT", "EDIT_MESH": "EDIT"}
-get_mode_set_from_context_mode = lambda mode: BLENDER_MODE_TO_MODE_SET.get(mode, "OBJECT")
-
 SCENE_PROPERTIES_VERSION = 1
 
 
@@ -2288,6 +2284,20 @@ def addColorAttributesToModel(obj: Object):
         bpy.ops.object.mode_set(mode=get_mode_set_from_context_mode(prevMode))
 
 
+def add_f3d_mat_to_obj(obj: bpy.types.Object, material, index=None):
+    # add material to object
+    if obj is not None:
+        addColorAttributesToModel(obj)
+        if index is None:
+            obj.data.materials.append(material)
+            if bpy.context.object is not None:
+                bpy.context.object.active_material_index = len(obj.material_slots) - 1
+        else:
+            obj.material_slots[index].material = material
+            if bpy.context.object is not None:
+                bpy.context.object.active_material_index = index
+
+
 def createF3DMat(obj: Object | None, preset="Shaded Solid", index=None):
     # link all node_groups + material from addon's data .blend
     link_f3d_material_library()
@@ -2302,17 +2312,7 @@ def createF3DMat(obj: Object | None, preset="Shaded Solid", index=None):
 
     createScenePropertiesForMaterial(material)
 
-    # add material to object
-    if obj is not None:
-        addColorAttributesToModel(obj)
-        if index is None:
-            obj.data.materials.append(material)
-            if bpy.context.object is not None:
-                bpy.context.object.active_material_index = len(obj.material_slots) - 1
-        else:
-            obj.material_slots[index].material = material
-            if bpy.context.object is not None:
-                bpy.context.object.active_material_index = index
+    add_f3d_mat_to_obj(obj, material, index)
 
     material.is_f3d = True
     material.mat_ver = 5

fast64_internal/f3d/f3d_parser.py

@@ -185,9 +185,9 @@ def getPosition(vertexBuffer, index):
     yBytes = vertexBuffer[yStart : yStart + 2]
     zBytes = vertexBuffer[zStart : zStart + 2]
 
-    x = int.from_bytes(xBytes, "big", signed=True) / bpy.context.scene.blenderToSM64Scale
-    y = int.from_bytes(yBytes, "big", signed=True) / bpy.context.scene.blenderToSM64Scale
-    z = int.from_bytes(zBytes, "big", signed=True) / bpy.context.scene.blenderToSM64Scale
+    x = int.from_bytes(xBytes, "big", signed=True) / bpy.context.scene.fast64.sm64.blender_to_sm64_scale
+    y = int.from_bytes(yBytes, "big", signed=True) / bpy.context.scene.fast64.sm64.blender_to_sm64_scale
+    z = int.from_bytes(zBytes, "big", signed=True) / bpy.context.scene.fast64.sm64.blender_to_sm64_scale
 
     return (x, y, z)
 

fast64_internal/panels.py

@@ -1,39 +1,31 @@
 
 import bpy
 
-sm64GoalImport = 'Import' # Not in enum, separate UI option
-sm64GoalTypeEnum = [
-	('All', 'All', 'All'),
-	('Export Object/Actor/Anim', 'Export Object/Actor/Anim', 'Export Object/Actor/Anim'),
-	('Export Level', 'Export Level', 'Export Level'),
-	('Export Displaylist', 'Export Displaylist', 'Export Displaylist'),
-	('Export UI Image', 'Export UI Image', 'Export UI Image'),
-]
-
 class SM64_Panel(bpy.types.Panel):
     bl_space_type = 'VIEW_3D'
     bl_region_type = 'UI'
     bl_category = 'SM64'
     bl_options = {'DEFAULT_CLOSED'}
-    # goal refers to the selected sm64GoalTypeEnum, a different selection than this goal will filter this panel out
+    # goal refers to the selected enum_sm64_goal_type, a different selection than this goal will filter this panel out
+    # "Import" is not in the enum, as it is a separate UI option
     goal = None
-    # if this is True, the panel is hidden whenever the scene's exportType is not 'C'
+    # if this is True, the panel is hidden whenever the scene's export_type is not 'C'
     decomp_only = False
 
     @classmethod
     def poll(cls, context):
-        sm64Props = bpy.context.scene.fast64.sm64
+        sm64_props = context.scene.fast64.sm64
         if context.scene.gameEditorMode != 'SM64':
             return False
         elif not cls.goal:
             return True # Panel should always be shown
-        elif cls.goal == sm64GoalImport:
+        elif cls.goal == "Import":
             # Only show if importing is enabled
-            return sm64Props.showImportingMenus
-        elif cls.decomp_only and sm64Props.exportType != 'C':
+            return sm64_props.show_importing_menus
+        elif cls.decomp_only and sm64_props.export_type != 'C':
             return False
 
-        sceneGoal = sm64Props.goal
+        sceneGoal = sm64_props.goal
         return sceneGoal == 'All' or sceneGoal == cls.goal
 
 class OOT_Panel(bpy.types.Panel):