(Temporary) Add support for Majora's Mask

.gitignore

@@ -5,3 +5,6 @@ __pycache__/
 fast64_updater/
 .python-version
 .idea
+
+# temp? just exporting my stuff in my fast64 clone because reasons
+export/

README.md

@@ -22,7 +22,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 and Majora's Mask ](/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.

__init__.py

@@ -1,4 +1,6 @@
 import bpy
+from .fast64_internal.game_data import game_data
+
 from bpy.utils import register_class, unregister_class
 from bpy.path import abspath
 
@@ -19,10 +21,10 @@
 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.oot.actor.properties import initOOTActorProperties
+from .fast64_internal.z64 import OOT_Properties, oot_register, oot_unregister, z64_register_on_enable
+from .fast64_internal.z64.constants import oot_world_defaults
+from .fast64_internal.z64.props_panel_main import OOT_ObjectProperties
+from .fast64_internal.z64.utility import getObjectList
 from .fast64_internal.utility_anim import utility_anim_register, utility_anim_unregister, ArmatureApplyWithMeshOperator
 
 from .fast64_internal.mk64 import MK64_Properties, mk64_register, mk64_unregister
@@ -59,7 +61,7 @@
 # info about add on
 bl_info = {
     "name": "Fast64",
-    "version": (2, 3, 0),
+    "version": (2, 3, 1),
     "author": "kurethedead",
     "location": "3DView",
     "description": "Plugin for exporting F3D display lists and other game data related to Nintendo 64 games.",
@@ -70,6 +72,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),
 )
@@ -241,6 +244,9 @@ class Fast64_Properties(bpy.types.PropertyGroup):
     settings: bpy.props.PointerProperty(type=Fast64Settings_Properties, name="Fast64 Settings")
     renderSettings: bpy.props.PointerProperty(type=Fast64RenderSettings_Properties, name="Fast64 Render Settings")
 
+    def get_addon_version(self):
+        return bl_info["version"]
+
 
 class Fast64_BoneProperties(bpy.types.PropertyGroup):
     """
@@ -299,24 +305,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__
 
@@ -371,6 +359,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)
@@ -396,7 +386,7 @@ def set_game_defaults(scene: bpy.types.Scene, set_ucode=True):
     elif scene.gameEditorMode == "MK64":
         f3d_type = "F3DEX"
         world_defaults = mk64_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":
@@ -406,13 +396,25 @@ def set_game_defaults(scene: bpy.types.Scene, set_ucode=True):
         world_defaults = {}  # This will set some pretty bad defaults, but trust the user
     if set_ucode:
         scene.f3d_type = f3d_type
-    if scene.world is not None:
+    if scene.world is not None and world_defaults is not None:
         scene.world.rdp_defaults.from_dict(world_defaults)
 
 
 def gameEditorUpdate(scene: bpy.types.Scene, _context):
+    game_data.update(scene.gameEditorMode)
     set_game_defaults(scene)
 
+    # reset `currentCutsceneIndex` when switching games
+    if scene.gameEditorMode in {"OOT", "MM"}:
+        for scene_obj in bpy.data.objects:
+            scene_obj.ootAlternateSceneHeaders.currentCutsceneIndex = game_data.z64.cs_index_start
+
+            if scene_obj.type == "EMPTY" and scene_obj.ootEmptyType == "Scene":
+                room_obj_list = getObjectList(scene_obj.children_recursive, "EMPTY", "Room")
+
+                for room_obj in room_obj_list:
+                    room_obj.ootAlternateRoomHeaders.currentCutsceneIndex = game_data.z64.cs_index_start
+
 
 # called on add-on enabling
 # register operators and panels here
@@ -435,17 +437,19 @@ def register():
     register_class(ExampleAddonPreferences)
     addon_updater_ops.register(bl_info)
 
-    initOOTActorProperties()
     utility_anim_register()
     mat_register()
     render_engine_register()
     bsdf_conv_register()
     sm64_register(True)
-    oot_register(True)
+    oot_register(True, True)
     mk64_register(True)
 
     repo_settings_operators_register()
 
+    for cls in z64_register_on_enable:
+        register_class(cls)
+
     for cls in classes:
         register_class(cls)
 
@@ -488,7 +492,7 @@ def unregister():
     f3d_writer_unregister()
     f3d_parser_unregister()
     sm64_unregister(True)
-    oot_unregister(True)
+    oot_unregister(True, True)
     mk64_unregister(True)
     mat_unregister()
     bsdf_conv_unregister()
@@ -508,7 +512,10 @@ def unregister():
 
     repo_settings_operators_unregister()
 
-    for cls in classes:
+    for cls in reversed(classes):
+        unregister_class(cls)
+
+    for cls in reversed(z64_register_on_enable):
         unregister_class(cls)
 
     bpy.app.handlers.load_post.remove(after_load)

fast64_internal/data/__init__.py

@@ -0,0 +1,2 @@
+from .z64.data import Z64_Data
+from .z64.object_data import Z64_ObjectData

fast64_internal/oot/data/oot_actor_data.py → fast64_internal/data/z64/actor_data.py

@@ -1,11 +1,11 @@
 from os import path
 from dataclasses import dataclass
-from .oot_getters import getXMLRoot
-from .oot_data import OoT_BaseElement
+from pathlib import Path
+from .common import Z64_BaseElement, get_xml_root
 
 
 @dataclass
-class OoT_ParameterElement:
+class Z64_ParameterElement:
     type: str  # bool, enum, type, property, etc...
     index: int
     mask: int
@@ -18,50 +18,50 @@ class OoT_ParameterElement:
 
 
 @dataclass
-class OoT_ListElement:
+class Z64_ListElement:
     key: str
     name: str
     value: int
 
 
 @dataclass
-class OoT_ActorElement(OoT_BaseElement):
+class Z64_ActorElement(Z64_BaseElement):
     category: str
     tiedObjects: list[str]
-    params: list[OoT_ParameterElement]
+    params: list[Z64_ParameterElement]
 
 
-class OoT_ActorData:
+class Z64_ActorData:
     """Everything related to OoT Actors"""
 
-    def __init__(self):
+    def __init__(self, game: str):
         # Path to the ``ActorList.xml`` file
-        actorXML = path.dirname(path.abspath(__file__)) + "/xml/ActorList.xml"
-        actorRoot = getXMLRoot(actorXML)
+        xml_path = Path(f"{path.dirname(path.abspath(__file__))}/xml/{game.lower()}_actor_list.xml")
+        actor_root = get_xml_root(xml_path.resolve())
 
         # general actor list
-        self.actorList: list[OoT_ActorElement] = []
+        self.actorList: list[Z64_ActorElement] = []
 
         # list elements
-        self.chestItems: list[OoT_ListElement] = []
-        self.collectibleItems: list[OoT_ListElement] = []
-        self.messageItems: list[OoT_ListElement] = []
+        self.chestItems: list[Z64_ListElement] = []
+        self.collectibleItems: list[Z64_ListElement] = []
+        self.messageItems: list[Z64_ListElement] = []
 
         listNameToList = {
             "Chest Content": self.chestItems,
             "Collectibles": self.collectibleItems,
             "Elf_Msg Message ID": self.messageItems,
         }
 
-        for elem in actorRoot.iterfind("List"):
+        for elem in actor_root.iterfind("List"):
             listName = elem.get("Name")
             if listName is not None:
                 for item in elem:
                     listNameToList[listName].append(
-                        OoT_ListElement(item.get("Key"), item.get("Name"), int(item.get("Value"), base=16))
+                        Z64_ListElement(item.get("Key"), item.get("Name"), int(item.get("Value"), base=16))
                     )
 
-        for actor in actorRoot.iterfind("Actor"):
+        for actor in actor_root.iterfind("Actor"):
             tiedObjects = []
             objKey = actor.get("ObjectKey")
             actorName = f"{actor.attrib['Name']} - {actor.attrib['ID'].removeprefix('ACTOR_')}"
@@ -70,7 +70,7 @@ def __init__(self):
                 tiedObjects = objKey.split(",")
 
             # parameters
-            params: list[OoT_ParameterElement] = []
+            params: list[Z64_ParameterElement] = []
             for elem in actor:
                 elemType = elem.tag
                 if elemType != "Notes":
@@ -91,7 +91,7 @@ def __init__(self):
                     defaultName = f"{elem.get('Type')} {elemType}"
                     valueRange = elem.get("ValueRange")
                     params.append(
-                        OoT_ParameterElement(
+                        Z64_ParameterElement(
                             elemType,
                             int(elem.get("Index", "1")),
                             int(elem.get("Mask", "0xFFFF"), base=16),
@@ -105,7 +105,7 @@ def __init__(self):
                     )
 
             self.actorList.append(
-                OoT_ActorElement(
+                Z64_ActorElement(
                     actor.attrib["ID"],
                     actor.attrib["Key"],
                     actorName,
@@ -129,7 +129,7 @@ def __init__(self):
 
         # list of tuples used by Blender's enum properties
 
-        lastIndex = max(1, *(actor.index for actor in self.actorList))
+        lastIndex = max(1, *(actor.index for actor in self.actorList)) + 1
         self.ootEnumActorID = [("None", f"{i} (Deleted from the XML)", "None") for i in range(lastIndex)]
         self.ootEnumActorID.insert(0, ("Custom", "Custom Actor", "Custom"))
 
@@ -142,7 +142,7 @@ def __init__(self):
 
         i = 1
         for actor in self.actorList:
-            self.ootEnumActorID[actor.index] = (actor.id, actor.name, actor.id)
+            self.ootEnumActorID[actor.index + 1] = (actor.id, actor.name, actor.id)
             if actor.category == "ACTORCAT_DOOR":
                 self.ootEnumTransitionActorID[i] = (actor.id, actor.name, actor.id)
                 i += 1

fast64_internal/oot/data/oot_getters.py → fast64_internal/data/z64/common.py

@@ -1,7 +1,16 @@
 from xml.etree.ElementTree import parse as parseXML, Element
+from dataclasses import dataclass
 
 
-def getXMLRoot(xmlPath: str) -> Element:
+@dataclass
+class Z64_BaseElement:
+    id: str
+    key: str
+    name: str
+    index: int
+
+
+def get_xml_root(xmlPath: str) -> Element:
     """Parse an XML file and return its root element"""
     try:
         return parseXML(xmlPath).getroot()