ruffle/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. ActionScript support is still forthcoming; for more info, read the project roadmap.

Building from source

Follow the official guide to install Rust for your platform.

Desktop

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

Web

• Install Node.js
• Install wasm-pack

Running the web demo

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

Building the NPM package

• cd web
• wasm-pack build

Structure

• core contains the core emulator and common code
• desktop contains the desktop client (uses glium)
• web contains the web client (uses wasm-bindgen)

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.