Merge branch 'release/v7.1.0' into develop

HarrisonHough · HarrisonHough · commit 20f2cbdd4275 · 2024-07-16T08:35:58.000+03:00
diff --git a/.github/latest.md b/.github/latest.md
@@ -2,17 +2,7 @@
 ## Changelog
 
 ## Updated
+- Reworked shader overrides to support mapping of other property types [#306](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/306)
 
-- loading circle animation now using MMecanim animation [#302](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/302)
-- removed unnecessary assets from Resources folder [#303](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/303)
-- updated Template avatar assets [#300](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/300)
-- Avatar Body type now moved to CoreSettings [#290](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/290)
-
-### Added
-
-- Added support for hero customization assets (costumes) [#301](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/301)
-- templates can now be filtered by Bodytype [#296](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/296)
-
-### Fixed
-
-- fixed an issue causing invalid load settings in Avatar Loader window [#298](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/298)
+## Fixed
+- Fixed an issue caused by missing bones on avatar template prefabs [#310](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/310/)
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,29 +3,37 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [7.1.0] - 2024.07.16
+
+## Updated
+- Reworked shader overrides to support mapping of other property types [#306](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/306)
+
+## Fixed
+- Fixed an issue caused by missing bones on avatar template prefabs [#310](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/310/)
+
 ## [7.0.0] - 2024.07.01
 
 ## Updated
 
-- loading circle animation now using MMecanim animation [#302](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/302)
-- removed unnecessary assets from Resources folder [#303](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/303)
-- updated Template avatar assets [#300](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/300)
+- Loading circle animation now using MMecanim animation [#302](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/302)
+- Removed unnecessary assets from Resources folder [#303](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/303)
+- Updated Template avatar assets [#300](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/300)
 - Avatar Body type now moved to CoreSettings [#290](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/290)
 
 ### Added
 
 - Added support for hero customization assets (costumes) [#301](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/301)
-- templates can now be filtered by Bodytype [#296](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/296)
+- Templates can now be filtered by Bodytype [#296](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/296)
 
 ### Fixed
 
-- fixed an issue causing invalid load settings in Avatar Loader window [#298](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/298)
+- Fixed an issue causing invalid load settings in Avatar Loader window [#298](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/298)
 
 ## [6.3.1] - 2024.06.18
 
 ### Fixed
 
-- allow cache to be loaded from previous versions, where bodyType was stored as an integer [#293](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/293)
+- Allow cache to be loaded from previous versions, where bodyType was stored as an integer [#293](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/293)
 
 ## [6.3.0] - 2024.06.11
 
@@ -55,7 +63,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Fixed
 
-- reverted update to GetMeshRenderer method  [#264](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/264)
+- Reverted update to GetMeshRenderer method  [#264](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/264)
 
 ## [6.2.2] - 2024.04.29
 
@@ -86,19 +94,19 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## Updated
 
-- removed use of tuples and deprecated old methods [#257](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/257)
+- Removed use of tuples and deprecated old methods [#257](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/257)
 
 ## [6.1.2] - 2024.04.03
 
 ### Updated
 
-- xr animation avatars updated to support with latest xr avatar updates
+- XR animation avatars updated to support with latest xr avatar updates
 
 ## [6.1.1] - 2024.04.03
 
 ### Updated
 
-- avatars done with a photo are now added as a draft avatars [#254](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/254)
+- Avatars done with a photo are now added as a draft avatars [#254](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/254)
 
 ## [6.1.0] - 2024.03.04
 
@@ -113,7 +121,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Updated
 
-- updated default render settings to fix an issue causing incorrect halfbody avatar renders [#238](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/238)
+- Updated default render settings to fix an issue causing incorrect halfbody avatar renders [#238](https://github.com/readyplayerme/rpm-unity-sdk-core/pull/238)
 
 ## [6.0.0] - 2024.02.19
 
diff --git a/Runtime/Core/Scripts/Data/ApplicationData.cs b/Runtime/Core/Scripts/Data/ApplicationData.cs
@@ -6,7 +6,7 @@ namespace ReadyPlayerMe.Core
 {
     public static class ApplicationData
     {
-        public const string SDK_VERSION = "v7.0.0";
+        public const string SDK_VERSION = "v7.1.0";
         private const string TAG = "ApplicationData";
         private const string DEFAULT_RENDER_PIPELINE = "Built-In Render Pipeline";
         private static readonly AppData Data;
diff --git a/Runtime/Core/Scripts/Utils/AvatarMeshHelper.cs b/Runtime/Core/Scripts/Utils/AvatarMeshHelper.cs
@@ -7,7 +7,8 @@ namespace ReadyPlayerMe.Core
 {
     public static class AvatarMeshHelper
     {
-        private static readonly string[] headMeshNames = {
+        private static readonly string[] headMeshNames =
+        {
             "Renderer_Head",
             "Renderer_Hair",
             "Renderer_Beard",
@@ -16,15 +17,15 @@ public static class AvatarMeshHelper
             "Renderer_EyeLeft",
             "Renderer_EyeRight",
             "Renderer_Headwear",
-            "Renderer_Facewear",
+            "Renderer_Facewear"
         };
 
         [Obsolete("Use TransferMesh(GameObject source, GameObject target) instead.")]
         public static void TransferMesh(GameObject source, SkinnedMeshRenderer[] targetMeshes, Animator targetAnimator)
         {
             TransferMesh(source, targetMeshes[0].transform.parent.gameObject);
         }
-        
+
         /// <summary>
         ///     Transfers the mesh and material data from the source to the target avatar.
         /// </summary>
@@ -34,23 +35,30 @@ public static void TransferMesh(GameObject source, GameObject target)
         {
             // store the relevant data of the source (downloaded) avatar
             var rendererDict = new Dictionary<string, SkinnedMeshRenderer>();
-            
+
             var sourceRenderers = source.GetComponentsInChildren<SkinnedMeshRenderer>();
             var targetRenderers = target.GetComponentsInChildren<SkinnedMeshRenderer>();
-            
+
             foreach (var renderer in sourceRenderers)
             {
                 rendererDict.Add(renderer.name, renderer);
             }
-            
+
+            var meshWithBones = targetRenderers.DefaultIfEmpty(null).FirstOrDefault((renderer) => renderer.bones.Length != 0);
+
             // transfer the data to the target skinning mesh renderers
             foreach (var renderer in targetRenderers)
             {
                 if (rendererDict.TryGetValue(renderer.name, out var sourceRenderer))
                 {
                     renderer.sharedMesh = sourceRenderer.sharedMesh;
                     renderer.sharedMaterial = sourceRenderer.sharedMaterial;
-                    
+
+                    if (renderer.bones.Length == 0 && meshWithBones != null)
+                    {
+                        renderer.bones = meshWithBones.bones;
+                        continue;
+                    }
                     // transfer the bone data
                     foreach (var targetBone in renderer.bones)
                     {
@@ -61,7 +69,7 @@ public static void TransferMesh(GameObject source, GameObject target)
                                 targetBone.position = sourceBone.position;
                                 targetBone.rotation = sourceBone.rotation;
                                 targetBone.localScale = sourceBone.localScale;
-                                break;                            
+                                break;
                             }
                         }
                     }
@@ -72,13 +80,13 @@ public static void TransferMesh(GameObject source, GameObject target)
                     renderer.material = null;
                 }
             }
-            
+
             // transfer the animation avatar
             var sourceAnimator = source.GetComponentInChildren<Animator>();
             var targetAnimator = target.GetComponentInChildren<Animator>();
             targetAnimator.avatar = sourceAnimator.avatar;
         }
-        
+
         /// <summary>
         ///     Returns the meshes of the head of the avatar, such as glasses, hair, teeth, etc.
         /// </summary>
@@ -88,15 +96,15 @@ public static GameObject[] GetHeadMeshes(GameObject avatar)
         {
             var renderers = avatar.GetComponentsInChildren<SkinnedMeshRenderer>();
             var headMeshes = new List<GameObject>();
-            
+
             foreach (var renderer in renderers)
             {
                 if (headMeshNames.Contains(renderer.name))
                 {
                     headMeshes.Add(renderer.gameObject);
                 }
             }
-            
+
             return headMeshes.ToArray();
         }
     }
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "com.readyplayerme.core",
-  "version": "7.0.0",
+  "version": "7.1.0",
   "displayName": "Ready Player Me Core",
   "description": "This Module contains all the core functionality required for using Ready Player Me avatars in Unity, including features such as: \n - Module management and automatic package setup logic\n - Avatar loading from .glb files \n - Avatar creation \n - Avatar and 2D render requests \n - Optional Analytics\n - Custom editor windows\n - Sample scenes and assets",
   "unity": "2020.3",

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ namespace ReadyPlayerMe.Core`
`6`	`6`	`{`
`7`	`7`	`public static class ApplicationData`
`8`	`8`	`{`
`9`		`- public const string SDK_VERSION = "v7.0.0";`
	`9`	`+ public const string SDK_VERSION = "v7.1.0";`
`10`	`10`	`private const string TAG = "ApplicationData";`
`11`	`11`	`private const string DEFAULT_RENDER_PIPELINE = "Built-In Render Pipeline";`
`12`	`12`	`private static readonly AppData Data;`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,8 @@ namespace ReadyPlayerMe.Core`
`7`	`7`	`{`
`8`	`8`	`public static class AvatarMeshHelper`
`9`	`9`	`{`
`10`		`- private static readonly string[] headMeshNames = {`
	`10`	`+ private static readonly string[] headMeshNames =`
	`11`	`+ {`
`11`	`12`	`"Renderer_Head",`
`12`	`13`	`"Renderer_Hair",`
`13`	`14`	`"Renderer_Beard",`
`@@ -16,15 +17,15 @@ public static class AvatarMeshHelper`
`16`	`17`	`"Renderer_EyeLeft",`
`17`	`18`	`"Renderer_EyeRight",`
`18`	`19`	`"Renderer_Headwear",`
`19`		`- "Renderer_Facewear",`
	`20`	`+ "Renderer_Facewear"`
`20`	`21`	`};`
`21`	`22`
`22`	`23`	`[Obsolete("Use TransferMesh(GameObject source, GameObject target) instead.")]`
`23`	`24`	`public static void TransferMesh(GameObject source, SkinnedMeshRenderer[] targetMeshes, Animator targetAnimator)`
`24`	`25`	`{`
`25`	`26`	`TransferMesh(source, targetMeshes[0].transform.parent.gameObject);`
`26`	`27`	`}`
`27`		`-`
	`28`	`+`
`28`	`29`	`/// <summary>`
`29`	`30`	`/// Transfers the mesh and material data from the source to the target avatar.`
`30`	`31`	`/// </summary>`
`@@ -34,23 +35,30 @@ public static void TransferMesh(GameObject source, GameObject target)`
`34`	`35`	`{`
`35`	`36`	`// store the relevant data of the source (downloaded) avatar`
`36`	`37`	`var rendererDict = new Dictionary<string, SkinnedMeshRenderer>();`
`37`		`-`
	`38`	`+`
`38`	`39`	`var sourceRenderers = source.GetComponentsInChildren<SkinnedMeshRenderer>();`
`39`	`40`	`var targetRenderers = target.GetComponentsInChildren<SkinnedMeshRenderer>();`
`40`		`-`
	`41`	`+`
`41`	`42`	`foreach (var renderer in sourceRenderers)`
`42`	`43`	`{`
`43`	`44`	`rendererDict.Add(renderer.name, renderer);`
`44`	`45`	`}`
`45`		`-`
	`46`	`+`
	`47`	`+ var meshWithBones = targetRenderers.DefaultIfEmpty(null).FirstOrDefault((renderer) => renderer.bones.Length != 0);`
	`48`	`+`
`46`	`49`	`// transfer the data to the target skinning mesh renderers`
`47`	`50`	`foreach (var renderer in targetRenderers)`
`48`	`51`	`{`
`49`	`52`	`if (rendererDict.TryGetValue(renderer.name, out var sourceRenderer))`
`50`	`53`	`{`
`51`	`54`	`renderer.sharedMesh = sourceRenderer.sharedMesh;`
`52`	`55`	`renderer.sharedMaterial = sourceRenderer.sharedMaterial;`
`53`		`-`
	`56`	`+`
	`57`	`+ if (renderer.bones.Length == 0 && meshWithBones != null)`
	`58`	`+ {`
	`59`	`+ renderer.bones = meshWithBones.bones;`
	`60`	`+ continue;`
	`61`	`+ }`
`54`	`62`	`// transfer the bone data`
`55`	`63`	`foreach (var targetBone in renderer.bones)`
`56`	`64`	`{`
`@@ -61,7 +69,7 @@ public static void TransferMesh(GameObject source, GameObject target)`
`61`	`69`	`targetBone.position = sourceBone.position;`
`62`	`70`	`targetBone.rotation = sourceBone.rotation;`
`63`	`71`	`targetBone.localScale = sourceBone.localScale;`
`64`		`- break;`
	`72`	`+ break;`
`65`	`73`	`}`
`66`	`74`	`}`
`67`	`75`	`}`
`@@ -72,13 +80,13 @@ public static void TransferMesh(GameObject source, GameObject target)`
`72`	`80`	`renderer.material = null;`
`73`	`81`	`}`
`74`	`82`	`}`
`75`		`-`
	`83`	`+`
`76`	`84`	`// transfer the animation avatar`
`77`	`85`	`var sourceAnimator = source.GetComponentInChildren<Animator>();`
`78`	`86`	`var targetAnimator = target.GetComponentInChildren<Animator>();`
`79`	`87`	`targetAnimator.avatar = sourceAnimator.avatar;`
`80`	`88`	`}`
`81`		`-`
	`89`	`+`
`82`	`90`	`/// <summary>`
`83`	`91`	`/// Returns the meshes of the head of the avatar, such as glasses, hair, teeth, etc.`
`84`	`92`	`/// </summary>`
`@@ -88,15 +96,15 @@ public static GameObject[] GetHeadMeshes(GameObject avatar)`
`88`	`96`	`{`
`89`	`97`	`var renderers = avatar.GetComponentsInChildren<SkinnedMeshRenderer>();`
`90`	`98`	`var headMeshes = new List<GameObject>();`
`91`		`-`
	`99`	`+`
`92`	`100`	`foreach (var renderer in renderers)`
`93`	`101`	`{`
`94`	`102`	`if (headMeshNames.Contains(renderer.name))`
`95`	`103`	`{`
`96`	`104`	`headMeshes.Add(renderer.gameObject);`
`97`	`105`	`}`
`98`	`106`	`}`
`99`		`-`
	`107`	`+`
`100`	`108`	`return headMeshes.ToArray();`
`101`	`109`	`}`
`102`	`110`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "com.readyplayerme.core",`
`3`		`- "version": "7.0.0",`
	`3`	`+ "version": "7.1.0",`
`4`	`4`	`"displayName": "Ready Player Me Core",`
`5`	`5`	`"description": "This Module contains all the core functionality required for using Ready Player Me avatars in Unity, including features such as: \n - Module management and automatic package setup logic\n - Avatar loading from .glb files \n - Avatar creation \n - Avatar and 2D render requests \n - Optional Analytics\n - Custom editor windows\n - Sample scenes and assets",`
`6`	`6`	`"unity": "2020.3",`