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 Linux, OSX, and Windows using the following commands:

• cd desktop
• cargo run -- testing.swf

Building for web

Ruffle uses npm and wasm-pack to build for web.

• Install Node.js
• Install wasm-pack

Navigate to your cloned repository's main directory and build with these steps:

• cd web/self-hosted
• npm install
• npm run build
• Build files will be placed in the dist folder

Building the web demo

• Install Node.js
• Install wasm-pack

The demo page is a quick way to test SWF content in Ruffle on the web. Navigate to your cloned repository's main directory and run it with these steps:

• cd web/demo
• npm install
• npm run serve -- --mode=production
• 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 follow these steps:

• 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 follow these steps:

• cd web/extension
• npm install
• npm run build
• Build files will be placed in the build folder, which is an unpacked extension 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