680ffc3bbd
* 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 |
||
---|---|---|
.. | ||
assets | ||
safari | ||
src | ||
tools | ||
.gitignore | ||
LICENSE_APACHE | ||
LICENSE_MIT | ||
README.md | ||
manifest.json5 | ||
package.json | ||
tsconfig.json | ||
webpack.config.js |
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.