Avatar Core is a framework made up of a collection of source code in the form of ActionScript 3.0 classes. To use these classes they must be saved, with their directory structure intact, to a location on your hard drive. Your ActionScript compiler (Flex SDK, Flash Professional, etc.) would then need to be directed to find these classes by adding their save location to the compiler's class or source path (see below).

Avatar Core, at this time, is not available as a SWC.

Download

To download the Avatar Core, classes you have two options:

• Sync with the svn repository
• Download the sample application with the framework included

Via SVN

To obtain the framework through SVN, you will need an SVN client (program). Once you have an SVN client up and running, follow the instructions found on the Source section (additional information about obtaining a SVN client can be found there).

Via Sample Download

In the Downloads section, you will find a zip file containing a simple sample application that includes the full framework source. This file gives you a direct means by which you can download the entire framework at once. However, this file is not guaranteed to be as up to date as the SVN repository.

Requirements

The only requirement for the Avatar Core framework is the ability to compile ActionScript 3.0 and run Adobe Flash Player SWFs in your destination environment using Flash Player 9 or greater.

Setting up Flash CS4

After you create a new ActionScript 3.0 FLA for a project that is to use Avatar Core, take the following steps to reference the framework:

1. Select File > Publish Settings...
2. Click on the Flash tab
3. Click on the Settings... button next to Script: ActionScript 3.0
4. Under Source path click on the folder icon and browse for the directory where the Avatar Core framework was saved (the directory containing the "com" folder) or optionally click on the + icon and type the path in the resulting field
5. Click OK
6. Click OK

Setting up Flash Builder

After creating a new project in Flash Builder (previously known as Flex Builder) that is to use Avatar Core, take the following steps to reference the framework:

1. Select Project > Properties...
2. Select Flex Build Path from the selection on the left
3. Under Source path click on the Add Folder... button
4. Browse for the directory where the Avatar Core framework was saved (the directory containing the "com" folder) or optionally type the path in the Add Folder text field field
5. Click OK
6. Click OK

MXMLC or Other Compilers

For other compilers, you need to make sure the directory where the Avatar Core framework was saved (the directory containing the "com" folder) is specified in the compilers classpath or source path. For MXMLC (Windows), for example:

mxmlc Example.as -compiler.source-path "C:\libraries\avatarcore\"

This can also be set through the related .project file for MXMLC.