ruffle/web/packages/extension
Nathan Adams adebb04e3d web: Removed some unneeded eslint configs 2024-07-08 11:34:35 +02:00
..
assets chore: Update translations from Crowdin 2024-07-02 23:56:16 +02:00
safari chore: Delegate `[lints]` in `Cargo.toml` of all packages to the workspace 2024-01-05 11:28:19 +01:00
src web: Enable tseslint.configs.strict (it caught a bug!) 2024-07-08 11:34:35 +02:00
tools web: Migrate to 'flat config' style for eslint 2024-07-08 11:34:35 +02:00
.gitignore web: Rename extension/build/ to extension/assets/ 2021-04-15 13:47:07 -07:00
4399_rules.json extension: Fix 4399 CORS and Flash detection issue (close #13943) (#16750) 2024-06-21 15:05:53 +00:00
LICENSE_APACHE chore: Copy LICENSE* to relevant places where package managers complain if they don't exist, and make sure they're included in distributions 2020-05-27 00:11:02 -07:00
LICENSE_MIT chore: Update copyright 2022-03-26 18:13:14 -07:00
README.md docs: Link to the new Chrome Web Store from README.md 2023-11-30 00:16:20 +01:00
jsconfig.json web: Rewrite AMO submission script to use their v5 API directly 2024-04-04 21:48:45 +02:00
manifest.json5 extension: Don't register 4399 content script if Ruffle is disabled 2024-07-06 12:55:37 +02:00
package.json build(deps-dev): bump the npm-minor group in /web with 8 updates 2024-07-07 12:50:16 +02:00
tsconfig.json web: Use TypeScript project references 2023-02-25 02:00:23 +02:00
webpack.config.js web: Removed some unneeded eslint configs 2024-07-08 11:34:35 +02:00

README.md

ruffle-extension

ruffle-extension is all of the power of Ruffle, in your browser.

Without needing websites to do anything, the browser extension automatically replaces any Flash content on websites with the Ruffle player.

It automatically negotiates with websites that do have Ruffle installed, to ensure that there is no conflict between the versions. Newer version of ruffle, either from the website or extension, will always take precedence and disable the other.

Using ruffle-extension

The browser extension works in Chrome, Firefox, and Safari 14+. It can be installed directly from the Chrome Web Store or Firefox Add-ons site. Or to install it manually, you can either download the latest release or build it yourself, then follow the instructions below.

Chrome

These instructions also apply to Chromium-based browsers such as Edge, Opera and Brave.

  • Navigate to chrome://extensions/.
  • Turn on Developer mode in the top-right corner.
  • Drag and drop the *-extension.zip file into the page.

Alternatively, loading unpacked can save time during development:

  • Navigate to chrome://extensions/.
  • Turn on Developer mode in the top-right corner.
  • Click "Load unpacked".
  • Select the assets/ folder.
  • Each time after making changes, click the reload icon.

Firefox (Developer Edition or Nightly)

  • Navigate to about:addons.
  • Click the gear and select "Install Add-on From File...".
  • Select the .xpi file.

Safari

  • Unzip the *-extension.zip file.
  • Run xcrun safari-web-extension-converter path/to/unzipped_folder/
  • Click "Run on Xcode".
  • Enable Safari > Preferences > Advanced > Show Develop menu in menu bar.
  • Enable Develop > Allow Unsigned Extensions.
  • Enable the extension by checking the box in Safari > Preferences > Extensions.

Building, testing or contributing

Please see the ruffle-web README.