Rig tool

Put a character on our animations, give it hair or a tail, and save the result. Pick one of the demo characters or load your own GLB. Check which bone plays which role, hang spring chains on it, and try it with any of the Universal Animation Library's clips, beside the mannequin they were made on. Save the recipe: applyRigRecipe puts the same rig on the same model in a game.

import { rigTool } from 'tosijs-3d/rig-tool'

preview.closest('tosi-example')?.style.setProperty('--tosi-example-height', '600px')
preview.append(rigTool())

Using it

It opens standing still in its REST pose (a T or an A), with a dot on the bone each role uses: tap a dot to choose that role (it turns yellow), then tap the body where that bone is to give the role to it. Set clicking sets to the chain and a tap hangs the chosen spring chain there instead. A strand's root and tip are orange handles: drag them to place it. Turn on animate (or pick a clip) to see it move.

The panel has four sections.

• Model. A demo character, or load model file… for a GLB of your own (a single file: a .gltf with separate buffers cannot be opened this way). A model needs a skeleton; one without can be rigged on the auto-rig page first.
• Roles. Which bone is the hips, the head, the left forearm, each finger joint. They are guessed from the names; fix one by tapping, as above, or pick a role and then the bone that plays it, or (none) to leave it out. arm space turns the arms out from the body, for a character whose arms are long for its height.
• Springs. + strand hangs a new chain with a tube from a bone (a ponytail): place it with offset, yaw and pitch, size it, and tune how it swings. + bone chain simulates bones the model already has (a tail): pick the chain's first bone. Stiffness and damping change live; the rest rebuild the chain.
• Recipe. save downloads the recipe as JSON, load reads one back, copy puts it on the clipboard. The working recipe is also kept in this browser, per model, so a reload does not lose it.

Pick a clip at the top. compare shows UAL's mannequin playing the original beside it; bones draws the skeleton.

A recipe in a game

import { applyRigRecipe, readSkeleton, retargetClip } from 'tosijs-3d'

const rig = applyRigRecipe(scene, root, skeleton, recipe)
const walk = retargetClip(ualWalk, readSkeleton(ualSkeleton, ualRoot), rig.read, {
  scene,
  armSpaceDeg: recipe.armSpaceDeg,
})
walk.start(true)

The element rigTool() returns carries .rig: recipe (get a copy, set one to apply it), applied and load(model), for a page or an editor driving the tool.

rig.problems lists anything in the recipe the model does not have (a bone renamed since it was saved), and rig.springs the live chains, whose bones.params can be changed while it runs.