| Table of Contents | ||
|---|---|---|
|
...
vhAssets is a collection of redistributable Unity package files:
- vhAssetsTestScenePackage - sample scene that shows how to setup a SmartBody driven character in Unity. Requires one of the platform packages below.
- vhAssetsPackage - Windows platform specific package
- vhAssetsPackageOSX - Mac OS X platform specific package
- vhAssetsPackageIOS - Apple iOS platform specific package
- vhAssetsPackageAndroid - Android platform specific package
The Toolkit uses Unity as it's primary rendering engine. It can run in Unity Free or Unity Pro. For Unity Free, we interface with SmartBody using 'bonebus mode'. For Unity Pro, we access SmartBody directly using a .dll.
Functionality that the vhAssetsPackage provides:
- SmartBody interface
- VHMsg interface
- VHCL Audio interface
- Asset Post-Processors that ease pipeline integration
- Resolution independent UI classes
- Interactive Debug Panel
- Customizable Free Mouse Look
- .ini file configuration
- Loading Screen
- Performance time demo tests
- File Parsing
- Application setup point
- Customizable build process
- FPS and Memory Debug Info
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
Location
vhAssets is distributed via the Unity packages. They are built regularly by our build server, so they 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)
\\roscoemini\fast\build\sbm-Builds
...
First Time Installation
- Bring the .unityPackage file inside of your Unity project Assets folder
- Double click it
- Click Import
- 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.
...
| Variable Name | Purpose | Value Range |
|---|---|---|
| Use Specified Host and Port | If checked, the Host and Port specified will be used on connection, otherwise localhost and 61611 will be used | True/False |
| Host | Host to connect to | string |
| Port | Port to connect to | positive int |
Developers
...
Here are some examples for common functionality that is modified on a per project basis
...