Version 0.1.7

mos9527 · mos9527 · commit b3959a2d067c · 2025-02-13T10:35:45.000+08:00
Support custom typetrees
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,4 @@ dist/
 __pycache__/
 *.egg-info
 dump
+test_*
diff --git a/README.md b/README.md
@@ -8,11 +8,14 @@ General purpose [Live2D](https://www.live2d.com/) Asset recovery tool built w/ [
 As the name suggests, this project is heavily inspired by [Perfare/UnityLive2DExtractor](https://github.com/Perfare/UnityLive2DExtractor). With a few key differences:
 - All Live2D types are implemented with [dumped TypeTree](https://github.com/mos9527/UnityPyLive2DExtractor/blob/main/external/typetree_cubism.json) and [generated types](https://github.com/mos9527/UnityPyLive2DExtractor/blob/main/typetree_codegen.py). This should help with compatibility issues.
     - Do note, however, that you may need to update the TypeTree if the Live2D version changes.
-    - Generate the TypeTree with [typetree_codegen](https://github.com/mos9527/UnityPyLive2DExtractor/blob/main/typetree_codegen.py) and replace the existing TypeTree at `UnityPyLive2DExtractor/generated`
+    - Generate the TypeTree with [typetree_codegen](https://github.com/mos9527/UnityPyLive2DExtractor/blob/main/typetree_codegen.py) 
     ```bash
-    python typetree_codegen.py type_tree_cubism.json UnityPyLive2DExtractor/generated
+    python typetree_codegen.py type_tree_cubism.json l2d_generated
+    ```
+    - You can specify the TypeTree module to use. Make sure the generated folder is available in the current directory.
+    ```bash
+    UnityPyLive2DExtractor --module l2d_generated <input> <output>
     ```
-    - Feel free to submit a PR into a new branch if you have found a new TypeTree that worked for you.
 - New (not necessarily better) asset discovery method. Though proven to be more reliable in some cases.
 
 ## Installation
diff --git a/UnityPyLive2DExtractor/__init__.py b/UnityPyLive2DExtractor/__init__.py
@@ -1 +1 @@
-__version__ = (0, 1, 6)
+__version__ = (0, 1, 7)
diff --git a/UnityPyLive2DExtractor/__main__.py b/UnityPyLive2DExtractor/__main__.py
@@ -1,5 +1,5 @@
 import argparse
-import os, io, json
+import os, io, json, importlib
 from zlib import crc32
 import UnityPy
 from typing import TypeVar
@@ -21,8 +21,13 @@
 # TypeTreeHelper.read_typetree_boost = False
 logger = getLogger("UnityPyLive2DExtractor")
 
+from sssekai.fmt.motion3 import to_motion3
+from sssekai.fmt.moc3 import read_moc3
+from sssekai.unity.AnimationClip import AnimationHelper
+
 from UnityPyLive2DExtractor import __version__
-from UnityPyLive2DExtractor.generated import TYPETREE_DEFS
+
+# These are here ONLY for the sake of type hints
 from UnityPyLive2DExtractor.generated.Live2D.Cubism.Core import CubismModel
 from UnityPyLive2DExtractor.generated.Live2D.Cubism.Rendering import CubismRenderer
 from UnityPyLive2DExtractor.generated.Live2D.Cubism.Framework.Physics import (
@@ -35,135 +40,133 @@
     CubismPhysicsRig,
     CubismPhysicsController,
 )
-from sssekai.fmt.motion3 import to_motion3
-from sssekai.fmt.moc3 import read_moc3
-from sssekai.unity.AnimationClip import AnimationHelper
-
 
-def monkey_patch(cls):
-    """ooh ooh aah aah"""
-
-    def wrapper(func):
-        setattr(cls, func.__name__, func)
-        return func
+from dataclasses import dataclass
 
-    return wrapper
 
+@dataclass
+class ExtractorConfig:
+    generated_module: str = "UnityPyLive2DExtractor.generated"
 
-@monkey_patch(CubismPhysicsNormalizationTuplet)
-def dump(self: CubismPhysicsNormalizationTuplet):
-    return {
-        "Maximum": self.Maximum,
-        "Minimum": self.Minimum,
-        "Default": self.Default,
-    }
+    @property
+    def module(self):
+        return __import__(self.generated_module)
 
+    def import_path(self, fullname: str):
+        namespace = ".".join(fullname.split(".")[:-1])
+        classname = fullname.split(".")[-1]
+        cls = importlib.import_module(f".{namespace}", package=self.generated_module)
+        cls = getattr(cls, classname)
+        return cls
 
-@monkey_patch(CubismPhysicsNormalization)
-def dump(self: CubismPhysicsNormalization):
-    return {"Position": self.Position.dump(), "Angle": self.Angle.dump()}
 
+CFG = ExtractorConfig()
 
-@monkey_patch(CubismPhysicsParticle)
-def dump(self: CubismPhysicsParticle):
-    return {
-        "Position": {"X": self.InitialPosition.x, "Y": self.InitialPosition.y},
-        "Mobility": self.Mobility,
-        "Delay": self.Delay,
-        "Acceleration": self.Acceleration,
-        "Radius": self.Radius,
-    }
 
+def patch_all():
+    def monkey_patch(fullname):
+        """ooh ooh aah aah"""
+        cls = CFG.import_path(fullname)
 
-@monkey_patch(CubismPhysicsOutput)
-def dump(self: CubismPhysicsOutput):
-    return {
-        "Destination": {"Target": "Parameter", "Id": self.DestinationId},
-        "VertexIndex": self.ParticleIndex,
-        "Scale": self.AngleScale,
-        "Weight": self.Weight,
-        "Type": ["X", "Y", "Angle"][self.SourceComponent],
-        "Reflect": self.IsInverted,
-    }
+        def wrapper(func):
+            setattr(cls, func.__name__, func)
+            return func
 
+        return wrapper
 
-@monkey_patch(CubismPhysicsInput)
-def dump(self: CubismPhysicsInput):
-    return {
-        "Source": {"Target": "Parameter", "Id": self.SourceId},
-        "Weight": self.Weight,
-        "Type": ["X", "Y", "Angle"][self.SourceComponent],
-        "Reflect": self.IsInverted,
-    }
+    @monkey_patch("Live2D.Cubism.Framework.Physics.CubismPhysicsNormalizationTuplet")
+    def dump(self: CubismPhysicsNormalizationTuplet):
+        return {
+            "Maximum": self.Maximum,
+            "Minimum": self.Minimum,
+            "Default": self.Default,
+        }
 
+    @monkey_patch("Live2D.Cubism.Framework.Physics.CubismPhysicsNormalization")
+    def dump(self: CubismPhysicsNormalization):
+        return {"Position": self.Position.dump(), "Angle": self.Angle.dump()}
+
+    @monkey_patch("Live2D.Cubism.Framework.Physics.CubismPhysicsParticle")
+    def dump(self: CubismPhysicsParticle):
+        return {
+            "Position": {"X": self.InitialPosition.x, "Y": self.InitialPosition.y},
+            "Mobility": self.Mobility,
+            "Delay": self.Delay,
+            "Acceleration": self.Acceleration,
+            "Radius": self.Radius,
+        }
 
-@monkey_patch(CubismPhysicsSubRig)
-def dump(self: CubismPhysicsSubRig):
-    return {
-        "Input": [x.dump() for x in self.Input],
-        "Output": [x.dump() for x in self.Output],
-        "Vertices": [x.dump() for x in self.Particles],
-        "Normalization": self.Normalization.dump(),
-    }
+    @monkey_patch("Live2D.Cubism.Framework.Physics.CubismPhysicsOutput")
+    def dump(self: CubismPhysicsOutput):
+        return {
+            "Destination": {"Target": "Parameter", "Id": self.DestinationId},
+            "VertexIndex": self.ParticleIndex,
+            "Scale": self.AngleScale,
+            "Weight": self.Weight,
+            "Type": ["X", "Y", "Angle"][self.SourceComponent],
+            "Reflect": self.IsInverted,
+        }
 
+    @monkey_patch("Live2D.Cubism.Framework.Physics.CubismPhysicsInput")
+    def dump(self: CubismPhysicsInput):
+        return {
+            "Source": {"Target": "Parameter", "Id": self.SourceId},
+            "Weight": self.Weight,
+            "Type": ["X", "Y", "Angle"][self.SourceComponent],
+            "Reflect": self.IsInverted,
+        }
 
-@monkey_patch(CubismPhysicsRig)
-def dump(self: CubismPhysicsRig):
-    return [
-        {"Id": "PhysicsSetting%d" % (i + 1), **rig.dump()}
-        for i, rig in enumerate(self.SubRigs)
-    ]
+    @monkey_patch("Live2D.Cubism.Framework.Physics.CubismPhysicsSubRig")
+    def dump(self: CubismPhysicsSubRig):
+        return {
+            "Input": [x.dump() for x in self.Input],
+            "Output": [x.dump() for x in self.Output],
+            "Vertices": [x.dump() for x in self.Particles],
+            "Normalization": self.Normalization.dump(),
+        }
 
+    @monkey_patch("Live2D.Cubism.Framework.Physics.CubismPhysicsRig")
+    def dump(self: CubismPhysicsRig):
+        return [
+            {"Id": "PhysicsSetting%d" % (i + 1), **rig.dump()}
+            for i, rig in enumerate(self.SubRigs)
+        ]
 
-@monkey_patch(CubismPhysicsController)
-def dump(self: CubismPhysicsController):
-    return {
-        "Version": 3,
-        "Meta": {
-            "PhysicsSettingCount": len(self._rig.SubRigs),
-            "TotalInputCount": sum((len(x.Input) for x in self._rig.SubRigs)),
-            "TotalOutputCount": sum((len(x.Output) for x in self._rig.SubRigs)),
-            "VertexCount": sum((len(x.Particles) for x in self._rig.SubRigs)),
-            "Fps": 60,
-            "EffectiveForces": {
-                "Gravity": {"X": 0, "Y": -1},
-                "Wind": {"X": 0, "Y": 0},
+    @monkey_patch("Live2D.Cubism.Framework.Physics.CubismPhysicsController")
+    def dump(self: CubismPhysicsController):
+        return {
+            "Version": 3,
+            "Meta": {
+                "PhysicsSettingCount": len(self._rig.SubRigs),
+                "TotalInputCount": sum((len(x.Input) for x in self._rig.SubRigs)),
+                "TotalOutputCount": sum((len(x.Output) for x in self._rig.SubRigs)),
+                "VertexCount": sum((len(x.Particles) for x in self._rig.SubRigs)),
+                "Fps": 60,
+                "EffectiveForces": {
+                    "Gravity": {"X": 0, "Y": -1},
+                    "Wind": {"X": 0, "Y": 0},
+                },
+                "PhysicsDictionary": [
+                    {"Id": "PhysicsSetting%d" % (i + 1), "Name": "%d" % (i + 1)}
+                    for i, _ in enumerate(self._rig.SubRigs)
+                ],
             },
-            "PhysicsDictionary": [
-                {"Id": "PhysicsSetting%d" % (i + 1), "Name": "%d" % (i + 1)}
-                for i, _ in enumerate(self._rig.SubRigs)
-            ],
-        },
-        "PhysicsSettings": self._rig.dump(),
-    }
-
-
-@monkey_patch(CubismRenderer)
-def __hash__(self: CubismRenderer):
-    return self._mainTexture.path_id
-
-
-@monkey_patch(CubismRenderer)
-def __eq__(self: CubismRenderer, other: CubismRenderer):
-    return self.__hash__() == other.__hash__()
-
-
-from dataclasses import dataclass
-
-
-@dataclass
-class ExtractorFlags:
-    live2d_variant: str = "cubism"
+            "PhysicsSettings": self._rig.dump(),
+        }
 
+    @monkey_patch("Live2D.Cubism.Rendering.CubismRenderer")
+    def __hash__(self: CubismRenderer):
+        return self._mainTexture.path_id
 
-FLAGS = ExtractorFlags()
+    @monkey_patch("Live2D.Cubism.Rendering.CubismRenderer")
+    def __eq__(self: CubismRenderer, other: CubismRenderer):
+        return self.__hash__() == other.__hash__()
 
 
 # XXX: Is monkey patching this into UnityPy a good idea?
 def read_from(reader: ObjectReader, **kwargs):
     """Import generated classes by MonoBehavior script class type and read from reader"""
-    import importlib
-
+    TYPETREE_DEFS = CFG.import_path("TYPETREE_DEFS")
     match reader.type:
         case ClassIDType.MonoBehaviour:
             mono: MonoBehaviour = reader.read(check_read=False)
@@ -178,10 +181,7 @@ def read_from(reader: ObjectReader, **kwargs):
 
             if typetree:
                 result = reader.read_typetree(typetree)
-                nameSpace = importlib.import_module(
-                    f".generated.{nameSpace}", package="UnityPyLive2DExtractor"
-                )
-                clazz = getattr(nameSpace, className, None)
+                clazz = CFG.import_path(fullName)
                 instance = clazz(object_reader=reader, **result)
                 return instance
             else:
@@ -201,6 +201,11 @@ def __main__():
     )
     parser.add_argument("infile", help="Input file/directory to extract from")
     parser.add_argument("outdir", help="Output directory to extract to")
+    parser.add_argument(
+        "--module",
+        help="Generated Live2D module from TypeTree dump. Read the README for info.",
+        default="UnityPyLive2DExtractor.generated",
+    )
     parser.add_argument(
         "--log-level",
         help="Set logging level",
@@ -216,8 +221,10 @@ def __main__():
         fmt="%(asctime)s %(name)s [%(levelname).4s] %(message)s",
         isatty=True,
     )
-    os.makedirs(args.outdir, exist_ok=True)
     logger.info("UnityPyLive2D Extractor v%d.%d.%d" % __version__)
+    CFG.generated_module = args.module
+    patch_all()
+    os.makedirs(args.outdir, exist_ok=True)
     logger.info("Loading %s" % args.infile)
     env = UnityPy.load(args.infile)
     objs = [

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-__version__ = (0, 1, 6)`
	`1`	`+__version__ = (0, 1, 7)`