A Flash Player emulator written in Rust
Go to file
dependabot-preview[bot] c87c0c2a99 build(deps-dev): bump @wdio/sync from 6.10.7 to 6.10.10 in /web
Bumps [@wdio/sync](https://github.com/webdriverio/webdriverio) from 6.10.7 to 6.10.10.
- [Release notes](https://github.com/webdriverio/webdriverio/releases)
- [Changelog](https://github.com/webdriverio/webdriverio/blob/master/CHANGELOG.md)
- [Commits](https://github.com/webdriverio/webdriverio/compare/v6.10.7...v6.10.10)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2020-12-13 15:25:59 -08:00
.dependabot chore: Check all web deps with dependabot 2020-05-19 11:42:53 +02:00
.github/workflows chore: Fix publish of js docs 2020-11-26 17:07:58 -08:00
core avm1: Move TextField properties to prototype 2020-12-09 14:45:20 -08:00
desktop build(deps): bump winit from 0.23.0 to 0.24.0 2020-12-10 13:24:55 -08:00
exporter chore: Update some dependencies 2020-12-11 11:28:33 -08:00
render chore: Update some dependencies 2020-12-11 11:28:33 -08:00
scanner build(deps): bump env_logger from 0.8.1 to 0.8.2 2020-11-18 16:26:21 -08:00
swf chore: Fix swf doctests working directory 2020-12-10 12:25:02 -08:00
web build(deps-dev): bump @wdio/sync from 6.10.7 to 6.10.10 in /web 2020-12-13 15:25:59 -08:00
.gitattributes chore: Mark .as files as ActionScript on github 2020-06-26 11:43:28 -07:00
.gitignore web: Add 'docs' command to generate jsdocs 2020-11-24 16:36:33 -08:00
CODE_OF_CONDUCT.md chore: Add CODE_OF_CONDUCT.md to satisfy GitHub's "you don't have a code of conduct" 2020-09-04 14:24:12 -07:00
CONTRIBUTING.md docs: Add double quotes to RUST_LOG to improve clarity 2020-12-09 12:11:02 -08:00
Cargo.lock chore: Update some dependencies 2020-12-11 11:28:33 -08:00
Cargo.toml exporter: Added exporter tool for capturing images of swfs (related to #523) 2020-05-11 01:09:07 -07:00
LICENSE_APACHE Initial commit 2019-04-25 10:52:22 -07:00
LICENSE_MIT Initial commit 2019-04-25 10:52:22 -07:00
README.md docs: Update sponsor links 2020-11-21 16:57:56 -08:00
rustfmt.toml chore: Add rustfmt.toml and rustfmt pass 2019-08-26 16:38:48 -07:00

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.

Nightly builds

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

Windows desktop builds require the x64 2015-2019 Visual C++ Redistributable.

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

License

Licensed under either of

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.