WIP Merge upstream

README.md

@@ -11,13 +11,11 @@ Forked from [kurethedead/fast64 on BitBucket](https://bitbucket.org/kurethedead/
 
 This is a Blender plugin that allows one to export F3D display lists. It also has the ability to export assets for Super Mario 64 and Ocarina of Time decompilation projects. It supports custom color combiners / geometry modes / etc. It is also possible to use exported C code in homebrew applications.
 
-Make sure to save often, as this plugin is prone to crashing when creating materials / undoing material creation. This is a Blender issue.
-
-<https://developer.blender.org/T70574>
+Make sure to save often, as this plugin is prone to crashing when creating materials / undoing material creation. [This is a Blender issue](https://developer.blender.org/T70574).
 
 ### Example models can be found [here](https://github.com/Fast-64/fast64-models)
 
-![alt-text](/images/mat_inspector.png)
+Fast64 features an updater (which can also be used to try out in testing features and bugfixes), [follow these instructions to use it](https://fast64.readthedocs.io/en/latest/common/updater/updater.html)
 
 ### Credits
 Thanks to anonymous_moose, Cheezepin, Rovert, and especially InTheBeef for testing.
@@ -27,7 +25,7 @@ We have a Discord server for support as well as development [here](https://disco
 
 ### Links to Docs / Guides for Each Game
 1. [ Super Mario 64 ](/fast64_internal/sm64/README.md)
-2. [ Ocarina Of Time ](/fast64_internal/oot/README.md)
+2. [ Ocarina Of Time ](/fast64_internal/z64/README.md)
 
 ### Installation
 Download the repository as a zip file. In Blender, go to Edit -> Preferences -> Add-Ons and click the "Install" button to install the plugin from the zip file. Find the Fast64 addon in the addon list and enable it. If it does not show up, go to Edit -> Preferences -> Save&Load and make sure 'Auto Run Python Scripts' is enabled.
@@ -48,6 +46,12 @@ In F3D material properties, you can enable "Large Texture Mode". This will let y
 ### Decomp vs Homebrew Compatibility
 There may occur cases where code is formatted differently based on the code use case. In the tools panel under the Fast64 File Settings subheader, you can toggle homebrew compatibility.
 
+### glTF 2.0 Support
+Fast64 supports several extensions for glTF 2.0 that can be exported and imported via the glTF 2.0 io addon integrated in blender via hooks. It also implements hacks for broken versions of the addon.
+
+Currently only basic n64 material properties and F3D properties are supported, but extensions for game modes like SM64 and OOT can be added in the future.
+See the [glTF README](/fast64_internal/f3d/glTF/README.md) for details and schemas.
+
 ### Converting To F3D v5 Materials
 A new optimized shader graph was introduced to decrease processing times for material creation and exporting. If you have a project that still uses old materials, you may want to convert them to v5. To convert an old project, click the "Recreate F3D Materials As V5" operator near the top of the Fast64 tab in 3D view. This may take a while depending on the number of materials in the project. Then go to the outliner, change the display mode to "Orphan Data" (broken heart icon), then click "Purge" in the top right corner. Purge multiple times until all of the old node groups are gone.
 
@@ -66,27 +70,7 @@ Selecting F3DEX3 as your microcode unlocks a large number of additional presets
 
 For cel shading, it is recommended to start with one of the cel shading presets, then modify the settings under the `Use Cel Shading` panel. Hover over each UI control for additional information about how that setting works.
 
-### Updater
-
-Fast64 features an updater ([CGCookie/blender-addon-updater](https://github.com/CGCookie/blender-addon-updater)).
-
-It can be found in the addon preferences:
-
-![How the updater in the addon preferences looks, right after addon install](/images/updater_initially.png)
-
-Click the "Check now for fast64 update" button to check for updates.
-
-![Updater preferences after clicking the "check for updates" button](/images/updater_after_check.png)
-
-Click "Install main / old version" and choose "Main" if it isn't already selected:
-
-![Updater: install main](/images/updater_install_main.png)
-
-Click OK, there should be a message "Addon successfully installed" and prompting you to restart Blender:
-
-![Updater: successful install, must restart](/images/updater_success_restart.png)
-
-Clicking the red button will close Blender. After restarting, fast64 will be up-to-date with the latest main revision.
+### [Repo Settings](https://fast64.readthedocs.io/en/latest/common/repo_settings/repo_settings.html)
 
 ### Fast64 Development
 If you'd like to develop in VSCode, follow this tutorial to get proper autocomplete. Skip the linter for now, we'll need to make sure the entire project gets linted before enabling autosave linting because the changes will be massive.

__init__.py

@@ -1,10 +1,12 @@
 import bpy
+
 from bpy.utils import register_class, unregister_class
 from bpy.path import abspath
 
 from . import addon_updater_ops
 
-from .fast64_internal.utility import prop_split, multilineLabel, draw_and_check_tab
+from .fast64_internal.game_data import game_data
+from .fast64_internal.utility import prop_split, multilineLabel, set_prop_if_in_data, Matrix4x4Property
 
 from .fast64_internal.repo_settings import (
     draw_repo_settings,
@@ -13,15 +15,16 @@
     repo_settings_operators_unregister,
 )
 
-from .fast64_internal.sm64 import sm64_register, sm64_unregister
+from .fast64_internal.sm64 import sm64_register, sm64_unregister, SM64_ActionProperty
 from .fast64_internal.sm64.sm64_constants import sm64_world_defaults
 from .fast64_internal.sm64.settings.properties import SM64_Properties
 from .fast64_internal.sm64.sm64_geolayout_bone import SM64_BoneProperties
 from .fast64_internal.sm64.sm64_objects import SM64_ObjectProperties
 
-from .fast64_internal.oot import OOT_Properties, oot_register, oot_unregister
-from .fast64_internal.oot.oot_constants import oot_world_defaults
-from .fast64_internal.oot.props_panel_main import OOT_ObjectProperties
+from .fast64_internal.z64 import OOT_Properties, oot_register, oot_unregister
+from .fast64_internal.z64.constants import oot_world_defaults
+from .fast64_internal.z64.props_panel_main import OOT_ObjectProperties
+from .fast64_internal.z64.actor.properties import initOOTActorProperties
 from .fast64_internal.utility_anim import utility_anim_register, utility_anim_unregister, ArmatureApplyWithMeshOperator
 
 from .fast64_internal.mk64.mk64_constants import mk64_world_defaults
@@ -34,7 +37,6 @@
     mat_unregister,
     check_or_ask_color_management,
 )
-from .fast64_internal.f3d.f3d_render_engine import render_engine_register, render_engine_unregister
 from .fast64_internal.f3d.f3d_writer import f3d_writer_register, f3d_writer_unregister
 from .fast64_internal.f3d.f3d_parser import f3d_parser_register, f3d_parser_unregister
 from .fast64_internal.f3d.flipbook import flipbook_register, flipbook_unregister
@@ -56,10 +58,19 @@
     on_update_render_settings,
 )
 
+from .fast64_internal.gltf_extension import (
+    glTF2ExportUserExtension,  # Import these so they are visible to the glTF add-on
+    glTF2ImportUserExtension,
+    glTF2_pre_export_callback,
+    Fast64GlTFSettings,
+    gltf_extension_register,
+    gltf_extension_unregister,
+)
+
 # info about add on
 bl_info = {
     "name": "Fast64 (HM64)",
-    "version": (2, 3, 0),
+    "version": (2, 4, 0),
     "author": "kurethedead",
     "location": "3DView",
     "description": "Plugin for exporting F3D display lists and other game data related to Nintendo 64 games.",
@@ -70,6 +81,7 @@
 gameEditorEnum = (
     ("SM64", "SM64", "Super Mario 64", 0),
     ("OOT", "OOT", "Ocarina Of Time", 1),
+    # ("MM", "MM", "Majora's Mask", 4),
     ("MK64", "MK64", "Mario Kart 64", 3),
     ("Homebrew", "Homebrew", "Homebrew", 2),
 )
@@ -90,7 +102,9 @@ def poll(cls, context):
     def draw(self, context):
         col = self.layout.column()
         col.scale_y = 1.1  # extra padding
-        prop_split(col, context.scene, "f3d_type", "F3D Microcode")
+        prop_split(col, context.scene, "f3d_type", "Microcode")
+        if context.scene.f3d_type in {"F3DEX3", "T3D"}:
+            prop_split(col, context.scene, "packed_normals_algorithm", "Packed normals alg")
         col.prop(context.scene, "saveTextures")
         col.prop(context.scene, "f3d_simple", text="Simple Material UI")
         col.prop(context.scene, "exportInlineF3D", text="Bleed and Inline Material Exports")
@@ -166,6 +180,8 @@ class Fast64Settings_Properties(bpy.types.PropertyGroup):
 
     version: bpy.props.IntProperty(name="Fast64Settings_Properties Version", default=0)
 
+    glTF: bpy.props.PointerProperty(type=Fast64GlTFSettings, name="glTF Properties")
+
     anim_range_choice: bpy.props.EnumProperty(
         name="Anim Range",
         description="What to use to determine what frames of the animation to export",
@@ -215,6 +231,19 @@ class Fast64Settings_Properties(bpy.types.PropertyGroup):
 
     internal_game_update_ver: bpy.props.IntProperty(default=0)
 
+    def to_repo_settings(self):
+        data = {}
+        data["autoLoad"] = self.auto_repo_load_settings
+        data["autoPickTextureFormat"] = self.auto_pick_texture_format
+        if self.auto_pick_texture_format:
+            data["preferRGBAOverCI"] = self.prefer_rgba_over_ci
+        return data
+
+    def from_repo_settings(self, data: dict):
+        set_prop_if_in_data(self, "auto_repo_load_settings", data, "autoLoad")
+        set_prop_if_in_data(self, "auto_pick_texture_format", data, "autoPickTextureFormat")
+        set_prop_if_in_data(self, "prefer_rgba_over_ci", data, "preferRGBAOverCI")
+
 
 class Fast64_Properties(bpy.types.PropertyGroup):
     """
@@ -229,6 +258,14 @@ class Fast64_Properties(bpy.types.PropertyGroup):
     renderSettings: bpy.props.PointerProperty(type=Fast64RenderSettings_Properties, name="Fast64 Render Settings")
 
 
+class Fast64_ActionProperties(bpy.types.PropertyGroup):
+    """
+    Properties in Action.fast64.
+    """
+
+    sm64: bpy.props.PointerProperty(type=SM64_ActionProperty, name="SM64 Properties")
+
+
 class Fast64_BoneProperties(bpy.types.PropertyGroup):
     """
     Properties in bone.fast64 (bpy.types.Bone)
@@ -296,24 +333,6 @@ def execute(self, context: "bpy.types.Context"):
         return {"FINISHED"}
 
 
-# def updateGameEditor(scene, context):
-# 	if scene.currentGameEditorMode == 'SM64':
-# 		sm64_panel_unregister()
-# 	elif scene.currentGameEditorMode == 'Z64':
-# 		oot_panel_unregister()
-# 	else:
-# 		raise PluginError("Unhandled game editor mode " + str(scene.currentGameEditorMode))
-#
-# 	if scene.gameEditorMode == 'SM64':
-# 		sm64_panel_register()
-# 	elif scene.gameEditorMode == 'Z64':
-# 		oot_panel_register()
-# 	else:
-# 		raise PluginError("Unhandled game editor mode " + str(scene.gameEditorMode))
-#
-# 	scene.currentGameEditorMode = scene.gameEditorMode
-
-
 class ExampleAddonPreferences(bpy.types.AddonPreferences, addon_updater_ops.AddonUpdaterPreferences):
     bl_idname = __package__
 
@@ -326,6 +345,7 @@ def draw(self, context):
     Fast64RenderSettings_Properties,
     ManualUpdatePreviewOperator,
     Fast64_Properties,
+    Fast64_ActionProperties,
     Fast64_BoneProperties,
     Fast64_ObjectProperties,
     Fast64_CurveProperties,
@@ -339,8 +359,10 @@ def draw(self, context):
 def upgrade_changed_props():
     """Set scene properties after a scene loads, used for migrating old properties"""
     SM64_Properties.upgrade_changed_props()
+    OOT_Properties.upgrade_changed_props()
     MK64_Properties.upgrade_changed_props()
     SM64_ObjectProperties.upgrade_changed_props()
+    SM64_BoneProperties.upgrade_changed_props()
     OOT_ObjectProperties.upgrade_changed_props()
     for scene in bpy.data.scenes:
         settings: Fast64Settings_Properties = scene.fast64.settings
@@ -369,6 +391,8 @@ def upgrade_scene_props_node():
 
 @bpy.app.handlers.persistent
 def after_load(_a, _b):
+    game_data.update(bpy.context.scene.gameEditorMode)
+
     settings = bpy.context.scene.fast64.settings
     if any(mat.is_f3d for mat in bpy.data.materials):
         check_or_ask_color_management(bpy.context)
@@ -391,11 +415,12 @@ def set_game_defaults(scene: bpy.types.Scene, set_ucode=True):
     if scene.gameEditorMode == "SM64":
         f3d_type = "F3D"
         world_defaults = sm64_world_defaults
-    elif scene.gameEditorMode == "OOT":
+    elif scene.gameEditorMode in {"OOT", "MM"}:
         f3d_type = "F3DEX2/LX2"
         world_defaults = oot_world_defaults
     elif scene.gameEditorMode == "MK64":
         f3d_type = "F3DEX/LX"
+        world_defaults = mk64_world_defaults
     elif scene.gameEditorMode == "Homebrew":
         f3d_type = "F3D"
         world_defaults = {}  # This will set some pretty bad defaults, but trust the user
@@ -406,6 +431,7 @@ def set_game_defaults(scene: bpy.types.Scene, set_ucode=True):
 
 
 def gameEditorUpdate(scene: bpy.types.Scene, _context):
+    game_data.update(scene.gameEditorMode)
     set_game_defaults(scene)
 
 
@@ -430,14 +456,17 @@ def register():
     register_class(ExampleAddonPreferences)
     addon_updater_ops.register(bl_info)
 
+    register_class(Matrix4x4Property)
+    initOOTActorProperties()
     utility_anim_register()
     mat_register()
-    render_engine_register()
     bsdf_conv_register()
     sm64_register(True)
     oot_register(True)
     mk64_register(True)
 
+    gltf_extension_register()
+
     repo_settings_operators_register()
 
     for cls in classes:
@@ -471,6 +500,7 @@ def register():
     bpy.types.Bone.fast64 = bpy.props.PointerProperty(type=Fast64_BoneProperties, name="Fast64 Bone Properties")
     bpy.types.Object.fast64 = bpy.props.PointerProperty(type=Fast64_ObjectProperties, name="Fast64 Object Properties")
     bpy.types.Curve.fast64 = bpy.props.PointerProperty(type=Fast64_CurveProperties, name="Fast64 Curve Properties")
+    bpy.types.Action.fast64 = bpy.props.PointerProperty(type=Fast64_ActionProperties, name="Fast64 Action Properties")
 
     bpy.app.handlers.load_post.append(after_load)
 
@@ -486,9 +516,10 @@ def unregister():
     oot_unregister(True)
     mk64_unregister(True)
     mat_unregister()
+    gltf_extension_unregister()
     bsdf_conv_unregister()
     bsdf_conv_panel_unregsiter()
-    render_engine_unregister()
+    unregister_class(Matrix4x4Property)
 
     del bpy.types.Scene.fullTraceback
     del bpy.types.Scene.ignoreTextureRestrictions
@@ -500,6 +531,7 @@ def unregister():
     del bpy.types.Scene.fast64
     del bpy.types.Bone.fast64
     del bpy.types.Object.fast64
+    del bpy.types.Action.fast64
 
     repo_settings_operators_unregister()