A Flash Player emulator written in Rust
Go to file
Kamil Jarosz c260a45603 core: Close sockets and timers when replacing the root movie
Turns out that the comment from `set_root_movie` was right all along!
`set_root_movie` should not be used when replacing the root movie,
because it will leave out unclosed resources.
This patch introduces `replace_root_movie`, which is dedicated to be
used when replacing (instead of just setting) the root movie.

The best solution would be to use RAII, e.g. destroy and recreate
the whole Player instance, but this patch is a first step towards
proper resource control.
2024-03-05 23:14:08 +01:00
.cargo web: No longer set the `web_sys_unstable_apis` config variable 2024-03-02 16:13:43 +01:00
.github ci: Don't exclude .wasm files from Firefox extension reproducibility testing 2024-03-04 23:45:29 +01:00
core core: Close sockets and timers when replacing the root movie 2024-03-05 23:14:08 +01:00
desktop desktop: Make WinitAsyncExecutor thread-safe and prevent deadlocks 2024-03-05 23:14:08 +01:00
exporter fix(deps): update rust dependencies 2024-03-02 10:05:43 +01:00
flv fix(deps): update rust dependencies 2024-01-22 03:09:33 +01:00
render desktop: Use custom (de)serialization for preferences, not serde 2024-03-05 00:02:27 +01:00
ruffle_gc_arena chore: Upgrade gc-arena to 0.5.0 2024-01-06 09:45:35 +01:00
scanner fix(deps): update rust dependencies 2024-03-02 10:05:43 +01:00
stub-report github: Generate AVM2 report as part of nightly release 2024-02-04 15:42:25 -05:00
swf core: Implement lazy decoding of bitmaps 2024-02-27 21:18:18 -05:00
tests desktop: Allow changing the language in Preferences 2024-03-05 00:02:27 +01:00
video cleanup: Define distinct key types for different kinds of slotmaps 2024-03-03 21:18:39 +01:00
web chore: Update translations from Crowdin 2024-03-05 22:56:34 +01:00
wstr wstr: Add UTF-8/UTF-16 index mapping 2024-02-01 20:18:29 +01:00
.dockerignore chore: Add a .dockerignore file 2024-02-04 00:06:11 +01:00
.gitattributes chore: Fix GitHub language detection 2024-01-30 08:00:51 +00:00
.gitignore chore: Add .idea to gitignore 2023-08-06 17:37:41 +02:00
CODE_OF_CONDUCT.md chore: Update CODE_OF_CONDUCT.md 2021-02-27 16:58:32 -08:00
CONTRIBUTING.md docs: Add detailed instructions for running tests 2023-05-31 21:32:51 +02:00
Cargo.lock chore: Update `cpal` to `0.15.3` 2024-03-05 14:24:29 +01:00
Cargo.toml chore: Replace `generational-arena` with `slotmap` 2024-03-02 19:42:11 +01:00
LICENSE.md doc: Remove `generational-arena` from LICENSE.md, update slotmap copyright year 2024-03-03 21:18:39 +01:00
PKGBUILD ci: Provide `sha512sums` in AUR package 2023-06-02 21:52:57 +03:00
README.md chore: add build dependency 2024-02-28 21:21:09 +01:00
crowdin.yml desktop: Localise texts 2023-05-24 23:50:48 +02:00
deny.toml chore: Update cargo-deny configuration to version 2 2024-03-05 21:21:42 +01: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 npm Ruffle AUR Ruffle Discord Ruffle translations
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

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.

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.

You must also have Java installed, and available on your PATH as java.

Desktop

If you are building for a Linux platform, the following are typical dependencies:

Ubuntu

  • libasound2-dev
  • libxcb-shape0-dev
  • libxcb-xfixes0-dev
  • libgtk-3-dev
  • libssl-dev
  • libudev-dev
  • libxcb-xinput-dev
  • libxcb-xkb-dev
  • libxcb-cursor-dev
  • default-jre-headless
  • cmake
  • g++

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.

Homebrew

Ruffle Desktop can be built from our Homebrew Tap:

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 for building either the web or browser extension version of Ruffle.

This project is tested with BrowserStack.

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 -- 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 --release --package=exporter -- path/to/file.swf
  • cargo run --release --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 Movavi Kongregate Bubble Shooter Neopets

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.

Contributing

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.