/rokoko-studio-live-blender

Rokoko Studio Live plugin for Blender

Primary LanguagePythonGNU Lesser General Public License v3.0LGPL-3.0

Rokoko Studio Live Plugin for Blender

Rokoko Studio is a powerful and intuitive software for recording, visualizing and exporting motion capture.

This plugin lets you stream your animation data from Rokoko Studio directly into Blender. It also allows you to easily record and retarget animations.


Requirements

  • Blender 2.80 or higher
  • For livestreaming data: Rokoko Studio 1.18.0b or higher or Studio 2
  • An internet connection during the installation to get the required libraries

Features

  • Live stream data:
    • Up to five actors that can all include both body, face (52 blendshapes) and finger data at the same time
    • Camera data
    • Props data
  • Control Rokoko Studio from within Blender
  • Easily retarget motion capture animations

Installation

  • Download the latest version here
  • In Blender go to Edit > Preferences > Addons > Install.. and then select the downloaded zip file
    • First time installation can take a while
  • To use the plugin, press N and select the Rokoko panel

Getting Started for Streaming

Make sure the model is ready for Studio Live

The character in Blender has to be in T-pose:

For SmartGloves: Make sure that the character's hands and fingers are posed as close as possible to the following pose to get the best possible retargeting of finger animation. All fingers should be straight and the thumb should be rotated 45 degrees away from the other fingers.

Enabling Rokoko Studio Live

  • In Rokoko Studio go to settings and click on Studio Live in the dropdown menu and enable the Blender data stream. You can customize the streaming address and port by clicking the wrench icon at the top left

       

Receiving the Data in Blender

  • In the 3D view press N or the little arrow on the right side, then select the "Rokoko" tab and press "Start Receiver" to start receiving data from Rokoko Studio

           

Streaming Character Data

  • After starting the receiver select the armature that you want to animate

  • Go into the object category and open the "Rokoko Studio Live Setup" panel

  • In the actor field select the Smartsuit that you want to use for this armature

  • Fill all bone fields by pressing “Auto Detect” and check if all bones are correctly filled in and fill in missing bones if necessary

  • Ensure that the selected armature is in T-Pose and then press “Set as T-Pose”

  • Done! Your armature should be animated by the live data:

  • Optional: In order to improve animation performance enable “Hide Meshes during Play” in the receiver panel

  • If you experience any lag while using the plugin, close the window that shows key frames (e.g. timeline or action editor). Blender will run much smoother as the panel takes a lot of resources.

Streaming Face and Prop Data

  • This uses the exact same workflow as streaming character data

  • Just select the face mesh for face data or the object for prop data and then follow the steps above

  • Done! Your face mesh or prop should now be animated by the live data

       

  • Note for prop data: After selecting the prop data you can turn on "Use Custom Scale" and change the animation scale for this prop, to make sure it fits your Blender project


Retargeting

In order to retarget an animation in Blender you will need to do the following:

  • Open the Retargeting panel

  • Select an armature with an animation as the source armature, select an armature that should receive the animation as the target armature and then press "Build Bone List"

  • Check if the bones got filled in correctly and fix any incorrect or missing bones

  • Select "Auto Scale" if the armatures differ in size or resize them manually

  • In "Use Pose:" select the pose that should be used for retargeting

  • Important: Make sure that both armature are in the same pose for correct retargeting

  • Press "Retarget Animation"

  • Done!


Changelog

1.4.1

  • Added support for Blender 3.4
  • Fixed multiple smaller issues

1.4.0

  • Added support for Blender 3.0/3.1 and Rokoko Studio 2
  • Fully reworked login
    • Login now works via browser for easier use
  • Retargeting: Added support for multiple target bones per source bone

1.3.0

  • Added support for Blender 2.93
  • Fixed login email being case-sensitive
  • Added a popup with a download link in case the user is missing a Windows library

1.2.1

  • Fixed login issue when using a Blender UI language other than English

1.2.0

  • Added support for the new Rokoko Smartgloves
  • Fixed an issue with the auto-updater which caused updates to fail

1.1.1

  • Added Retargeting panel
    • This allows you to easily retarget any animation from one character to another
    • It uses our auto detect system to automatically find matching bones between the two characters
  • Added the functionality to save, import and export custom naming schemes
  • Added recording timer
  • Reworked saving of recordings
    • This resulted in heavily improved processing speeds of recorded animations
    • Recordings no longer need to be split
    • Recorded animations are now using euler angles instead of quaternion
      • This allows for easier editing and better continuity of the animation
  • Added patch that fixes the slow import of FBX animations in Blender 2.80 to 2.82
    • This means that as long as you have this plugin enabled, you will get very fast FBX animation imports
    • We submitted this patch to Blender officially and it got accepted, so it is included by default in Blender 2.83 and higher (fast imports for everyone, hooray!)

1.0.0

  • First version of Rokoko Studio Live for Blender
  • Character animation and recording
  • Face animation and recording
  • Virtual production animation and recording
  • Studio Command API support.
  • Auto-updater