ruffle

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. ## Table of Contents * [Project status](#project-status) * [Using Ruffle](#using-ruffle) * [Building from source](#building-from-source) * [Prerequisites](#prerequisites) * [Linux prerequisites](#linux-prerequisites) * [Desktop](#desktop) * [Build](#build) * [macOS](#macos) * [Web or Extension](#web-or-extension) * [Android](#android) * [Scanner](#scanner) * [Exporter](#exporter) * [Structure](#structure) * [Sponsors](#sponsors) * [License](#license) * [Contributing](#contributing) ## Project status Ruffle supports ActionScript 1, 2 and 3 pretty well, but it's still not finished by any means. Please report any issues in the [Issue Tracker](https://github.com/ruffle-rs/ruffle/issues). ## Using Ruffle The easiest way to try out Ruffle is to visit the [web demo page](https://ruffle.rs/demo/), then click the "Select File" button to load a SWF file of your choice. [Nightly builds](https://ruffle.rs/downloads#nightly-releases) of Ruffle are available for desktop and web platforms. For more detailed instructions, see our [wiki page](https://github.com/ruffle-rs/ruffle/wiki/Using-Ruffle). ## Building from source ### Prerequisites * Latest stable channel of [Rust](https://www.rust-lang.org/tools/install) * Java, available on your PATH as `java` (required for building the library containing the builtin Flash classes for ActionScript 3) ### Linux prerequisites The following are typical dependencies for Linux: * Ubuntu/Debian: ```shell sudo apt install pkg-config libasound2-dev libudev-dev libfontconfig-dev libfreetype6-dev libssl-dev default-jre-headless g++ ``` * Fedora/RHEL: ```shell sudo dnf install pkgconf-pkg-config alsa-lib-devel systemd-devel fontconfig-devel freetype-devel openssl-devel java-latest-openjdk-headless gcc-c++ ``` ### Desktop #### Build Use the following command to build and run the desktop app: `cargo run --release --package=ruffle_desktop` To run a specific SWF file, pass the SWF path as an argument: `cargo run --release --package=ruffle_desktop -- test.swf` To build in debug mode, simply omit `--release` from the command. Desktop has a few optional features which you can specify via `--features`, comma separated: * `tracy`: Enables profiling to [Tracy](https://github.com/wolfpld/tracy). You may need to expand the log filter to see everything, e.g. `RUST_LOG="warn,ruffle=debug"` * `tracy_images`: Enables Tracy frame captures. Implies `tracy`. * `tracy_avm`: Enables profiling AVM execution with Tracy. Implies `tracy`. * `render_debug_labels`: Enables debug labels during rendering, useful for debugging graphics with [renderdoc](https://renderdoc.org/) or similar. #### macOS Ruffle desktop can be built from our [Homebrew Tap](https://github.com/ruffle-rs/homebrew-ruffle/): `brew install --HEAD ruffle-rs/ruffle/ruffle` _Note: because it is HEAD-only, you'll need to run `brew upgrade --fetch-HEAD ruffle` each time you want to update._ ### Web or Extension Follow [the instructions in the web directory](web/README.md#building-from-source) for building either the web or browser extension version of Ruffle. This project is tested with BrowserStack. ### Android Follow the [instructions](https://github.com/ruffle-rs/ruffle-android/blob/main/CONTRIBUTING.md#building-from-source) in the `ruffle-android` project for building the Android application 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 --release --package=ruffle_scanner -- scan folder/with/swfs/ results.csv` ### Exporter If you have a SWF file 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 --release --package=exporter -- path/to/file.swf` - `cargo run --release --package=exporter -- path/to/file.swf path/to/screenshots --frames 5` ## Structure - `core` - core emulator and common code - `swf` - SWF and ActionScript parser - `desktop` - desktop client (uses `wgpu-rs`) - `web` - web client and browser extension (uses `wasm-bindgen`) - `render` - various rendering backends for both desktop and web - `video` - video decoding backends - `flv` - Flash Video decoder - `wstr` - a Flash-compatible implementation of strings - `scanner` - a utility to bulk parse SWF files - `exporter` - a utility to generate PNG screenshots of a SWF file ## Sponsors You can support the development of Ruffle via [GitHub Sponsors](https://github.com/sponsors/ruffle-rs). 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:

## License Ruffle is licensed under either of - Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0) - MIT License (http://opensource.org/licenses/MIT) at your option. Ruffle depends on third-party libraries under compatible licenses. See [LICENSE.md](LICENSE.md) for full information. ### Contributing Ruffle welcomes contribution from everyone. See [CONTRIBUTING.md](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](https://www.rust-lang.org/policies/code-of-conduct) that the Rust project itself follows.