ruffle/web/packages/extension
relrelb 9f8419a145 web: Change `ruffle-core` output directory to `dist`
This aligns with the other packages.
2023-02-24 12:43:01 +02:00
..
assets web: Add version number requested in #8021 2022-12-13 22:49:20 +01:00
safari web: Removed unwraps in safari extension 2023-01-10 11:10:46 +01:00
src web: Change `ruffle-core` output directory to `dist` 2023-02-24 12:43:01 +02:00
tools web: Automatically inject plugin-polyfill.ts into content.ts as a string. 2023-02-15 21:27: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: Update copyright 2022-03-26 18:13:14 -07:00
README.md docs: Minor updates (#7264) 2022-06-22 08:45:22 +03:00
manifest.json5 Don't run on Twitch 2022-10-02 15:23:23 +02:00
package.json extension: Use `@tsconfig/strictest` 2023-02-22 21:39:12 +02:00
tsconfig.json extension: Use `@tsconfig/strictest` 2023-02-22 21:39:12 +02:00
webpack.config.js web: Build a separate plugin polyfill target file. 2023-02-15 21:27:14 -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+. 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.