History

Wumbo 4403848a4b web: Extension UI improvements (#13473 ) * web: Improve styling of extension pop-up menu * web: Improve styling of extension settings page * web: Improve styling of extension player * web: Make styling more consistent across browsers * web: Run eslint, fix some problems * web: Move version text near top of pop-up menu, add to settings menu * web: Improve logo hover bounds in pop-up and settings * web: Improve styling of extension status indicator * web: Update extension pop-up text strings * web: Misc. sizing/padding changes to extension UI * web: chore: Add a stylelint exception for #backgroundColor in player.css Because it's not kebab-case, to match the keys of the metadata object in JS. --------- Co-authored-by: TÖRÖK Attila <torokati44@gmail.com>		2023-11-03 23:07:25 +01:00
..
assets	web: Extension UI improvements (#13473 )	2023-11-03 23:07:25 +01:00
safari	web: Removed unwraps in safari extension	2023-01-10 11:10:46 +01:00
src	web: Extension UI improvements (#13473 )	2023-11-03 23:07:25 +01:00
tools	chore: formatting	2023-07-21 23:34:43 +02:00
.eslintrc.yaml	extension: Check tools using TypeScript	2023-04-06 18:41:36 +03: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
jsconfig.json	extension: Check tools using TypeScript	2023-04-06 18:41:36 +03:00
manifest_firefox.json5	web: Make open-in-new-tab open the local player directly, and disable takeover of all SWF urls	2023-08-22 19:35:05 +02:00
manifest_other.json5	web: Make open-in-new-tab open the local player directly, and disable takeover of all SWF urls	2023-08-22 19:35:05 +02:00
package.json	chore(deps): update node.js dependencies	2023-10-27 23:40:04 +02:00
tsconfig.json	web: Use TypeScript project references	2023-02-25 02:00:23 +02:00
webpack.config.js	nit: Fix tool name in error message of extension build	2023-10-27 20:06:39 +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.