ruffle/web/packages/extension
relrelb 0b4d6e6a1c extension: Add an option to ignore unsupported content warnings 2021-09-24 18:52:13 +03:00
..
assets extension: Add an option to ignore unsupported content warnings 2021-09-24 18:52:13 +03:00
src extension: Add an option to ignore unsupported content warnings 2021-09-24 18:52:13 +03:00
tools extension: Catch errors while signing the Firefox add-on 2021-04-16 12:31:14 -07:00
.gitignore web: Rename extension/build/ to extension/assets/ 2021-04-15 13:47:07 -07: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: 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
README.md docs: Update Firefox add-on instructions 2021-04-16 12:31:14 -07:00
manifest.json5 extension: Fix warning on Firefox 2021-08-16 23:03:29 +03:00
package.json dev: allow for failure of firefox signing in build nightly 2021-09-21 20:10:20 +02:00
tsconfig.json web: Indent using spaces in tsconfig.json 2021-09-15 00:42:17 +03:00
webpack.config.js web: Set `__webpack_public_path__` in `load-ruffle.ts` 2021-09-08 02:25:05 -07: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+.

Before you can install the extension, you must either download the latest release or build it yourself.

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

  • 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.