|Development Tools||The tools being used in the development of ÁSprite.|
|Build Flash||To build generated graphics follow the instructions in the doc pages and readme files in doc/samples.|
|Build Adobe AIR||The steps required to build an Adobe AIR package for ÁSprite.|
|Documentation||The autotelicum souce code documentation is generated with NaturalDocs.|
The tools being used in the development of ÁSprite.
|Adobe Flex SDK||Required to compile ActionScript with the Flash API|
|Flex Compiler Shell||Speeds up the Java-based Flex compiler|
|Darcs||A distributed patch-oriented revision control system|
|Natural Docs||Documentation generator from readable comments|
|Komodo Edit||Multi-platform multi-language text editor with macros|
|Python||Handy and portable script language for utilities and macros|
|asUnit||Unit testing with test template generator|
To build generated graphics follow the instructions in the doc pages and readme files in doc/samples.
The steps required to build ÁSprite manually.
|1||Download and install the Adobe Flex SDK 3|
|2||Download and unpack the latest ÁSprite tarball|
|3||Open a console or commandline window|
|4||Change directory to mSprite|
|5||Type: mxmlc mSprite.as|
|6||Change directory to muSprite|
|7||Type: mxmlc muSprite.as|
If you have Python 2.4+ with distutils installed then you can use the build.py script in the ÁSprite tarball.
The produced swf files are placed in the doc/assets directory. Start ÁSprite with mSprite or muSprite. If you start mSprite then you get theme color selection. If you start muSprite then you get a random theme color.
If your OS does not support unpacking of tarballs automatically, then you can use a free utility such as ZipGenius on Windows.
The process should be the same on Mac OS X, Linux and Windows, read the Flex Build and Deploy manual if you experience difficulties.
Use the Flex compiler shell fcsh from Adobe for a 10-20x speedup if you compile repeatedly.
The steps required to build an Adobe AIR package for ÁSprite.
From the directory where you unpacked the execute
mxmlc +configname=air -optimize airSprite/airSprite.as adt -package downloads/muSprite.air airSprite/airSprite-app.xml airSprite/airSprite.swf icons/smallIcon.png icons/mediumIcon.png icons/largeIcon.png icons/hugeIcon.png
The package is placed in downloads, the Flash content file is in airSprite. You can test the AIR version without building a package or installing it; change to the airSprite directory and launch like this
adl airSprite-app.xml .. -- ../doc/samples/[SampleName].as
The autotelicum souce code documentation is generated with NaturalDocs.
There are two reasons that NaturalDocs is used instead of Adobe asDoc
To generate documentation download and install Natural Docs 1.4 from http://www.naturaldocs.org
From the autotelicum source project directory execute
perl [NaturalDocs-install-path]/NaturalDocs -i readme -i libraries -i airSprite -i muSprite -i mSprite -img ReferenceManualSetup -o HTML doc/ReferenceManual -p ReferenceManualSetup -s Default DocStyle -do
You can document in javaDoc/asDoc style if you prefer and still generate searchable documentation with NaturalDocs.
The autotelicum documentation is in a style that is compatible with FlashDevelop tooltips. FlashDevelop is a text editor that is unfortunately not capable of running on either Mac OS X or Linux but it implements tooltips and code-completion nicely for as2 and as3.
To enable tooltips in FlashDevelop, add libraries to the Tools/Global Classpaths dialog with the path where you installed the autotelicum package (i.e. D:\[ÁSprite-install-path]\libraries). This step is required because FlashDevelop does not recognize source-path instructions in normal [application name]-config.xml files.