liangsheng8708
/
ruffle
mirror of https://mirror.ghproxy.com/https://github.com/ruffle-rs/ruffle.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

web: Update extension README.md

This commit is contained in:
relrelb 2021-02-26 05:04:45 +02:00 committed by Mike Welsh
parent 027597039f
commit 1e7bd652e7
1 changed files with 31 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
web/packages/extension/README.md
View File

@ -2,38 +2,50 @@
ruffle-extension is all of the power of Ruffle, in your browser.
Without needing websites to do anything, the browser extension will automatically replace any Flash content on websites
with the Ruffle player.
Without needing websites to do anything, the browser extension automatically replaces any Flash content on websites with the Ruffle player.
The extension will automatically negotiate 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.
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 is built to work in both Chrome and Firefox.
The browser extension works in Chrome, Firefox, and Safari 14+.
We do not yet have a signed release of the extension, so you must load it as a temporary extension.
Before you can install the extension, you must either download the
[latest build](https://ruffle-rs.s3-us-west-1.amazonaws.com/builds/extension/ruffle_extension_latest.zip)
or [build it yourself](../../README.md).
Before you can install the extension, you must either download the [latest release](https://github.com/ruffle-rs/ruffle/releases) or [build it yourself](../../README.md).
### Chrome
- Unpack `dist/ruffle_extension.zip` somewhere
- Navigate to chrome://extensions/
- Turn on Developer mode in the top right corner.
- Click Load unpacked.
- Select the folder you unpacked the extension to.
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:debugging.
- Click on This Firefox.
- Click Load Temporary Add-on...
- Select the `.xpi` from the `dist` folder.
- Navigate to `about:debugging`.
- Click on "This Firefox".
- Click "Load Temporary Add-on...".
- 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](../../README.md).
Please see the [ruffle-web README](../../README.md).