Clone this wiki locally
Shumway is an HTML5 technology experiment that explores building a faithful and efficient renderer for the SWF file format without native code assistance. 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.
Online demos and links to an installable Firefox extension can be found at http://mozilla.github.com/shumway/
The Shumway Community
Shumway is an open source community project created by Mozilla Research. Most development discussion happens on IRC:
Server: irc.mozilla.org Channel: #shumway
See also Frequently Asked Questions.
Getting the source
The source code for Shumway and its submodules can be cloned the following way:
cd ~ git clone --recursive https://github.com/mozilla/shumway.git Shumway
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 add git;
- for Ubuntu 64bit you may need
install libc6-dev-i386 g++-multilib;
- 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, testing, and building the extension, and can be installed by running:
Overview of the Build System
See Running tests for more information.
The shumway project is currently in active development and many SWF features are not yet implemented. Tracking all the missing features is not a goal at this time, and so we discourage filing every issue using the github issue tracker. We encourage interested developers to submit bug fixes and new features using github pull requests. If you need help figuring out how to start, please ask on IRC or the mailing list.