A Flash Player emulator written in Rust

Go to file

Mike Welsh 51d66c53f0 core: Edit text sets variables on instantiation		2020-06-28 18:36:10 -07:00
.circleci	ci: Install libxcb packages on CircleCI	2020-06-13 20:06:52 -07:00
.dependabot	chore: Check all web deps with dependabot	2020-05-19 11:42:53 +02:00
.github/workflows	chore: Remove hardcoded command in github ci	2020-06-13 12:35:14 -07:00
assets	docs: Update README	2020-02-19 23:19:59 -08:00
core	core: Edit text sets variables on instantiation	2020-06-28 18:36:10 -07:00
desktop	core: Add shared object cache and saving on exit	2020-06-24 01:46:42 +01:00
exporter	chore: Format	2020-06-24 01:46:06 +01:00
render	build(deps): bump png from 0.16.5 to 0.16.6	2020-06-27 16:08:11 -07:00
scanner	build(deps): bump path-slash from 0.1.1 to 0.1.2	2020-06-16 11:56:54 -07:00
swf	chore: Fix swf clippy lint	2020-05-30 02:53:25 -07:00
web	web: Fix WebAudioBackend::stop_sounds_with_handle (fix #752 )	2020-06-25 23:04:47 -07:00
.gitattributes	chore: Mark .as files as ActionScript on github	2020-06-26 11:43:28 -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	build(deps): bump weak-table from 0.2.3 to 0.3.0	2020-06-27 16:08:52 -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	chore: Document web with readmes	2020-05-27 00:11:02 -07:00
rustfmt.toml	chore: Add rustfmt.toml and rustfmt pass	2019-08-26 16:38:48 -07:00

README.md

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

License

Licensed under either of

Apache License, Version 2.0 (LICENSE_APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE_MIT or http://opensource.org/licenses/MIT) at your option.

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.