[Unity/VRM] VRM Setup Assistant Unity Editor Extension Usage Guide

Overview

This guide explains how to use VST/VST1, Unity Editor extensions designed to assist with VRM setup. For inquiries, please contact the author via SNS links available on the top page.

Installation

1. Download the unity package from GitHub/Booth
   • VST (VRM 0.x): GitHub , Booth
   • VST1 (VRM 1.x): GitHub , Booth
2. Open your Unity project and import the VRM/VRM10 unity package
3. Add the VST/VST1 unity package to your project

Features

VST v1.1.0

• Create BlendShapeClips with the same names as BlendShapes existing in model data
• Output the results of applying each BlendShapeClip to image files

VST1

• Create Expressions with the same names as BlendShapes existing in model data

Usage

VST

Testing Environment: Unity 2021.3.40f1 / UniVRM v0.128.0_264a

Creating BlendShapeClips

Demo:

1. Display the tool window from the menu bar

   VRM0 / VST / BlendShape / BlensShapeClipGenerator
   

2. Set Game Objects in each field
   • VRM Prefab: The Avatar Prefab for which to create Blend Shape Clips
   • Export Folder: Output folder for Blend Shape Clips
   • Blend Shape Selector: Select Blend Shapes for creating Blend Shape Clips
     Note: Only displayed when VRM Prefab is set
     • Prefix Depth: When Blend Shape names have prefixes, indicates the level of nesting
       • Example: ALL_<name> → 1, Fcl_ALL_<name> → 2
       • Value used for grouping in the selection menu
   • Options
     • Source Mesh (default: None): If a Mesh is set here, the Blend Shapes of that Mesh will be used as the source for creating Blend Shape Clips
     • Remove prefix in clip name (default: enable): Removes prefixes from the names of created Blend Shape Clips
       • Example: ALL_Joy → Joy
       • Uses the last block when the name is split by _ as the Blend Shape Clip name
       • If there are predefined suffixes like _L/_R, _Open/_Close, uses the block before the suffix as the Blend Shape Clip name (duplicates allowed)
         • Example: Fcl_EYE_Close_L → EYE_Close_L
       • The suffix list is defined in SUFFIX_LIST on line 14 of Assets/VST/Editor/BlendShape/BlendShapeClipGenerator.cs (GitHub)
       • Blend Shape names are converted to lowercase during processing, so all suffix definitions are in lowercase
       • You can modify it locally for your own use
       • If you have requests for adding/removing suffixes, please contact the author

• Skip if clip already exists (default: disable): If a Blend Shape Clip with the same name already exists, skip it and continue processing

3. Press the Create Blend Shape Clips button to generate Blend Shape Clips with the same names as the Blend Shapes existing in the Avatar, setting the corresponding Blend Shape to 100

Image Output of BlendShapeClip Application Results

Demo:

1. Display the tool window from the menu bar

   VRM0 / VST / BlendShape / Screenshot
   

2. Set Game Objects in each field
   • VRM Prefab: The Avatar Prefab for image output
   • Output Folder: Image output folder
   • Image Size: Output image resolution
   • File Format: Output image format
   • Camera List: Cameras to serve as image sources
3. Press the play button to enter Play Mode
4. Press the Capture BlendShape Results button to output images to the specified folder

VST1 v1.0.0

Testing Environment: Unity 2021.3.40f1 / VRM v0.128.0_264a

Creating Expressions

Demo: https://x.com/arch4e_lab/status/1885998989696463312

1. In the Asset folder, execute Extract Meta And Expressions ... in the VRM tab of the imported VRM
2. Display the tool window from the menu bar

   VRM1 / VST1 / Expression / Create Expression
   

3. Set Game Objects in each field (options are the same as VST’s CreateBlendShapeClip)
   • VRM Prefab: Prefab file existing in the Asset folder
     ※Not a Prefab in the Hierarchy
   • Export Folder: Output folder for asset files
4. Press the button to generate Expressions with the same names as the Blend Shapes existing in the Avatar, setting the corresponding Blend Shape to 100