Version 0.1.6

Use latest Live2D SDK for TypeTree dump
Update codegen

Author: mos9527

README.md

@@ -7,6 +7,12 @@ 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`
+    ```bash
+    python typetree_codegen.py type_tree_cubism.json UnityPyLive2DExtractor/generated
+    ```
+    - 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

UnityPyLive2DExtractor/__init__.py

@@ -1 +1 @@
-__version__ = (0, 1, 5)
+__version__ = (0, 1, 6)

UnityPyLive2DExtractor/__main__.py

@@ -9,7 +9,6 @@
     Transform,
     PPtr,
     Texture2D,
-    AnimationClip,
 )
 from UnityPy.enums import ClassIDType
 from UnityPy.files import ObjectReader
@@ -149,6 +148,17 @@ def __eq__(self: CubismRenderer, other: CubismRenderer):
     return self.__hash__() == other.__hash__()
 
 
+from dataclasses import dataclass
+
+
+@dataclass
+class ExtractorFlags:
+    live2d_variant: str = "cubism"
+
+
+FLAGS = ExtractorFlags()
+
+
 # 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"""
@@ -207,6 +217,8 @@ def __main__():
         isatty=True,
     )
     os.makedirs(args.outdir, exist_ok=True)
+    logger.info("UnityPyLive2D Extractor v%d.%d.%d" % __version__)
+    logger.info("Loading %s" % args.infile)
     env = UnityPy.load(args.infile)
     objs = [
         read_from(reader)
@@ -215,9 +227,10 @@ def __main__():
             env.objects,
         )
     ]
+    logger.info("MonoBehaviours: %d" % len(objs))
     candidates = [
         read_from_ptr(obj.m_GameObject, obj)
-        for obj in filter(lambda obj: isinstance(obj, CubismPhysicsController), objs)
+        for obj in filter(lambda obj: isinstance(obj, CubismModel), objs)
     ]
     crc_cache = dict()
     # fmt: off
@@ -244,9 +257,10 @@ def __main__():
             fname = metadata["FileReferences"]["Moc"] = f"{NAME}.moc3"
             with open(os.path.join(outdir, fname), "wb") as f:
                 moc = read_from_ptr(MOC._moc, MOC.object_reader)
-                logger.info(".moc3: %d bytes" % f.write(moc._bytes))
+                moc = bytes(moc._bytes)
+                logger.info(".moc3: %d bytes" % f.write(moc))
                 try:
-                    parts, parameters = read_moc3(io.BytesIO(moc._bytes))
+                    parts, parameters = read_moc3(io.BytesIO(moc))
                     for s in parts:
                         path = "Parts/" + s
                         crc_cache[crc32(path.encode("utf-8"))] = path

UnityPyLive2DExtractor/generated/Live2D/Cubism/Core/__init__.py

@@ -10,8 +10,12 @@ class ArrayExtensionMethods(MonoBehaviour):
 class ComponentExtensionMethods(MonoBehaviour):
 	pass
 @typetree_defined
+class CubismCanvasInformation(MonoBehaviour):
+	pass
+@typetree_defined
 class CubismDrawable(MonoBehaviour):
 	_unmanagedIndex : int
+	_screenColor : ColorRGBA
 @typetree_defined
 class CubismDynamicDrawableData(MonoBehaviour):
 	pass
@@ -20,7 +24,7 @@ class CubismLogging(MonoBehaviour):
 	pass
 @typetree_defined
 class CubismMoc(MonoBehaviour):
-	_bytes : bytes
+	_bytes : List[int]
 @typetree_defined
 class CubismModel(MonoBehaviour):
 	_moc : PPtr[CubismMoc]

UnityPyLive2DExtractor/generated/Live2D/Cubism/Framework/Expression/__init__.py

@@ -4,28 +4,37 @@
 from ..... import *
 from .....Live2D.Cubism.Core import CubismParameter
 from .....Live2D.Cubism.Framework import CubismParameterBlendMode
+from ..... import SerializableExpressionParameter
 
 @typetree_defined
 class CubismExpressionData(MonoBehaviour):
 	Type : str
 	FadeInTime : float
 	FadeOutTime : float
-	Parameters : List[object] # XXX: Fallback of SerializableExpressionParameter[]
+	Parameters : List[SerializableExpressionParameter]
 @typetree_defined
 class CubismExpressionList(MonoBehaviour):
-	CubismExpressionObjects : List[CubismExpressionData]
+	CubismExpressionObjects : List[PPtr[CubismExpressionData]]
 @typetree_defined
 class CubismExpressionController(MonoBehaviour):
 	ExpressionsList : PPtr[CubismExpressionList]
+	UseLegacyBlendCalculation : bool
 	CurrentExpressionIndex : int
 @typetree_defined
+class CubismExpressionParameterValue(MonoBehaviour):
+	Parameter : PPtr[CubismParameter]
+	AdditiveValue : float
+	MultiplyValue : float
+	OverwriteValue : float
+@typetree_defined
 class CubismPlayingExpression(MonoBehaviour):
 	Type : str
 	FadeInTime : float
 	FadeOutTime : float
 	Weight : float
 	ExpressionUserTime : float
+	ExpressionStartTime : float
 	ExpressionEndTime : float
-	Destinations : List[CubismParameter]
+	Destinations : List[PPtr[CubismParameter]]
 	Value : List[float]
-	Blend : List[CubismParameterBlendMode]
+	Blend : List[int]

UnityPyLive2DExtractor/generated/Live2D/Cubism/Framework/Json/__init__.py

@@ -2,45 +2,75 @@
 # Python definition for Live2D.Cubism.Framework.Json
 
 from ..... import *
+from ..... import PhysicsDictionaryItem
+from ..... import SerializableCombinedParameterIds
+from ..... import SerializableCurve
+from ..... import SerializableEffectiveForces
+from ..... import SerializableExpression
+from ..... import SerializableExpressionParameter
+from ..... import SerializableFileReferences
+from ..... import SerializableGroup
+from ..... import SerializableHitArea
+from ..... import SerializableInput
+from ..... import SerializableMeta
+from ..... import SerializableMotions
+from ..... import SerializableNormalization
+from ..... import SerializableNormalizationValue
+from ..... import SerializableOutput
+from ..... import SerializableParameter
+from ..... import SerializableParameterGroups
+from ..... import SerializableParameters
+from ..... import SerializableParts
+from ..... import SerializablePhysicsSettings
+from ..... import SerializableUserData
+from ..... import SerializableVector2
+from ..... import SerializableVertex
 
 @typetree_defined
 class CubismBuiltinPickers(MonoBehaviour):
 	pass
 @typetree_defined
+class CubismDisplayInfo3Json(MonoBehaviour):
+	Version : int
+	Parameters : List[SerializableParameters]
+	ParameterGroups : List[SerializableParameterGroups]
+	Parts : List[SerializableParts]
+	CombinedParameters : List[SerializableCombinedParameterIds]
+@typetree_defined
 class CubismExp3Json(MonoBehaviour):
 	Type : str
 	FadeInTime : float
 	FadeOutTime : float
-	Parameters : List[object] # XXX: Fallback of SerializableExpressionParameter[]
+	Parameters : List[SerializableExpressionParameter]
 @typetree_defined
 class CubismJsonParser(MonoBehaviour):
 	pass
 @typetree_defined
 class CubismModel3Json(MonoBehaviour):
 	Version : int
-	FileReferences : object # XXX: Fallback of SerializableFileReferences
-	Groups : List[object] # XXX: Fallback of SerializableGroup[]
-	HitAreas : List[object] # XXX: Fallback of SerializableHitArea[]
+	FileReferences : SerializableFileReferences
+	Groups : List[SerializableGroup]
+	HitAreas : List[SerializableHitArea]
 @typetree_defined
 class CubismMotion3Json(MonoBehaviour):
 	Version : int
-	Meta : object # XXX: Fallback of SerializableMeta
-	Curves : List[object] # XXX: Fallback of SerializableCurve[]
-	UserData : List[object] # XXX: Fallback of SerializableUserData[]
+	Meta : SerializableMeta
+	Curves : List[SerializableCurve]
+	UserData : List[SerializableUserData]
 @typetree_defined
 class CubismPhysics3Json(MonoBehaviour):
 	Version : int
-	Meta : object # XXX: Fallback of SerializableMeta
-	PhysicsSettings : List[object] # XXX: Fallback of SerializablePhysicsSettings[]
+	Meta : SerializableMeta
+	PhysicsSettings : List[SerializablePhysicsSettings]
 @typetree_defined
 class CubismPose3Json(MonoBehaviour):
 	Type : str
 	FadeInTime : float
 @typetree_defined
 class CubismUserData3Json(MonoBehaviour):
 	Version : int
-	Meta : object # XXX: Fallback of SerializableMeta
-	UserData : List[object] # XXX: Fallback of SerializableUserData[]
+	Meta : SerializableMeta
+	UserData : List[SerializableUserData]
 @typetree_defined
 class Value(MonoBehaviour):
 	pass

UnityPyLive2DExtractor/generated/Live2D/Cubism/Framework/Motion/__init__.py

@@ -10,5 +10,8 @@ class CubismMotionController(MonoBehaviour):
 class CubismMotionLayer(MonoBehaviour):
 	pass
 @typetree_defined
+class CubismMotionPriority(MonoBehaviour):
+	pass
+@typetree_defined
 class CubismMotionState(MonoBehaviour):
 	pass

UnityPyLive2DExtractor/generated/Live2D/Cubism/Framework/MotionFade/__init__.py

@@ -6,6 +6,8 @@
 @typetree_defined
 class CubismFadeMotionData(MonoBehaviour):
 	MotionName : str
+	ModelFadeInTime : float
+	ModelFadeOutTime : float
 	FadeInTime : float
 	FadeOutTime : float
 	ParameterIds : List[str]
@@ -16,7 +18,7 @@ class CubismFadeMotionData(MonoBehaviour):
 @typetree_defined
 class CubismFadeMotionList(MonoBehaviour):
 	MotionInstanceIds : List[int]
-	CubismFadeMotionObjects : List[CubismFadeMotionData]
+	CubismFadeMotionObjects : List[PPtr[CubismFadeMotionData]]
 @typetree_defined
 class CubismFadeController(MonoBehaviour):
 	CubismFadeMotionList : PPtr[CubismFadeMotionList]
@@ -33,6 +35,7 @@ class CubismFadePlayingMotion(MonoBehaviour):
 	FadeInStartTime : float
 	Speed : float
 	Motion : PPtr[CubismFadeMotionData]
+	IsLooping : bool
 @typetree_defined
 class CubismFadeStateObserver(MonoBehaviour):
 	pass

UnityPyLive2DExtractor/generated/Live2D/Cubism/Framework/Physics/__init__.py

@@ -41,13 +41,17 @@ class CubismPhysicsParticle(MonoBehaviour):
 	Radius : float
 @typetree_defined
 class CubismPhysicsSubRig(MonoBehaviour):
+	Name : str
 	Input : List[CubismPhysicsInput]
 	Output : List[CubismPhysicsOutput]
 	Particles : List[CubismPhysicsParticle]
 	Normalization : CubismPhysicsNormalization
 @typetree_defined
 class CubismPhysicsRig(MonoBehaviour):
 	SubRigs : List[CubismPhysicsSubRig]
+	Gravity : Vector2f
+	Wind : Vector2f
+	Fps : float
 @typetree_defined
 class CubismPhysicsController(MonoBehaviour):
 	_rig : CubismPhysicsRig

UnityPyLive2DExtractor/generated/Live2D/Cubism/Framework/Pose/__init__.py

@@ -16,5 +16,5 @@ class CubismPosePart(MonoBehaviour):
 class CubismPoseData(MonoBehaviour):
 	PosePart : PPtr[CubismPosePart]
 	Part : PPtr[CubismPart]
-	LinkParts : List[CubismPart]
+	LinkParts : List[PPtr[CubismPart]]
 	Opacity : float