Building Ruffle

Ruffle is built using the Rust programming language. The first step to building Ruffle:

• Install Rust for your platform.

Building for desktop

Ruffle can be built for Windows, macOS and Linux using the following commands:

cd desktop/
cargo run -- test.swf

Building for web

• Install Node.js.
• Install wasm-pack.
• Navigate to your cloned repository's main directory and build with the following commands:

cd web/
npm install
npm run build

Build files are placed in the dist folder.

Building the web demo

The demo page is a quick way to test SWF content in Ruffle on the web.

• Install Node.js.
• Install wasm-pack.
• Navigate to your cloned repository's main directory and run with the following commands:

cd web/
npm install
npm run build
npm run demo

Navigate to the indicated page in your browser (usually http://localhost:8080/).

Building the modules without a web bundler

• Install Rust for your platform.
• Install wasm-pack.
• Navigate to your cloned repository's main directory and build with the following commands:

cd web/
wasm-pack build --out-name=ruffle --target=web

The package scripts are built in the pkg folder.

Building the Web Extension

• Install Node.js.
• Install wasm-pack.
• Navigate to your cloned repository's main directory and build with the following commands:

cd web/
npm install
npm run build

Build files are placed in the packages/extension/dist folder, which is extension_chrome.zip and extension_firefox.xpi. These are unpacked extensions and can be loaded using the instructions in the extension section of the Using Ruffle wiki page.

Tests

To run unit and regression tests:

cargo test --all