Merge pull request #93 from Live2D/birp/develop

Update to Cubism 5 SDK for Unity R4_2

Author: itoh-at-live2d-com

Assets/Live2D/Cubism/CHANGELOG.md

@@ -5,6 +5,49 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 
+## [5-r.4.2] - 2026-05-14
+
+### Added
+
+* Add `CubismLookCenterTransform` and `CubismLookCenterArtMesh` to allow setting the look-at center using either a Transform or an ArtMesh.
+
+### Changed
+
+* Change property names related to multiply color and screen color.
+* Change to work with the `Input System` package.
+* Update each model's prefab to match environment updates.
+* Change to allow specifying `AnimatorController` in scenes under `Assets/Live2D/Cubism/Samples/AsyncBenchmark`.
+* Change to explicitly set texture sampler settings.
+* Change the `Assets/Live2D/Cubism/Samples/AsyncBenchmark/AutomaticAsyncBenchmark.unity` scene.
+  * Add background to text UI.
+  * Change target fps to 30fps on mobile environments.
+  * Change `Enable Async` to be disabled by default.
+* Change the `Assets/Live2D/Cubism/Samples/OriginalWorkflow/Pose.unity` scene.
+* Change the `Assets/Live2D/Cubism/Samlpes/OriginalWorkflow/Motion.unity` scene.
+* Change the version of the development project to `6000.0.68f1`.
+
+### Fixed
+
+* Fix an issue where look-at tracking was misaligned when using `CubismLookController`.
+* Fix an issue where collision detection remained active even when the collision detection Drawable was hidden.
+* Fix an issue where pressing the reset button in the `CubismParametersInspector` would revert to the state before the reset when running the scene.
+* Fix an issue where `CubismPartColorsEditor` was using incorrect flags for determination.
+* Fix an issue where the re-import process for a model did not support increasing or decreasing parameters and other elements.
+* Fix CubismImporterBase.Save so that it no longer performs a reimport when saving.
+* Fix the importer to import motion3.json first, followed by model3.json, and then all other assets.
+* Fix PoseMotionImporter processing to accommodate the new import order.
+* Fix an issue where the texture settings were not as intended when imported.
+* Fix an issue where the Koharu model's .model3.json was missing references to .motion3.json.
+* Fix Koharu's corrupted .motion3.json files.
+* Fix an issue where specifying an override in `CubismParameterExtensionMethods.BlendToValue()` caused the applied value to be the current value of that parameter. by [@LoS-Light](https://github.com/Live2D/CubismUnityComponents/pull/89)
+* Fix an issue where arrays accessed in `OnDynamicDrawableData()` were processed with invalid indexes.
+* Fix an issue where the `Koharu` model used in scenes under `Assets/Live2D/Cubism/Samples/AsyncBenchmark` was outdated.
+* Fix an issue where reimporting a model prefab containing deleted components caused an error and prevented the prefab from being regenerated correctly.
+* Fix a duplicate blend calculation in `CubismParameterExtensionMethods.BlendToValue()`.
+* Fix an issue where the import process would run for models imported under the `StreamingAssets` folder. by [@redwyre](https://github.com/Live2D/CubismUnityComponents/pull/90)
+* Fix an issue where Raycast was functional even when `CubismRaycastable` was inactive.
+
+
 ## [5-r.4.1] - 2025-07-17
 
 ### Changed
@@ -474,6 +517,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 * Fix issue where Priority value was not reset after playing motion with CubismMotionController.
 
 
+[5-r.4.2]: https://github.com/Live2D/CubismUnityComponents/compare/5-r.4.1...5-r.4.2
 [5-r.4.1]: https://github.com/Live2D/CubismUnityComponents/compare/5-r.4...5-r.4.1
 [5-r.4]: https://github.com/Live2D/CubismUnityComponents/compare/5-r.3...5-r.4
 [5-r.3]: https://github.com/Live2D/CubismUnityComponents/compare/5-r.2...5-r.3

Assets/Live2D/Cubism/Core/CubismModel.cs

@@ -86,6 +86,28 @@ public static void ResetMocReference(CubismModel model, CubismMoc moc)
             model.Moc = moc;
         }
 
+        /// <summary>
+        /// Resets non-serialized fields of a <see cref="CubismModel"/>.
+        /// </summary>
+        /// <remarks>
+        /// Call after <c>PrefabUtility.SaveAsPrefabAsset</c> to clear stale
+        /// component references that may have been cached by <see cref="OnValidate"/>
+        /// during the prefab replacement.
+        /// </remarks>
+        /// <param name="model">Target Cubism model.</param>
+        public static void ResetNonSerializedFields(CubismModel model)
+        {
+            if (model.TaskableModel != null)
+            {
+                model.TaskableModel.ReleaseUnmanaged();
+                model.TaskableModel = null;
+            }
+
+            model._parameters = null;
+            model._parts = null;
+            model._drawables = null;
+            model._canvasInformation = null;
+        }
         /// <summary>
         /// <see cref="Moc"/> backing field.
         /// </summary>
@@ -275,7 +297,7 @@ private bool CanRevive
         /// <summary>
         /// Revives instance.
         /// </summary>
-        private void Revive()
+        internal void Revive()
         {
             // Return if already revive.
             if (IsRevived)
@@ -320,6 +342,28 @@ private void Reset(CubismMoc moc)
             }
             else
             {
+                // Filter stale entries whose UnmanagedIndex exceeds the new Moc count.
+                var unmanagedParamerterCount = TaskableModel.UnmanagedModel.Parameters.Count;
+                if (Parameters.Length > unmanagedParamerterCount)
+                {
+                    var filtered = new CubismParameter[unmanagedParamerterCount];
+                    var n = 0;
+
+                    for (var i = 0; i < Parameters.Length; i++)
+                    {
+                        if (Parameters[i].UnmanagedIndex < unmanagedParamerterCount)
+                        {
+                            filtered[n++] = Parameters[i];
+                        }
+                    }
+
+                    if (n < unmanagedParamerterCount)
+                    {
+                        Array.Resize(ref filtered, n);
+                    }
+
+                    Parameters = filtered;
+                }
                 Parameters.Revive(TaskableModel.UnmanagedModel);
             }
 
@@ -334,6 +378,28 @@ private void Reset(CubismMoc moc)
             }
             else
             {
+                // Filter stale entries whose UnmanagedIndex exceeds the new Moc count.
+                var unmanagedPartCount = TaskableModel.UnmanagedModel.Parts.Count;
+                if (Parts.Length > unmanagedPartCount)
+                {
+                    var filtered = new CubismPart[unmanagedPartCount];
+                    var n = 0;
+
+                    for (var i = 0; i < Parts.Length; i++)
+                    {
+                        if (Parts[i].UnmanagedIndex < unmanagedPartCount)
+                        {
+                            filtered[n++] = Parts[i];
+                        }
+                    }
+
+                    if (n < unmanagedPartCount)
+                    {
+                        Array.Resize(ref filtered, n);
+                    }
+
+                    Parts = filtered;
+                }
                 Parts.Revive(TaskableModel.UnmanagedModel);
             }
 
@@ -348,6 +414,28 @@ private void Reset(CubismMoc moc)
             }
             else
             {
+                // Filter stale entries whose UnmanagedIndex exceeds the new Moc count.
+                var unmanagedDrawableCount = TaskableModel.UnmanagedModel.Drawables.Count;
+                if (Drawables.Length > unmanagedDrawableCount)
+                {
+                    var filtered = new CubismDrawable[unmanagedDrawableCount];
+                    var n = 0;
+
+                    for (var i = 0; i < Drawables.Length; i++)
+                    {
+                        if (Drawables[i].UnmanagedIndex < unmanagedDrawableCount)
+                        {
+                            filtered[n++] = Drawables[i];
+                        }
+                    }
+
+                    if (n < unmanagedDrawableCount)
+                    {
+                        Array.Resize(ref filtered, n);
+                    }
+
+                    Drawables = filtered;
+                }
                 Drawables.Revive(TaskableModel.UnmanagedModel);
             }
 

Assets/Live2D/Cubism/Editor/CubismAssetProcessor.cs

@@ -26,6 +26,9 @@ namespace Live2D.Cubism.Editor
     /// </summary>
     public class CubismAssetProcessor : AssetPostprocessor
     {
+        private const string Motion3JsonExtension = ".motion3.json";
+        private const string Model3JsonExtension = ".model3.json";
+
         #region Unity Event Handling
 
 #if !UNITY_2017_3_OR_NEWER
@@ -58,8 +61,26 @@ private static void OnPostprocessAllAssets(
 
             var assetList = CubismCreatedAssetList.GetInstance();
 
+            // Import motion3.json first to create AnimationClip
+            var orderedAssetPaths = importedAssetPaths
+                .OrderBy(path =>
+                {
+                    if (path.EndsWith(Motion3JsonExtension, StringComparison.OrdinalIgnoreCase))
+                    {
+                        return 0;
+                    }
+
+                    if (path.EndsWith(Model3JsonExtension, StringComparison.OrdinalIgnoreCase))
+                    {
+                        return 1;
+                    }
+
+                    return 2;
+                })
+                .ToArray();
+
             // Handle any imported Cubism assets.
-            foreach (var assetPath in importedAssetPaths)
+            foreach (var assetPath in orderedAssetPaths)
             {
                 var importer = CubismImporter.GetImporterAtPath(assetPath);
 
@@ -69,6 +90,12 @@ private static void OnPostprocessAllAssets(
                     continue;
                 }
 
+                if (assetPath.StartsWith("Assets/StreamingAssets/"))
+                {
+                    Debug.LogWarning("CubismAssetProcessor : Skipping import of " + assetPath);
+                    continue;
+                }
+
                 try
                 {
                     importer.Import();

Assets/Live2D/Cubism/Editor/Importers/CubismImporter.cs

@@ -220,16 +220,32 @@ private static void BuiltinTextureImportHandler(CubismModel3JsonImporter importe
             var textureImporter = AssetImporter.GetAtPath(AssetDatabase.GetAssetPath(texture)) as TextureImporter;
 
 
+            if (!textureImporter)
+            {
+                Debug.LogError("[Texture Importer] Could not get TextureImporter for texture used by Cubism model.");
+                return;
+            }
+
+
             // Return early if texture already seems to be set up.
-            if (textureImporter.alphaIsTransparency)
+            if (!textureImporter.mipmapEnabled
+                && textureImporter.alphaIsTransparency
+                && textureImporter.textureType == TextureImporterType.Default
+                && textureImporter.textureCompression == TextureImporterCompression.Uncompressed
+                && textureImporter.wrapMode == TextureWrapMode.Repeat
+                && textureImporter.filterMode == FilterMode.Bilinear)
             {
                 return;
             }
 
 
             // Set up texture importing.
+            textureImporter.mipmapEnabled = false;
             textureImporter.alphaIsTransparency = true;
             textureImporter.textureType = TextureImporterType.Default;
+            textureImporter.textureCompression = TextureImporterCompression.Uncompressed;
+            textureImporter.wrapMode = TextureWrapMode.Repeat;
+            textureImporter.filterMode = FilterMode.Bilinear;
 
 
             EditorUtility.SetDirty(texture);

Assets/Live2D/Cubism/Editor/Importers/CubismImporterBase.cs

@@ -42,7 +42,7 @@ public void Save()
             assetImporter.userData = JsonUtility.ToJson(this);
 
 
-            assetImporter.SaveAndReimport();
+            AssetDatabase.WriteImportSettingsIfDirty(AssetPath);
         }
 
 #region ICubismImporter

Assets/Live2D/Cubism/Editor/Importers/CubismModel3JsonImporter.cs

@@ -12,6 +12,7 @@
 using Live2D.Cubism.Framework.Json;
 using Live2D.Cubism.Framework.Motion;
 using Live2D.Cubism.Framework.MotionFade;
+using Live2D.Cubism.Framework.MouthMovement;
 using Live2D.Cubism.Framework.Pose;
 using Live2D.Cubism.Rendering.Masking;
 using System;
@@ -259,12 +260,31 @@ public override void Import()
                 // Reset moc reference.
                 CubismModel.ResetMocReference(model, MocAsset);
 
+                // Update moc asset before saving prefab to avoid IndexOutOfRangeException
+                // when Inspector loads the prefab and calls Revive() with stale moc data.
+                if (MocAsset != null)
+                {
+                    EditorUtility.CopySerialized(moc, MocAsset);
+
+                    // Revive by forcee to make instance using the new Moc.
+                    CubismMoc.ResetUnmanagedMoc(MocAsset);
+
+                    EditorUtility.SetDirty(MocAsset);
+                }
+
                 // Keep layer value.
                 model.gameObject.layer = ModelPrefab.layer;
 
                 // Replace prefab.
 #if UNITY_2018_3_OR_NEWER
                 ModelPrefab = PrefabUtility.SaveAsPrefabAsset(model.gameObject, $"{assetPath}.prefab");
+
+                // Clear stale non-serialized state cached during prefab replacement.
+                var savedModel = ModelPrefab.FindCubismModel();
+                if (savedModel != null)
+                {
+                    CubismModel.ResetNonSerializedFields(savedModel);
+                }
 #else
                 ModelPrefab = PrefabUtility.ReplacePrefab(model.gameObject, ModelPrefab, ReplacePrefabOptions.ConnectToPrefab);
 #endif
@@ -277,20 +297,6 @@ public override void Import()
             // Clean up.
             Object.DestroyImmediate(model.gameObject, true);
 
-
-            // Update moc asset.
-            if (MocAsset != null)
-            {
-                EditorUtility.CopySerialized(moc, MocAsset);
-
-
-                // Revive by force to make instance using the new Moc.
-                CubismMoc.ResetUnmanagedMoc(MocAsset);
-
-
-                EditorUtility.SetDirty(MocAsset);
-            }
-
             // Save state and assets.
             if (isImporterDirty)
             {
@@ -316,7 +322,7 @@ private static void CopyUserData(CubismModel source, CubismModel destination, bo
             foreach (var sourceComponent in source.GetComponents(typeof(Component)))
             {
                 // Skip non-movable components.
-                if (!sourceComponent.MoveOnCubismReimport(copyComponentsOnly))
+                if (!sourceComponent || !sourceComponent.MoveOnCubismReimport(copyComponentsOnly))
                 {
                     continue;
                 }
@@ -326,7 +332,8 @@ private static void CopyUserData(CubismModel source, CubismModel destination, bo
                 || sourceComponent.GetType() == typeof(CubismFadeController)
                 || sourceComponent.GetType() == typeof(CubismExpressionController)
                 || sourceComponent.GetType() == typeof(CubismPoseController)
-                || sourceComponent.GetType() == typeof(CubismParameterStore))
+                || sourceComponent.GetType() == typeof(CubismParameterStore)
+                || sourceComponent.GetType() == typeof(CubismDisplayInfoCombinedParameterInfo))
                 {
                     continue;
                 }
@@ -368,11 +375,17 @@ private static void CopyUserData<T>(T[] source, T[] destination, bool copyCompon
                 foreach (var sourceComponent in sourceT.GetComponents(typeof(Component)))
                 {
                     // Skip non-movable components.
-                    if (!sourceComponent.MoveOnCubismReimport(copyComponentsOnly))
+                    if (!sourceComponent || !sourceComponent.MoveOnCubismReimport(copyComponentsOnly))
                     {
                         continue;
                     }
 
+                    // Skip import-managed components that should not be inherited from the old prefab.
+                    if (sourceComponent.GetType() == typeof(CubismEyeBlinkParameter)
+                    || sourceComponent.GetType() == typeof(CubismMouthParameter))
+                    {
+                        continue;
+                    }
 
                     // Copy component.
                     var destinationComponent = destinationT.GetOrAddComponent(sourceComponent.GetType());
@@ -381,12 +394,14 @@ private static void CopyUserData<T>(T[] source, T[] destination, bool copyCompon
                         var name = cdiParameterName.Name;
                         EditorUtility.CopySerialized(sourceComponent, destinationComponent);
                         cdiParameterName.Name = name;
+                        EditorUtility.SetDirty(cdiParameterName);
                     }
                     else if (destinationComponent is CubismDisplayInfoPartName cdiPartName && !string.IsNullOrEmpty(cdiPartName.Name))
                     {
                         var name = cdiPartName.Name;
                         EditorUtility.CopySerialized(sourceComponent, destinationComponent);
                         cdiPartName.Name = name;
+                        EditorUtility.SetDirty(cdiPartName);
                     }
                     else
                     {

Assets/Live2D/Cubism/Editor/Inspectors/CubismParametersInspectorInspector.cs

@@ -92,6 +92,7 @@ public override VisualElement CreateInspectorGUI()
                         parameter.OverrideValue(parameter.DefaultValue);
                         _elements[i].slider.value = parameter.DefaultValue;
                         _elements[i].field.value = parameter.DefaultValue;
+                        EditorUtility.SetDirty(parameter);
                     }
 
                     Undo.RecordObjects(target.Model.Parameters, "Change Parameter Values");