VRM Avatar Streaming

Stream VRM avatars with full VRM 1.0 support: expressions, look-at, spring bones, humanoid animation, VRMA playback, first-person filtering, and MToon material rendering.

Prerequisites

Core VRM features work without UniVRM. VRMA animation and MToon shading require UniVRM:

https://github.com/vrm-c/UniVRM.git?path=/Assets/UniGLTF#v0.130.1
https://github.com/vrm-c/UniVRM.git?path=/Assets/VRM10#v0.130.1

Feature	Without UniVRM	With UniVRM
Expressions, look-at, spring bones	Supported	Supported
Humanoid bones & Mecanim	Supported	Supported
First-person filtering	Supported	Supported
MToon material (toon shading)	Fallback (unlit)	Full MToon10 rendering
VRMA animation	Not supported	Full support

---

MToon Material Support

VRM models using MToon materials (toon/cel-shading) are automatically rendered with the correct MToon10 shader when UniVRM is installed. The SDK reads VRMC_materials_mtoon extension data from the XRG file and applies all MToon properties including shade color, shading shift, rim lighting, outline, and UV animation.

The SDK auto-includes MToon shaders in builds via MToonShaderIncluder. If rendering appears incorrect (white/unlit), ensure UniVRM packages are installed and the MToon shader is available in your build target.

Render Pipeline	Shader Used
Built-in (BRP)	VRM10/MToon10
URP	VRM10/Universal Render Pipeline/MToon10

---

Setup

Same as any model — StreamController + StreamingModel with a VRM-based XRG URL. VRM controllers are auto-initialized on load. No manual VRM component setup needed.

For Mecanim animation, drag an AnimatorController into Custom Animator Controller and press Play.

---

Quick API Overview

Expressions

streamingModel.SetVrmHappy(0.8f);
streamingModel.SetVrmBlink(1.0f);
streamingModel.SetVrmAa(0.5f);    // Lip-sync viseme
streamingModel.ResetVrmExpressions();

Look-At

streamingModel.SetVrmLookAtTarget(Camera.main.transform);

Spring Bones

streamingModel.SetVrmSpringBonesEnabled(true);
streamingModel.ResetVrmSpringBones();  // After teleporting

VRMA (requires UniVRM)

bool ok = await streamingModel.LoadVrmaFromUrlAsync("https://example.com/dance.vrma");
if (ok)
{
    streamingModel.SetVrmaLoop(true);
    streamingModel.PlayVrma();
}

Humanoid Bones

Transform head = streamingModel.GetVrmBone(HumanBodyBones.Head);

---

Important

Always check IsVrm and wait for load before calling VRM APIs:

streamingModel.SetLoadedCallback(() =>
{
    if (streamingModel.IsVrm)
        streamingModel.SetVrmHappy(1.0f);
});

---

For the full API reference (spring bone physics override, first-person setup, VRM meta, VRMA time control, complete examples, troubleshooting), see USAGE_VRM_STREAMING.md shipped with the SDK package.