VNyan SDK - Lunazera/VNyanDoc GitHub Wiki

Recommended Unity version: Unity 2020.3.48 with UniVRM 0.104

VSeeFace SDK

If you are working with the VSeeFace SDK, then it's recommended to use Unity 2019.4.31 and UniVRM 0.89

If you require any VNyan SDK components to work on a vsfavatar, you can add them to the whitelist export in AvatarCheck.cs (found here in the VSF SDK). Or disable this check from the vsfavatar export completely. Likely the model will not work in VSeeFace anymore, but should load without issue in VNyan.

VNyan Components

AvatarInterface

PoseLayer

Anim Param Link

Used to link VNyan parameters to animator float parameters. You can use these to control blendtrees

Avatar Bone Follower

Avatar Object Follower

Avatar Transform Link

Blendshape Param Link

Call VNyan Trigger

Camera Look At

Droppable Object

Include this script on your game object to export the prop as a droppable object (with the extension .vndrop). You can set a separate game object to render on collision, allowing you to set up particle effects. You can also set whether the object should be sticky and whether they will destroy when colliding with your avatar or another object.

The script expects a Rigidbody applied to the game object to work. If you want the object to collide with your avatar or other objects, you must also add a collider (either a Box or Capsule collider). The collider will need you to set a Physic Material as well. If you want audio to play upon collision, you can add an Audio Source.

Droppable objects can collide with each other, meaning that they can pile up on top of each other over time. When making a droppable object, don't include other conflicting scripts on the object (like the Throwable Object script), otherwise collision with other dropped items might not function properly.

Edible Item

Injected Anim

Orientation Trigger

Particle Object

Proximity Trigger

Set Browser Content

Set Browser URL

Set Layer

Set Parameter

Set Shader Float From Param

Set Text Value

Set Transform From Param

Throwable Object

UI Browser

VNyan Camera

World

World Lightmap Settings

Other Whitelisted Components

  • uWindowCapture
  • Cinemachine
  • Embedded Browser
  • VSFavatar