ruffle/web/packages/extension
nosamu 680ffc3bbd
docs: Minor updates (#7264)
* docs: Minor updates to README.md

Extension builds are now output to a `dist` folder, just like all other web packages.

* docs: Minor updates to extension README

The Firefox instructions only work in Firefox Developer Edition or Nightly

* docs: Minor fixes for CONTRIBUTING.md

Omit the quotes in the RUST_LOG value, since they cause an error on Windows and are unnecessary on other platforms.
Also clarify which debugging features are activated by RUST_LOG and which are activated only when building Ruffle with `avm_debug`.

* docs: Add detail to build instructions

Add more detailed instructions for building the desktop app, as suggested by @coreybruce in #7251
2022-06-22 08:45:22 +03:00
..
assets i18n: Add spanish tranlation for swf download option 2021-11-15 23:12:27 +02:00
safari chore: Prevent language servers from scanning the Safari stub binary on Windows 2022-04-12 22:14:22 -07:00
src extension: Check for all octet-stream MIME types 2022-04-18 09:01:10 -07:00
tools web: Convert .eslintrc files from JSON to YAML 2022-01-12 20:10:00 -08: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 Add exclusions for sites broken by extension 2022-06-06 07:05:02 +03:00
package.json build(deps-dev): bump @types/chrome from 0.0.179 to 0.0.188 in /web 2022-06-06 20:25:01 +03:00
tsconfig.json web: Build two WASM modules, with/without extensions, load the appropriate one 2022-01-12 11:29:16 -08:00
webpack.config.js extension: Fix typo 2022-01-12 21:24:19 -08: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.