A Flash Player emulator written in Rust https://ruffle.rs
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
dependabot-preview[bot] 98abaf4ca2 build(deps): bump image from 0.23.13 to 0.23.14 15 hours ago
.dependabot chore: Change dependabot schedule to weekly for JS 3 weeks ago
.github docs: Clarify license 3 weeks ago
core avm1: Implement getInstanceAtDepth 1 day ago
desktop build(deps): bump image from 0.23.13 to 0.23.14 11 hours ago
exporter build(deps): bump image from 0.23.13 to 0.23.14 11 hours ago
render build(deps): bump image from 0.23.13 to 0.23.14 11 hours ago
scanner build(deps): bump env_logger from 0.8.2 to 0.8.3 2 weeks ago
swf swf: Remove unused encoding from avm1::read::Reader 3 days ago
web build(deps-dev): bump @wdio/cli from 7.0.7 to 7.0.9 in /web 1 day ago
.gitattributes chore: Cleanup .gitattributes 1 week ago
.gitignore chore: Cleanup .gitignore 1 week ago
CODE_OF_CONDUCT.md chore: Update CODE_OF_CONDUCT.md 3 days ago
CONTRIBUTING.md docs: Add `tests` to list of commit prefixes 2 months ago
Cargo.lock build(deps): bump image from 0.23.13 to 0.23.14 11 hours ago
Cargo.toml exporter: Added exporter tool for capturing images of swfs (related to #523) 9 months ago
LICENSE.md web: Update license 2 weeks ago
PKGBUILD docs: Clarify license 3 weeks ago
README.md docs: Add sponsors 1 week ago
rustfmt.toml chore: Add rustfmt.toml and rustfmt pass 1 year ago

README.md

Ruffle

Rust Build Status Web Build Status Ruffle Discord
website | demo | nightly builds | wiki

Ruffle

Ruffle is an Adobe Flash Player emulator written in the Rust programming language. Ruffle targets both the desktop and the web using WebAssembly.

Project status

Ruffle is in the proof-of-concept stage and can currently run early Flash animations and games. Basic ActionScript 1.0/2.0 support is in place and improving; ActionScript 3.0 support is forthcoming. For more info, read the project roadmap.

Using Ruffle

The easiest way to try out Ruffle is to visit the web demo page, then click the "Browse..." button to load an SWF file of your choice.

Nightly builds of Ruffle are available for desktop and web platforms including the browser extension.

For more detailed instructions, see our wiki page.

Building from source

Follow the official guide to install Rust for your platform.

Desktop

  • cargo run --package=ruffle_desktop -- test.swf

Web or Extension

Follow the instructions in the web directory for building either the web or browser extension version of Ruffle.

Scanner

If you have a collection of "real world" SWFs to test against, the scanner may be used to benchmark ruffle's parsing capabilities. Provided with a folder and an output filename, it will attempt to read all of the flash files and report on the success of such a task.

  • cargo run --package=ruffle_scanner -- folder/with/swfs/ results.csv

Exporter

If you have a swf and would like to capture an image of it, you may use the exporter tool. This currently requires hardware acceleration, but can be run headless (with no window).

  • cargo run --package=exporter -- path/to/file.swf
  • cargo run --package=exporter -- path/to/file.swf path/to/screenshots --frames 5

Structure

  • core contains the core emulator and common code
  • desktop contains the desktop client (uses wgpu-rs)
  • web contains the web client and browser extension (uses wasm-bindgen)
  • scanner contains a utility to bulk parse swf files
  • exporter contains a utility to generate PNG screenshots of a swf file

Sponsors

You can support the development of Ruffle via GitHub Sponsors. Your sponsorship will help to ensure the accessibility of Flash content for the future. Thank you!

Sincere thanks to the diamond level sponsors of Ruffle:

Newgrounds.com CPMStar Sébastien Bénard Crazy Games Cool Math Games The New York Times Armor Games Onda Educa TwoPlayerGames.org

License

Ruffle is licensed under either of

at your option.

Ruffle depends on third-party libraries under compatible licenses. See LICENSE.md for full information.

Contribution

Ruffle welcomes contribution from everyone. See CONTRIBUTING.md for help getting started.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you shall be dual licensed as above, without any additional terms or conditions.

The entire Ruffle community, including the chat room and GitHub project, is expected to abide by the Code of Conduct that the Rust project itself follows.