ruffle is a Flash Player emulator built in the Rust programming language.

What is ruffle

Ruffle is a Flash Player emulator written in Rust. Ruffle runs natively on all modern operating systems as a standalone application, and on all modern browsers through the use of WebAssembly. Leveraging the safety of the modern browser sandbox and the memory safety guarantees of Rust, we can confidently avoid all the security pitfalls that Flash had a reputation for. Ruffle puts Flash back on the web, where it belongs - including iOS and Android!

Designed to be easy to use and install, users or website owners may install the web version of Ruffle and existing flash content will "just work", with no extra configuration required. Ruffle will detect all existing Flash content on a website and automatically "polyfill" it into a Ruffle player, allowing seamless and transparent upgrading of websites that still rely on Flash content.

Ruffle is an entirely open source project maintained by volunteers. We're all passionate about the preservation of internet history, and we were drawn to working on this project to help preserve the many websites and plethora of content that will no longer be accessible when users can no longer run the official Flash Player. If you would like to help support this project, we welcome all contributions of any kind - even if it's just playing some old games and seeing how well they run.

Usage

Installing on a website you own

Download the 'standalone' version of Ruffle from our releases, and include the following JavaScript on any page with Flash content:

<script src="path/to/ruffle/ruffle.js"></script>

You'll need to make sure your web server is configured to serve .wasm files correctly, so please visit our wiki if you need help with that.

For advanced usage, consult our documentation for our JavaScript API and installation options.

Installing the browser extension

If you visit websites that have Flash content but aren't using Ruffle, or you want to ensure you're using the latest and greatest version of Ruffle on every website, then our browser extension is the perfect thing for you!

Until our first release, we currently only ship unsigned browser extensions. To use these, first download the appropriate one for your browser from our releases, and then install it manually.

Chrome

  • Click the "Chrome / Edge / Safari" link.
  • Extract the downloaded zip file somewhere.
  • Navigate to chrome://extensions/
  • Turn on Developer mode in the top right corner.
  • Click Load unpacked.
  • Select the folder you extracted the extension to.

Firefox

  • Right-click the Firefox .xpi download link.
  • Click "Save Link As..."
  • Navigate to about:debugging.
  • Click on This Firefox.
  • Click Load Temporary Add-on...
  • Select the .xpi that you downloaded.

Using the desktop application

If you want to run Flash content on your computer without a browser in-between, we have native applications that will take full advantage of your GPU and system resources to get those extra frames when playing the original Meat Boy.

Currently most options are accessed via the command line, but we intend to develop a GUI soon for ease of use. First, download the appropriate executable for your operating system from our releases.

To use Ruffle, simply double-click the executable and select the SWF file you wish to play. Alternatively, type a command such as ruffle filename.swf or ruffle https://example.com/filename.swf. We also provide more advanced options if you wish to control how this file is played. To view the full options available, run ruffle --help.

Releases

Ruffle is still in active development and we release nightly development builds every day, as long as some code changed. Whilst we try to keep nightly builds in working order, no guarantees can be made.

Version Date Desktop Browser Extension Website
Nightly 2021-01-23 preview 2021-01-23
Nightly 2021-01-22 preview 2021-01-22
Nightly 2021-01-21 preview 2021-01-21

Compatibility

ActionScript

ActionScript is the language which Flash uses to make interactive content. It is primarily split into two groups: "AVM 1" (ActionScript 1 & 2) and "AVM 2" (ActionScript 3).

AVM 1

AVM 1 is ActionScript 1 and ActionScript 2. All movies made before Flash Player 9 (June 2006) will be made with AVM 1, and it remained supported & available to authors until the release of Flash Professional CC (2013).

For in-depth details, please follow our AVM 1 tracking issue on GitHub.

ActionScript 1 & 2 Language 70%

ActionScript 1 & 2 API 35%

AVM 2

AVM2 is ActionScript 3, which was introduced with Flash Player 9 (June 2006). After the release of Flash Professional CC (2013), authors are required to use ActionScript 3 - making any movie made after that date very likely to fall under this category.

Ruffle is still working on the foundational support for AVM 2, and does not yet support any content that requires it. A warning will be placed in the log when you attempt to play AVM 2 content, for this reason. We do plan on supporting this soon!

For in-depth details, please follow our AVM 2 tracking issue on GitHub.

ActionScript 3 Language 5%

ActionScript 3 API 1%

Get involved

â™Ĩī¸ How to help the project

We are an entirely open source project and do this for the sake of preserving history, and we are not a large team at that. We absolutely welcome and request your help if you are willing to provide it. There are 4 main ways to help this project, and we will be extremely grateful for any help provided.

đŸ–Ĩī¸ Contributing code

There are two main codebases in two languages: The actual player in Rust, and the web interface & browser UI in JavaScript. If you have any experience in either area and would like to assist, please feel free to read our contribution guidelines, search for some issues to tackle, and join our Discord to ask questions!

🕹ī¸ Testing content

Arguably more important than contributing code is testing Ruffle out. Go install Ruffle and try out your favourite games and animations. Look for any difference from the official Flash Player, and report your findings to us. If you find any bugs, changes of behaviour, performance issues or any visual differences then please report those to our bug tracker. If it runs flawlessly, come share the good news on our Discord!

💲 Sponsor the project

If you are able and willing to, we welcome any financial support to help us fund the project going forward. With your help, we can afford to spend more time dedicated to Ruffle, and pay for expenses such as build servers and hosting. We accept donations and sponsorships through Open Source Collective 501(c)(6). For more information, or to view the options available for sponsoring the project, please visit our Open Collective page.

đŸ’Ŧ Spread the word!

Is your favourite Flash-based site shutting down? Let them know they can add one JavaScript file and keep it running! Feeling nostalgic for some old Flash games? Go play some on Newgrounds with Ruffle installed, and tell your friends about it! Maybe you're a streamer and looking for some silly content? There's literally decades' worth, now unlocked and accessible once more.

💎 Diamond Sponsors

We'd like to thank all of our sponsors, who help make this project possible. Below are our Diamond level sponsors, without whom we would not be here. Thank you.

Want to join them? Sponsor Ruffle today!