This document should help you gain access to the KitchenSync library and set it up for use in a Flash or Flex project. Once you have included the source files in your class path, check out the getting started page for help with coding.

Downloading KitchenSync Code

The code for KitchenSync is freely available for download through the Google Code site. There are two basic ways to get the code.

1. Visit the Downloads tab and download the latest stable build.
2. Use Subversion (SVN) to check out the code from the repository through the Source tab.

Note If you are comfortable using SVN, this is the recommended way to get the source code. The code in the /trunk folder is the latest build and may be unstable or have partially implemented features. However, all stable versions are available to download since they will be tagged in the /tags folder. If you're not sure what a tag is (or have no idea what I'm talking about), I recommend learning all about Subversion or just downloading the .zip file.

Source files vs. Compiled code library (SWC)

Whether you download a zip or checkout from the repository, the code will come in one of two forms: as a series of folders containing .as files (in the /src folder in the repository), or as a single compiled code library in a .swc file (in the /bin folder in the repository).

If you use Flash CS3 to code, you will need to use the source files since, unfortunately, Flash CS3 cannot use .swc files compiled by the Flex SDK. Also, I would strongly suggest that you consider switching to FlexBuilder or another platform to do your development work.

If you use any other platform you can choose between the two. The pre-compiled .swc file will save you time when compiling and still give you the benefits of code-hinting in tools like FlexBuilder but is un-editable and does not allow you to view its contents. The raw source code can be viewed and edited but must be recompiled each time your program changes and, if edited, can become out of sync with the repository.

Installing KitchenSync to your project

In order to 'install' the library, you'll need to follow one of the following paths.

Flash CS3 users

First, seriously consider using FlexBuilder. The code completion features make working with KitchenSync much simpler.

You'll need to add the source folder (the folder containing KitchenSync's /org folder) to your .fla file's classpath. For information on how to do this, consult the boring Flash documentation.

Remember to import the right packages (import org.as3lib.kitchensync.*;) or the code won't be recognized by the compiler!

FlexBuilder users

You'll need to add the .swc or the source folder to your project in the Build Path panel of the properties window. For .swc's, click the Library Path tab and then click the 'Add SWC...' or 'Add SWC Folder' to locate the .swc file. For source, click the 'Add Folder...' button on the Source Path tab and navigate to the folder containing the /com and /org folders for KitchenSync.

For more help with this, check out the Adobe LiveDocs.

Note: If your project is a Flex project (rather than ActionScript 3.0 project), check out the wiki page on Using KitchenSync for a Flex Project.

Flex SDK users

You probably don't need my help.

Related Links

• Getting started
• Using KitchenSync for a Flex Project
• Setting up a new project with Flash CS3 or FlexBuilder
• Version Control with Subversion free eBook