Home

Shumway

Overview

Shumway is an HTML5 technology experiment that explores building a faithful and efficient renderer for the SWF file format without native code assistance.

Shumway is community-driven and supported by Mozilla. Our goal is to create a general-purpose, web standards-based platform for parsing and rendering SWFs. Integration with Firefox is a possibility if the experiment proves successful.

Getting the source

The source code for Shumway and its submodules can be cloned the following way:

cd ~
git clone https://github.com/mozilla/shumway.git Shumway
cd Shumway
git submodule init
git submodule update

Development Environment

If you are planning to contribute or try the examples, please install:

• The typical development/build environment for Firefox (see https://developer.mozilla.org/en-US/docs/Simple_Firefox_build; for Windows, the mozilla-build can be modified to avoid installation of the Visual Studio and SDKs);
• node.js version 0.8+ (http://nodejs.org/download/);
• Java version 1.6+;
• and, of course, git.

The additional utils (such as Tamarin AVM Shell, SpiderMonkey JS shell, etc.) are required for AVM2 engine execution and testing and can be installed by running:

make install-utils

Demos

For impatient, see Running the examples. Please notice that you have to finish setting up the environment before you run the examples.

Firefox Extension

Firefox 18+ supports API for JavaScript extensions to create native plugins previews for specific mime type (Bug 776208). To create the extension, see Building Firefox Extension.

Modules

AVM1: Action Script 1 & 2 VM (AVM1)

TBD

AVM2: Action Script 3 VM (AVM2)

Getting Started with AVM2

Flash Core: SWF file parser & renderer

TBD