A Flash Player emulator written in Rust
Go to file
Mike Welsh 26e0432ccc wgpu: Fix some invalid WGSL
naga is currently lenient about some things which are invalid by
the WGSL spec. The Tint WGSL compiler disagreed, so these shaders
failed to compile in Chrome.
2021-10-25 21:59:09 -07:00
.cargo web: Enable web_sys_unstable_apis 2021-10-24 17:20:19 -07:00
.github ci: Enable WebGPU support in demo 2021-10-25 14:00:37 -07:00
core avm2: Make ObjectEncoding C-like 2021-10-25 16:32:55 -07:00
desktop desktop: Fix app not running on Windows (fix #5534) 2021-10-24 12:03:21 -07:00
exporter wgpu: Make WgpuRenderBackend::build_descriptors async 2021-10-24 17:20:19 -07:00
render wgpu: Fix some invalid WGSL 2021-10-25 21:59:09 -07:00
scanner chore: Appease clippy 2021-10-24 15:33:09 -07:00
swf chore: Stop using traits available in prelude 2021-10-21 10:24:05 -07:00
tests tests: Improve AMF3 test 2021-10-25 16:32:55 -07:00
web web: Add error-report label to bug report link 2021-10-24 17:21:03 -07:00
.gitattributes chore: Cleanup .gitattributes 2021-02-19 16:28:09 -08:00
.gitignore chore: Cleanup .gitignore 2021-02-19 16:28:09 -08:00
CODE_OF_CONDUCT.md chore: Update CODE_OF_CONDUCT.md 2021-02-27 16:58:32 -08:00
CONTRIBUTING.md docs: Document how to create and build ABC-only tests 2021-09-23 18:43:16 -06:00
Cargo.lock tests: Add test for reading AMF3 objects 2021-10-25 16:32:55 -07:00
Cargo.toml video/vp6: Add VP6[A] video decoding support 2021-10-04 22:33:06 -07:00
LICENSE.md video/vp6: Add VP6[A] video decoding support 2021-10-04 22:33:06 -07:00
PKGBUILD ci: Update PKGBUILD for AUR package 2021-04-25 11:47:58 -07:00
README.md chore: Add Doll Divine as sponsor 2021-10-01 14:56:00 -07: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.

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 wowgame.jp Matt Roszak Doll Divine

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.