Code Monkey home page Code Monkey logo

vrm-rigify's Introduction

vrm-rigify

Generate Blender Rigify armatures for VRM models.

Notice

This addon has been tested with VRoid's sample avatars and only supports the VRM 0.x format.

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 Humanized VRM Rig 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:

License

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

vrm-rigify's People

Contributors

nanoskript avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

vrm-rigify's Issues

Correction of readme.

Add the following line
This was missing and did not work properly, and I thought about it for about 5 minutes. xD

6.Make sure the following add-ons are enabled.Import-Export: VRM format Rigging: VRM Rigify Rigging: Rigify

## Installation

1. Download `vrm_rigify.zip` from the [releases page](https://github.com/Nanoskript/vrm-rigify/releases/tag/latest).
2. Install [VRM Add-on for Blender](https://vrm-addon-for-blender.info/en/) if it is not already installed.
3. Open Blender and go to `Edit` > `Preferences` > `Add-ons`:

   <img src="docs/install.png" width="384px">

4. Click on `Install...` and select `vrm_rigify.zip`.
5. Check the box next to the addon to enable it:

   <img src="docs/enable.png" width="256px">

6.Make sure the following add-ons are enabled.`Import-Export: VRM format` `Rigging: VRM Rigify` `Rigging: Rigify`

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:

   <img src="docs/developer.png" width="384px">

Shows "too many VRoid bones found for `^Hips`" when Generate Humanized VRM Rig

Model: Free Mode herel https://booth.pm/ja/items/3521047
Error Message :

Python: Traceback (most recent call last):
  File "C:\Users\Administrator\AppData\Roaming\Blender Foundation\Blender\4.0\scripts\addons\vrm_rigify\meta.py", line 49, in position_meta_rig
    conversions = create_bone_mapping(base_bones, vroid_rig)
  File "C:\Users\Administrator\AppData\Roaming\Blender Foundation\Blender\4.0\scripts\addons\vrm_rigify\base.py", line 106, in create_bone_mapping
    assert len(vroid_matches) == 1, f"too many VRoid bones found for `{vroid_pattern}`"
AssertionError: too many VRoid bones found for `^Hips`

Perhaps It matched a collider here.
image

And if it's possible, it's really easy to show an UI panel in blender insteading of let user perform an action. (and also could allows adding more customized options)
There is just a random tutorial I found to do that.
https://www.youtube.com/watch?v=Qyy_6N3JV3k&pp=ygUUYmxlbmRlciBwbHVnaW4gcGFuZWw%3D

Can generation for hair be added?

As of right now after my model after the humanized step it's all correct except that there's no hair bones. I am trying to manually move the old hair bones to the new armature but I don't really know how. Could it be generated along side when doing the humanized step?

I'm trying both just parenting and joining both armatures, but the hair bones does not move with the head's rotation and I don't really know how to get it to work together.

Sorry if it does not sound clear, I don't really know how to explain it. :P

Rigify armature generation crashes on Blender 3.0 & 3.6

Hi, it seems that the plugin is crashing when generating the Rigify armature / Humanized VRM Rig on fresh Blender 3.0 and 3.6 installs in Windows with a VRM from VRoid Studio.

Upon importing a fresh VRM file exported from Vroid Studio 0.14.0, selecting the armature and doing Generate Humanized VRM Rig, I get the following error on both Blender versions:

Python: Traceback (most recent call last):
  File "C:\Users\SomeUser\AppData\Roaming\Blender Foundation\Blender\3.6\scripts\addons\vrm_rigify\__init__.py", line 42, in execute
    meta_rig = meta.generate_meta_rig(vroid_rig)
  File "C:\Users\SomeUser\AppData\Roaming\Blender Foundation\Blender\3.6\scripts\addons\vrm_rigify\meta.py", line 69, in generate_meta_rig
    bpy.ops.object.armature_human_metarig_add()
  File "C:\Program Files\Blender Foundation\Blender 3.6\3.6\scripts\modules\bpy\ops.py", line 113, in __call__
    ret = _op_call(self.idname_py(), None, kw)
AttributeError: Calling operator "bpy.ops.object.armature_human_metarig_add" error, could not be found

Blender version: 3.0.1 / 3.6.3
vrm-rigify version: latest build (Aug 20, 2023)
VRM-Addon-for-Blender version: 2.20.7
Vroid Studio version: 0.14.0

What's the supported Blender version for this plugin? I could not find any info.

hair parts aren't following the rig

after the parenting part, i tested it by moving the waist part of the rig. The model is moving fine but for some reason, the extra parts of the hair did not move
image_2023-12-22_224325564

Wrong fingers controls

Hey. First of all thank you for this addon, it looks really helpful. The only issue I've found is that finger controls are bending in wrong direction, seems like only thumb has correct orientation

I have blender 3.2.0, Vroid Studio 1.19.0, import-export vrm addon 2.14.11

image

Can move the finger way too far

Hey!
Just to let you know, i find the Idea Awesome!

Can you help me with the finger streching and some of the rig on the arm not following?
I did follow everything, 3 times, rereading everytime.

image

Incompatibility with Blender 3.3.6 and later

After importing the VRM, only hair and part of faces can be animated after reparenting to the generated armature rig. This only happens after blender 3.3.6. This works well with no issue in blender 3.0.x with rigify version 0.6.4.

This add-on is cool hidden gem, so would be nice if it can still be used with the newest blender version.

Error when trying to generate humanized VRM rig

I got this error using the "Generate Humanized VRM rig" command. I'm using a model exported from VRoid Studio 1.19.0. I'm not sure what version of VRM VRoid uses, but if it's using VRM 1.0, maybe that's the problem?

Error: Python: Traceback (most recent call last):
  File "C:\Users\thebu\AppData\Roaming\Blender Foundation\Blender\3.3\scripts\addons\vrm_rigify\__init__.py", line 42, in execute
    meta_rig = meta.generate_meta_rig(vroid_rig)
  File "C:\Users\thebu\AppData\Roaming\Blender Foundation\Blender\3.3\scripts\addons\vrm_rigify\meta.py", line 55, in generate_meta_rig
    position_meta_rig(meta_rig, vroid_rig)
  File "C:\Users\thebu\AppData\Roaming\Blender Foundation\Blender\3.3\scripts\addons\vrm_rigify\meta.py", line 35, in position_meta_rig
    conversions = create_bone_mapping(base_bones, vroid_rig)
  File "C:\Users\thebu\AppData\Roaming\Blender Foundation\Blender\3.3\scripts\addons\vrm_rigify\base.py", line 111, in create_bone_mapping
    assert vroid_matches, f"no VRoid bones found for `{vroid_pattern}`"
AssertionError: no VRoid bones found for `^Index3_end`

image

hand bone not generating

Like the title says, the hand ik bone is not generating for some reason, there are no errors or anything, its just isnt there.
The rest of the rig works well.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.