Page Comparison

...

Quick facts:

• Shared location: https://svn.ict.usc.edu/svn_vh/trunk/
• Toolkit's vhAssets Package Location: \\vhbuild2\VHToolkit-Builds (sort by Date)
• vhAssets Package Source Location: https://svn.ict.usc.edu/svn_vh/trunk/lib/vhunity
• Project location(s): Toolkit (https://svn.ict.usc.edu/svn_vhtoolkit/trunk)
• Main developers: Ed Fast, Adam Reilly

Unity

Unity is available within ICT.  The latest version is available through SVN here:

https://svn.ict.usc.edu/svn_vh/trunk/core/Unity

This location has the latest up-to-date version of Unity, with the documentation pruned for space.

The entire Unity distribution is available here.  

https://svn.ict.usc.edu/svn_vh/vendor/unity/current

Also, all previous versions of Unity are tagged in this vendor branch as well.

Please note that you need a Serial # for Unity Pro.  Please contact Helpdesk for a Serial #.

For projects, it is recommended to use the version of Unity in SVN.  It is virtually the same as installing Unity from the web site*.  But you get the bonus of:

• Knowing that every person on the project is using the exact same version of Unity.
• Upgrading to a newer version is as easy as updating the svn external.  No need to uninstall, distribute the installer, etc.
• Allows different projects to use different versions of Unity, depending on their timetables.  Very useful when working on multiple projects on the same machine.

* The only difference in installing Unity vs using SVN is that certain file associations are not registered (in Windows).  So, double-clicking on a .unitypackage will not open it.  But right-click->Import New Package works fine.

More internal Unity documentation can be found here:  /wiki/spaces/com/pages/16056743

Using vhAssets

Location

vhAssets is distributed via the vhAssetsPackage.unitypackage, vhAssetsPackageOSX.unityPackage, and vhAssetsTestScenePackage.unityPackage.  It is built regularly by our build server, so it will always contain the latest code.  It can be found, along with all of our other Unity packages here:

\\vhbuild2\VHToolkit-Builds (sort by Date)

...

First Time Installation

1. Bring the .unityPackage file inside of your Unity project Assets folder
2. Double click it
3. Click Import
4. Add all the imported files into svn

...

Upgrading .unitypackage files is a little more difficult.  This quote from the Unity docs explains it:

"For the cleanest possible upgrade, it should be considered to remove the old package contents first, as some scripts, effects or prefabs might have become deprecated or unneeded and Unity packages don't have a way of deleting (unneeded) files (but make sure to have a security copy of the old version available)."

The easiest way I've found is to use the approach the SVN docs recommend for vendor branch upgrades.

...

Through the Unity Editor, many variables of vhAssets script components can be customized

DebugConsole

Captures all SmartBody and Unity log ouput and display it to user. Also can be used to send commands. Type '?' for a list of available commands.

FreeMouseLook

Loading Screen

Provides functionality for full screen image

...

Allows for control of the call ordering of all MonoBehaviour messages sent from Unity.

VHBehaviourManager

The control system that allows for correct processing order of VHBehaviours.  This object MUST be present in order for VHBehaviours to work

VHWayPointNavigator

VHTimeDemo

Works with VHWayPointNavigator and FpsCounter to track performance along a specified path in the scene and then uploads fps/performance data to a database

SmartBodyManager

Interfaces with SmartBody.dll to provide SmartBody character animation to unity

UnitySmartBodyCharacter

Works with SmartBodyManager to have a SmartBody driven character inside of unity

VHMsgManager

Interfaces with VHMsg that allows communication via strings between processes

Developers

All vhAssets code can be modified directly in the repository https://svn.ict.usc.edu/svn_vh/trunk/lib/vhunity/vhAssets

...

Loading vhAssets Scene

1. Open Unity
2. File->Open Project (this may already be done for you if this is the first time you've launched Unity)
3. On the Open Project tab, click the Open Other button.
4. Navigate to the vhAssets Unity Project here: <VHToolkit>\lib\vhunity\vhAssets
5. Click Select Folder
6. In the Project column, double click on vhAssetsTestScene.
7. Click Play

Creating your own Project using the vhAssets Unity Package

1. Open Unity
2. File->New Project
3. You need 2 Unity Packages to start with.  You'll find all packages here: <VHToolkit>\bin\vhAssets.  Copy them to <your project>\Assets. 
4. First, is the vhAssets package.  This contains common scripts and libraries used in various Virtual Humans applications.  There is a different .unitypackage file for each platform.  
   
   1. vhAssetsPackage.unityPackage    (Windows)
   2. vhAssetsPackageOSX.unityPackage
   3. vhAssetsPackageIOS.unityPackage
   4. vhAssetsPackageAndroid.unityPackage
5. Second, is the vhAssets Test Scene.  This contains assets and scripts that will initialize a very basic test scene environment.  This file is:  vhAssetsTestScenePackage.unityPackage
6. Copy the 2 Unity Packages to this new project.
7. In Unity, in the 'Project' column, double click on the 2 Unity Packages.
8. Open Scenes->vhAssetsTestScene
9. Click Play.  The virtual human should be animating in an idle pose.  Hit 'C' to show a debug menu.  You should be able to control him via the buttons on the debug menu.

Creating your own Virtual Human (Smartbody)

Creating your own Virtual Human has different meanings to different groups.  Some people want to use the existing characters that we supply, but only change certain features like giving them a different voice, or a different colored shirt.  Others groups want to use a different character, but the character was created using a standard character package that we already support (Mixamo, etc).  Others want to use a completely different character with a unique skeleton, etc.   These instructions will attempt to explain the different features and how to customize based on your needs.

The easiest way to use your own Virtual Human is to create a Unity Project using the included .unitypackages as a starting point.  From here, you can add/change features on the default character, or bring in your own and customize using the existing character for reference.

Smartbody initialization

• SmartbodyInit class (Attached to SmartbodyManager gameobject)
  Image Added
  
  • asset paths
  • joint mapping
  • mapped skeletons/motions
     

• SmartbodyCharacterInit class  (Attached to each character gameobject)
  Image Added
  
  • skeleton name (.sk)
  • voice type (prerecorded audio or tts)
  • voice "code"  (path to audio files or tts voice name)
  • backup voice type and backup "code"  (if prerecorded audio file is not found, you can use TTS as a backup)
  • starting posture
  • locomotion information
    
    
• SmartbodyFaceDefinition class (Attached to each character gameobject)
  Image Added
  
  • defines visemes and facial expressions for the character.
  • visemes and facial expression are single pose animations (.skm) for doing blended lip-sync and expressions.
  • neutral pose, action units and visemes
    
    
• SoundNode gameobject
  Image Added
  
  • Empty gameobject named 'SoundNode' attached as a child of the character's gameobject
  • Attach a Sound Source script to the SoundNode gameobject
  • Manually position the SoundNode gameobject where you want the character's speech to originate (eg, his mouth)

Character Configuration

Every character should have a script associated with him which specifies the attributes of the character. This class is derived from the SmartbodyCharacterInit class.It specifies the following parameters

• unityBoneParent
• assetPath
• skeletonName
• voiceType
• voiceCode
• voiceTypeBackup
• voiceCodeBackup
• useVisemeCurves
• startingPosture

The parameters allow us to configure the character correctly with respect to smartbody. Please take a look at the 'InitBrad.cs' file for an example of how to configure the character

Changing the Character Voice

The character can use audio files on a per utterance basis, or it can use a TTS generated voice. If using audio files, the voiceType parameter in the above mentioned configuration will be set to 'audiofile' and the voiceCode parameter will point to the folder containing the sound files for the character.

e.g. in the case of the character Brad, His voice files are under the folder "Sounds". This folder contains the audio files and the corresponding .bml and .xml files which are the lipsynch schedule and the non-verbal behavior respectively.

If you want the character to use the TTS generated voice, you will set the voiceTypeBackup parameter to "remote" and set the voiceCodeBackup parameter to the name of the voice you want to use. The name of this voice can be obtained by looking at the TTSRelay application which prints out the available voices on launching.

When Smartbody cannot find audio files, it defaults to the TTS voice and uses the voice you specified as the characters voice.

Online Motion Retargeting

Smartbody has the capability of online retargeting motions built for one character to another.  This can be done in two steps.

• In your Init script, when setting the assetPaths, the first parameter specifies the skeleton the motions belong to.  ie in Rachel's InitRachel.cs, there's a line:
  assetPaths.Add(new KeyValuePair<string, string>("ChrRachel.sk", "Art/Characters/SB/ChrRachel"));
  This says to load all the motions in the ChrRachel folder and assign them to the ChrRachel.sk skeleton.
  If you want to retarget Brad's motions to Rachel, you need to add another line:
  assetPaths.Add(new KeyValuePair<string, string>("ChrBrad.sk", "Art/Characters/SB/ChrBrad"));
  This says the motions in the ChrBrad folder are for the ChrBrad.sk skeleton, and they should be retargeted to ChrRachel.sk.
• On the character's gameobject, for each source skeleton that you use for retargeting, you need to set the skeleton mapping on that skeleton.  For example, if you look at Rachel's gameobject, you'll see two skeleton mapping components.  Each one is a Zebra2 mapping, but one is for ChrRachel.sk and one is for ChrBrad.sk since Rachel uses both ChrRachel and ChrBrad motions.
  Image Added

After doing these two steps, you should be able to use one character's motions on another.  In the above example, you should be able to play a motion like ChrBrad@Idle01_ArmStretch01.skm on Rachel, eg:

SmartbodyManager.SBPlayAnim("Rachel", "ChrBrad@Idle01_ArmStretch01.skm");

Creating your own Virtual Human (Mecanim)

A new scene entitled "mecanim" has been added to the vhAssets package which displays 2 of the Brad character, one driven by the Smartbody animation system and the other by Unity's Mecanim animation system.  This scene is currently in development but can be used as a guide for how to setup a mecanim character. This scene needs to be loaded through the MainMenu scene to work properly. Alternatively, you can manually activate the SmartbodyManager, VHMsgManager, and DebugConsole objects.

Image Added 

Setup

Select a gameobject and add the MecanimCharacter component to it.  By adding this one component, other components required to make the character nod, blink, gaze, etc will automatically be added.  Make sure there is a gameobject with the MecanimManager component in the scene as well.

For an example of how to setup a mecanim driven character, click on the gameobject ChrBradPrefab_Mecanim in the mecanim scene.  Also add a child game object called "SoundNode" and attach an audio source to it. Again, see ChrBradPrefab_Mecanim as a reference.

Image Added

Testing

Use the UI menu on the left side of the screen to test animations, nods, gazes, saccades, and lip sync.

Mecanim Help

For information on Mecanim, please visit Unity's documentation http://docs.unity3d.com/Manual/AnimationOverview.html

DebugConsole

Add a new command callback for an arbitrary command

m_Console.AddCommandCallback("some_command", new DebugConsole.ConsoleCallback(HandleConsoleMessage));

void HandleConsoleMessage(string commandEntered, DebugConsole console)

{
      if (commandEntered.IndexOf("some_command") != -1)

           // Do Something
}

To use the console, at run-time hit the ~ key. Type '?' and hit enter to see a list of commands. If you used the code above in your script, you should see "some_command" in the list. Note, you can pass additional arguments with these commands.

Send arguments with a command while typing in the console

vhmsg someMessage

VHMsgManager

Subscribe to a certain type of message

vhmsg.SubscribeMessage("someMessage");

Subscribe to all vhmsgs

vhmsg.SubscribeMessage("*");

Send a vhmsg

vhmsg.SendVHMsg("someMessage someParam1");

Handle a message

vhmsg.AddMessageEventHandler(new VHMsgBase.MessageEventHandler(VHMsg_MessageEvent));

void VHMsg_MessageEvent(object sender, VHMsgBase.Message message)

{
     string [] splitargs = message.s.Split( " ".ToCharArray() );

     if (splitargs[0] == "someMessage")

          // Do Something

}

Build Process

You can customize the build process by creating and modifying a BuildSettings.xml file.

1. Inside the assets folder in your unity project, create a file called BuildSettings.xml

2. In the same folder as the Assets folder within your Unity project create a .bat file with the following lines

   Infocode
   @setlocal set PROJECTPATH=%CD% pushd ..\Unity call runEditorBatch.bat -projectPath %PROJECTPATH% -batchmode -nographics -quit -executeMethod UnityStartup.PerformWindowsBuild popd @endlocal

3. Use the following template for custom modification

   info

   Code Block
   language html/xml
   <?xml version="1.0" encoding="utf-8"?> <BuildSettings xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://www.cpandl.com">   <ExternalAssetsPaths>     <ExternalAssetsPaths> <string>Assets/SomeDirectory</string>     <string>Assets <string>Assets/SomeOtherDirectory</string>   </ExternalAssetsPaths>   <BuildOutputPath>Builds/YourProject/YourProject.exe</BuildOutputPath>   <PostBuildScript>somePostBuildScript.bat</PostBuildScript>   <ConfigFiles>     <ConfigFiles> <string>Assets/config.ini</string>   </ConfigFiles> </BuildSettings>

BuildSettings.xml Format

Config File Parsing

You can create a config .ini file in your project and read it using the IniParser class

m_ConfigFile = new IniParser(configFileName);

m_ConfigFile.GetSetting("SomeSetting") // returns a string with the value of that setting, if it exists

Known Issues

FAQ

FAQ