From 2c2d2d02214b151df02cc16d453fd8060e735d71 Mon Sep 17 00:00:00 2001 From: Benjythebee Date: Fri, 18 Oct 2024 07:09:08 +1300 Subject: [PATCH 1/3] add blendshape docs --- .../manifest-files/character-traits.md | 46 +++++++++++++++++++ 1 file changed, 46 insertions(+) diff --git a/docs/Modders/manifest-files/character-traits.md b/docs/Modders/manifest-files/character-traits.md index a7718a13..2eaebb15 100644 --- a/docs/Modders/manifest-files/character-traits.md +++ b/docs/Modders/manifest-files/character-traits.md @@ -522,6 +522,52 @@ Example: ] ``` +**blendshapeTraits *(optional Object[])***: An array of Blendshape Trait definition. Let's you define blendshapes as traits. These traits will be removed at export stage. +Note that we currently treat every blendshape trait (those defined in the manifest) as binary. I.e. they're either on or off. + +```json +... +"collection": [ + { + "id": "male", + "name": "male", + "directory": "Body/male.vrm", + "thumbnail": "Body/male.png", + "blendshapeTraits":[{ < --------------- + "trait":"nose", + "name":"Nose", + "cameraTarget": { + "distance": 0.75, + "height": 1.5 + }, + "collection":[{ + "id":"Nose_LONG", + "name":"Long Nose" + }] + }] + } +] +``` + +A BlendshapeTrait Group definition has the following traits: + +**trait *(string)***: Group id of the blendshape group. + +**name *(string)***: Name of the blendshape group. + +**cameraTarget *(optional Object)***: Define distance and height of the blendshape group. + +**collection *( Array of Object)***: The Array of Blendshape traits, defined below. + +> **id *(string)***: ID of the blendshape, this also has to be the exact blendshape name (case-sensitive) +> +> **name *(string)***: Name of the trait. +> +> **fullThumbnail *(optional string)***: Path to the thumbnail of that blendshape trait. + + + + ___ ## Texture Collection Section (textureCollections): From db11fad19be64412dbf634521e50ff7492229870 Mon Sep 17 00:00:00 2001 From: Benjythebee Date: Fri, 18 Oct 2024 07:10:49 +1300 Subject: [PATCH 2/3] fix typo --- docs/Modders/manifest-files/character-traits.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Modders/manifest-files/character-traits.md b/docs/Modders/manifest-files/character-traits.md index 2eaebb15..b986327d 100644 --- a/docs/Modders/manifest-files/character-traits.md +++ b/docs/Modders/manifest-files/character-traits.md @@ -522,7 +522,7 @@ Example: ] ``` -**blendshapeTraits *(optional Object[])***: An array of Blendshape Trait definition. Let's you define blendshapes as traits. These traits will be removed at export stage. +**blendshapeTraits *(optional Object[])***: An array of Blendshape Trait definition. Let's you define blendshapes as traits. These blendshapes will be removed at export stage. Note that we currently treat every blendshape trait (those defined in the manifest) as binary. I.e. they're either on or off. ```json From 3af47e74c8b574074df05801170775164f1a3ac2 Mon Sep 17 00:00:00 2001 From: Benjythebee Date: Fri, 18 Oct 2024 07:11:31 +1300 Subject: [PATCH 3/3] typo --- docs/Modders/manifest-files/character-traits.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Modders/manifest-files/character-traits.md b/docs/Modders/manifest-files/character-traits.md index b986327d..a76a30ca 100644 --- a/docs/Modders/manifest-files/character-traits.md +++ b/docs/Modders/manifest-files/character-traits.md @@ -549,7 +549,7 @@ Note that we currently treat every blendshape trait (those defined in the manife ] ``` -A BlendshapeTrait Group definition has the following traits: +A BlendshapeTrait Group definition has the following properties: **trait *(string)***: Group id of the blendshape group.