vrm-rigify

Generate Blender Rigify armatures for VRM models.

Notice

The latest version of this addon has been tested with:

• Blender versions 4.1.1 through 5.1.2
• VRM Add-on for Blender versions 2.20.54 through 4.4.0

and supports both the VRM 0.x and 1.0 format. This addon has been tested using VRoid's sample avatars. If you're using an older version of Blender (2.x or 3.x), use version 0.1.1 of this addon.

This addon is designed for models authored in VRoid Studio or models that follow VRoid's bone naming conventions (J_Bip_C_Chest). Models with bone names that collide with the names of the control bones that Rigify generates (chest, f_index.01.L) are not supported: their meshes will not follow the generated rig.

Installation

1. Download vrm_rigify.zip from the releases page.

2. Install VRM Add-on for Blender if it is not already installed.

3. Open Blender and go to Edit > Preferences > Add-ons:

   

4. Click on Install... and select vrm_rigify.zip.

5. Check the box next to the addon to enable it:

   

6. Ensure the addons Import-Export: VRM format and Rigging: Rigify are also enabled.

7. In the same Blender Preferences window, go to Interface.

8. Check the box labelled Developer Extras. This is necessary to show the addon's commands in Blender's operator search menu:

   

Usage

Generating the Rigify armature

1. Import a VRM model by going to File > Import > VRM:

   

2. Select the imported armature object in the outliner:

   

3. Go to Edit > Operator Search... or press F3:

   

4. Search for Generate Rigify armature for VRM model and press Enter:

   

5. The Rigify armature has now been generated! It will appear as Armature.rig in the outliner:

   

   Note that location of Armature.rig and Armature.metarig in the outliner may differ depending on the last selected collection.

Parenting the meshes to the armature

1. Expand the (now hidden) imported armature object and select the meshes inside it:

   

2. While the meshes are selected, select the generated Armature.rig Rigify armature.

3. Right click and select Parent > Armature Deform:

   

4. The meshes should now be parented to the new armature. Expand the contents of the new armature object in the outliner:

   

5. For each mesh, under their Modifiers, move any armature modifiers to the top of the modifier list, before all other modifiers:

   

   You do not have to do this if there are no other modifiers present.

6. You can now pose the model by entering Pose Mode:

   

7. (Optional) Remove any objects that are no longer needed:

   

Testing

With Blender 4.2 or later installed (the test runner installs the VRM addon through Blender's extension system), run:

./tests/run.sh

This downloads the latest release of the VRM addon and a set of sample models, then generates a rig for each model in the background and checks the result. Everything runs against an isolated Blender configuration in tests/.blender so your own Blender preferences and addons are not touched. Tests also run on GitHub Actions for every push to catch incompatibilities with new versions of Blender and the VRM addon.

License

This addon is licensed under the MIT license. The VRM avatar pictured is AvatarSample_A belonging to VRoid.