Skip to content
Apache Royale ASJS
ActionScript CSS AngelScript JavaScript Java Shell Other
Branch: develop
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.mvn try to fix build Oct 10, 2017
InstallAdobeSDKs.properties Ant script to install Flash and AIR Sep 27, 2017
archetypes Revert "[maven-release-plugin] prepare for next development iteration" Jun 10, 2019
asdoc more removal of falcon and flex references Nov 2, 2017
bin get scripts at batch files from compiler Sep 15, 2017
distribution add crux to templates and release xml configurations since that was m… Jul 23, 2019
examples jewel-button: rename BasicButton to SimpleButton Aug 23, 2019
frameworks jewel-button: rename BasicButton to SimpleButton Aug 23, 2019
fxg2svg Changed flex-asjs references Oct 13, 2017
ide Reverting accidental change to launch file. Apr 7, 2019
js/bin first cut at npm Dec 12, 2017
manualtests Fix runtime error in XML namespaceDeclarations method. Added new XML … Aug 22, 2019
marmotinni changes to move to Selenium3. Requires geckodriver in path or specifi… Aug 19, 2019
mustella disable failing test while investigating Aug 20, 2019
npm manually apply 31b94b6 to develop branch Aug 19, 2019
releasemgr update NOTICE because royale-compiler NOTICE changed Apr 5, 2019
scripts first pass at replace FlexJS with Royale per Issue #17 Oct 5, 2017
src/site first pass at replace FlexJS with Royale per Issue #17 Oct 5, 2017
templates another sweep of flex replaced by royale per Issue #17. This is hard … Oct 5, 2017
testsuite [maven-release-plugin] prepare for next development iteration Nov 27, 2018
.gitignore removed ace-config.xml from repository because it is automatically ge… May 22, 2019
ApproveRoyale.xml add crux to templates and release xml configurations since that was m… Jul 23, 2019
GIT-TEST.txt Test commit to check access to the repository Oct 12, 2018
InstallAdobeSDKs.xml Adding the name that's currently the default for windows Dec 12, 2017
LICENSE Changes for derivative work: - all corresponding .as files have origi… Jul 4, 2019
LICENSE.base fix issues with release packaging, installation and approval Mar 30, 2016
LICENSE.bin more tuning of release artifacts Dec 11, 2017
NOTICE Wrong file for giving credit Jun 14, 2019
README.md The badge should point to lastSuccessfulBuild Feb 21, 2018
RELEASE_NOTES.md update notice files Nov 13, 2018
build.properties add some properties for Jenkins release building Mar 4, 2019
build.xml try to use correct geckodriver Aug 20, 2019
cordova-build.xml another sweep of flex replaced by royale per Issue #17. This is hard … Oct 5, 2017
env-template.properties Use ROYALE_COMPILER_HOME for the cross-compiler because it can launch… Nov 3, 2017
package.json change other versions to 0.9.6 Nov 27, 2018
pom.xml try this pattern for rat Jun 12, 2019
releasecandidate.xml http -> https May 21, 2019
releasesteps.xml add crux to templates and release xml configurations since that was m… Jul 23, 2019
settings-template.xml http -> https May 21, 2019

README.md

Apache Royale™

Build Status

The Apache Royale project is developing a next-generation of the Apache Flex™ SDK: . Royale has the goal of allowing applications developed in MXML and ActionScript to not only run in the Flash/AIR runtimes, but also to run natively in the browser without Flash, on mobile devices as a PhoneGap/Cordova application, and in embedded JS environments such as Chromium Embedded Framework. Royale has the potential to allow your MXML and ActionScript code to run in even more places than Flash currently does.

For detailed information about using Royale, visit:

https://apache.github.io/royale-docs/

For more information about the Apache Royale project, visit:

http://royale.apache.org

Getting Royale

Getting the source code from GitHub is the recommended way to get Royale. You can check out the source via git using the following commands:

git clone https://github.com/apache/royale-asjs.git royale-asjs
cd royale-asjs
git checkout develop

You may also use a precompiled binary convenience package to develop Royale applications using your favorite IDE. In addition to that, Royale is available as Maven artifacts and through Node Package Manager (NPM).

Building Royale

Prerequisites

Before building Royale you must install the following software and set the corresponding environment variables using absolute file paths (relative paths will result in build errors). The set of prerequisites is different depending on whether you want to compile your projects to SWF or not. If you want SWF output, set up the environment variables per the instructions below, then skip to the next section (Additional Prerequisites For SWF Output)

Java

Royale requires Java SDK 1.7 or greater to be installed on your computer. For more information on installing the Java SDK, see:

http://www.oracle.com/technetwork/java/javase/downloads/index.html

  • Environment variable

    Set the JAVA_HOME environment variable to the Java SDK installation path.

  • PATH

    Add the bin directory of JAVA_HOME to the PATH.

    On Windows, set PATH to

    PATH=%PATH%;%JAVA_HOME%\bin

    On a Mac, set PATH to

    export PATH="$PATH:$JAVA_HOME/bin"

Ant

Royale requires Ant 1.7.1 or greater to be installed on your computer.

Note: if you are using Java SDK 1.7 or greater on a Mac you must use Ant 1.8 or greater. If you use Java 1.7 with Ant 1.7 you will get compile errors.

For more information on installing Ant, see:

http://ant.apache.org/

  • Environment variable

    Set the ANT_HOME environment variable to the Ant installation path.

  • PATH

    Add the bin directory of ANT_HOME to the PATH.

    On Windows, set PATH to

    PATH=%PATH%;%ANT_HOME%\bin

    On a Mac, set PATH to

    export PATH="$PATH:$ANT_HOME/bin"

Additional Prerequisites For SWF Output

playerglobal.swc

The Adobe Flash Player playerglobal.swc (version 11.1) can be downloaded from:

http://download.macromedia.com/get/flashplayer/updaters/11/playerglobal11_1.swc

First, create the following directory structure:

[root directory]/player/11.1/

Next, rename the downloaded SWC to 'playerglobal.swc' and place it in the above directory.

  • Environment variable

    Set PLAYERGLOBAL_HOME environment variable to the absolute path of the player directory, not including the version subdirectory (i.e. '[root directory]/player').

Other, more recent versions of Adobe Flash Player playerglobal.swc can be downloaded from http://download.macromedia.com/get/flashplayer/updaters/[version.major]/playerglobal[version.major]_[version.minor].swc (e.g. http://download.macromedia.com/get/flashplayer/updaters/11/playerglobal11_1.swc). These versions can be used with Royale, but not all have been fully tested.

Flash Player Content Debugger

The Flash Player Content Debugger can be found here:

http://www.adobe.com/support/flashplayer/downloads.html

This version of Royale was certified for use with Flash Player 11.1, and is compatible with version 10.2 and up. It has been tested with version 16.0 on Windows and Mac. It has been compiled, but not fully tested, with other Flash Player versions. It has not been fully tested on Linux.

  • Environment variable

    On Windows, set FLASHPLAYER_DEBUGGER to the absolute path including the filename of the Flash Player Projector Content Debugger executable (e.g. 'FlashPlayerDebugger.exe'). Note: the filename of Flash Player Content Debugger can differ slightly between versions. Adjust your path accordingly.

    On the Mac, set FLASHPLAYER_DEBUGGER to the absolute path of 'Flash Player.app/Contents/MacOS/Flash Player Debugger'

    On Linux, set FLASHPLAYER_DEBUGGER to the absolute path of 'flashplayerdebugger'.

Adobe AIR Integration Kit (optional, for SWF output only)

This version of Apache Royale was certified for use with Adobe AIR 16 and is compatible with version 3.1 and up. The Adobe AIR integration kit can be downloaded from:

Windows: http://airdownload.adobe.com/air/win/download/16.0/AdobeAIRSDK.zip

Mac: http://airdownload.adobe.com/air/mac/download/16.0/AdobeAIRSDK.tbz2

Linux: http://airdownload.adobe.com/air/lin/download/2.6/AdobeAIRSDK.tbz2

After you download the AIR SDK, unzip it and place it in a directory of your choice.

  • Environment variable

    Set AIR_HOME to the absolute path of the AIR SDK directory.

Building the source

Linux support is currently experimental and while it is possible to compile the SDK it has not been fully tested.

Royale requires code from several other Apache Royale git repositories. To get these repositories, change to the repository root ('royale-asjs') and run:

ant all

This will clone the repositories, checkout the develop branches then build those repositories in the correct order.

Some more helpful commands:

  • To rebuild, run:

    ant
  • To clean the build, of everything other than the downloaded third-party dependencies, run:

    ant clean
  • To generate a source distribution package and a binary distribution package, run:

    ant -Dbuild.number=<YYYYMMDD> -Dbuild.noprompt= release

    The packages can be found in the "out" subdirectory.

  • To get a brief listing of all the targets, run:

    ant -projecthelp

Using the Binary Distribution

If you are not interested in SWF output, the binary distribution can just be unzipped into a folder.

If you want SWF output, use NPM. Run:

  • Mac
sudo npm install @apache-royale/royale-js -g

or for both JS and SWF output:

sudo npm install @apache-royale/royale-js-swf -g

- Windows
```bash
npm install @apache-royale/royale-js -g

or for both JS and SWF output:

npm install @apache-royale/royale-js-swf -g

Using Royale

In order to get started using Royale, you are invited to follow along with the Quick Start Guide.

Thanks for using Apache Royale. Enjoy!

You can’t perform that action at this time.