A Flash Player emulator written in Rust
Go to file
Mike Welsh 93b5b4801d chore: CI test build 2020-05-24 21:15:04 -07:00
.circleci chore: CI test build 2020-05-24 21:15:04 -07:00
.dependabot chore: Check all web deps with dependabot 2020-05-19 11:42:53 +02:00
.github/workflows web: web doesn't need install before bootstrap now 2020-05-19 11:42:57 +02:00
assets docs: Update README 2020-02-19 23:19:59 -08:00
core core: Children run an initial frame when changing button states 2020-05-24 08:57:30 -07:00
desktop build(deps): bump generational-arena from 0.2.7 to 0.2.8 2020-05-18 23:54:45 -07:00
exporter exporter: Add support to skip ahead n-frames for screen capture (#614) 2020-05-22 08:58:51 -07:00
render canvas: Implement gradient spread modes 2020-05-22 11:03:16 -07:00
scanner build(deps): bump structopt from 0.3.13 to 0.3.14 2020-04-22 19:25:07 +00:00
swf core: Keep track of cursor position in drawings 2020-05-21 18:38:10 +02:00
web web: Split frame/iframe polyfill tests into provided vs injected, as we see issues with one or the other 2020-05-24 08:57:16 -07:00
.gitattributes chore: Add gitattributes to normalize line endings 2019-10-11 16:53:36 -07:00
.gitignore chore: Add .swd files to .gitignore (SWF debug symbols) 2019-12-19 17:33:27 -08:00
CONTRIBUTING.md chore: Renormalize line endings in misc files 2019-10-11 16:53:36 -07:00
Cargo.lock core: First pass of drawing API (merge #611) 2020-05-22 08:54:55 -07: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 web: Build core on preparation of the core package 2020-05-19 11:42:57 +02:00
rustfmt.toml chore: Add rustfmt.toml and rustfmt pass 2019-08-26 16:38:48 -07:00

README.md

Ruffle

Travis 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.

Building from source

Follow the official guide to install Rust for your platform.

Desktop

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

Web

Running the web demo

  • cd web/demo
  • npm run bootstrap
  • npm run demo
  • Load indicated page in browser (usually http://localhost:8080)

Hosting on your own site

Browser extension

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 (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

License

Licensed under either of

Contribution

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.