f47fa38235
Bumps the npm-minor group in /web with 9 updates: | Package | From | To | | --- | --- | --- | | [@eslint/js](https://github.com/eslint/eslint/tree/HEAD/packages/js) | `9.6.0` | `9.7.0` | | [eslint](https://github.com/eslint/eslint) | `9.6.0` | `9.7.0` | | [eslint-plugin-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc) | `48.5.2` | `48.7.0` | | [eslint-plugin-react-refresh](https://github.com/ArnaudBarre/eslint-plugin-react-refresh) | `0.4.7` | `0.4.8` | | [prettier](https://github.com/prettier/prettier) | `3.3.2` | `3.3.3` | | [stylelint](https://github.com/stylelint/stylelint) | `16.6.1` | `16.7.0` | | [stylelint-prettier](https://github.com/prettier/stylelint-prettier) | `5.0.0` | `5.0.1` | | [webpack](https://github.com/webpack/webpack) | `5.92.1` | `5.93.0` | | [typedoc](https://github.com/TypeStrong/TypeDoc) | `0.26.3` | `0.26.4` | Updates `@eslint/js` from 9.6.0 to 9.7.0 - [Release notes](https://github.com/eslint/eslint/releases) - [Changelog](https://github.com/eslint/eslint/blob/main/CHANGELOG.md) - [Commits](https://github.com/eslint/eslint/commits/v9.7.0/packages/js) Updates `eslint` from 9.6.0 to 9.7.0 - [Release notes](https://github.com/eslint/eslint/releases) - [Changelog](https://github.com/eslint/eslint/blob/main/CHANGELOG.md) - [Commits](https://github.com/eslint/eslint/compare/v9.6.0...v9.7.0) Updates `eslint-plugin-jsdoc` from 48.5.2 to 48.7.0 - [Release notes](https://github.com/gajus/eslint-plugin-jsdoc/releases) - [Changelog](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/.releaserc) - [Commits](https://github.com/gajus/eslint-plugin-jsdoc/compare/v48.5.2...v48.7.0) Updates `eslint-plugin-react-refresh` from 0.4.7 to 0.4.8 - [Release notes](https://github.com/ArnaudBarre/eslint-plugin-react-refresh/releases) - [Changelog](https://github.com/ArnaudBarre/eslint-plugin-react-refresh/blob/main/CHANGELOG.md) - [Commits](https://github.com/ArnaudBarre/eslint-plugin-react-refresh/compare/v0.4.7...v0.4.8) Updates `prettier` from 3.3.2 to 3.3.3 - [Release notes](https://github.com/prettier/prettier/releases) - [Changelog](https://github.com/prettier/prettier/blob/main/CHANGELOG.md) - [Commits](https://github.com/prettier/prettier/compare/3.3.2...3.3.3) Updates `stylelint` from 16.6.1 to 16.7.0 - [Release notes](https://github.com/stylelint/stylelint/releases) - [Changelog](https://github.com/stylelint/stylelint/blob/main/CHANGELOG.md) - [Commits](https://github.com/stylelint/stylelint/compare/16.6.1...16.7.0) Updates `stylelint-prettier` from 5.0.0 to 5.0.1 - [Changelog](https://github.com/prettier/stylelint-prettier/blob/main/CHANGELOG.md) - [Commits](https://github.com/prettier/stylelint-prettier/compare/v5.0.0...v5.0.1) Updates `webpack` from 5.92.1 to 5.93.0 - [Release notes](https://github.com/webpack/webpack/releases) - [Commits](https://github.com/webpack/webpack/compare/v5.92.1...v5.93.0) Updates `typedoc` from 0.26.3 to 0.26.4 - [Release notes](https://github.com/TypeStrong/TypeDoc/releases) - [Changelog](https://github.com/TypeStrong/typedoc/blob/master/CHANGELOG.md) - [Commits](https://github.com/TypeStrong/TypeDoc/compare/v0.26.3...v0.26.4) --- updated-dependencies: - dependency-name: "@eslint/js" dependency-type: direct:development update-type: version-update:semver-minor dependency-group: npm-minor - dependency-name: eslint dependency-type: direct:development update-type: version-update:semver-minor dependency-group: npm-minor - dependency-name: eslint-plugin-jsdoc dependency-type: direct:development update-type: version-update:semver-minor dependency-group: npm-minor - dependency-name: eslint-plugin-react-refresh dependency-type: direct:development update-type: version-update:semver-patch dependency-group: npm-minor - dependency-name: prettier dependency-type: direct:development update-type: version-update:semver-patch dependency-group: npm-minor - dependency-name: stylelint dependency-type: direct:development update-type: version-update:semver-minor dependency-group: npm-minor - dependency-name: stylelint-prettier dependency-type: direct:development update-type: version-update:semver-patch dependency-group: npm-minor - dependency-name: webpack dependency-type: direct:development update-type: version-update:semver-minor dependency-group: npm-minor - dependency-name: typedoc dependency-type: direct:development update-type: version-update:semver-patch dependency-group: npm-minor ... Signed-off-by: dependabot[bot] <support@github.com> |
||
---|---|---|
.. | ||
src | ||
test | ||
texts | ||
tools | ||
.gitignore | ||
.mocharc.yaml | ||
README.md | ||
package.json | ||
tsconfig.json | ||
typedoc.json |
README.md
ruffle-core
ruffle-core is the core javascript bindings to the Wasm ruffle-web binary, and contains the actual public API.
Using ruffle-core
For more examples and in-depth documentation on how to use Ruffle on your website, please check out our wiki.
Host Ruffle
The core
package is configured for websites that build and bundle their files themselves.
Simply add ruffle
to an npm package, and use something like Webpack to actually bundle and serve
the files.
If you wish to use Ruffle on a website that doesn't use npm, we have a pre-bundled version which we call 'selfhosted'. Please refer to its documentation.
Please note that the .wasm
file must be served properly, and some web servers may not do that
correctly out of the box. Please see our wiki
for instructions on how to configure this, if you encounter a Incorrect response MIME type
error.
"Plug and Play"
If you have an existing website with flash content, you can simply include Ruffle as a script and our polyfill magic will replace everything for you. No fuss, no mess.
<script src="path/to/ruffle/ruffle.js"></script>
Javascript API
If you want to control the Ruffle player, you may use our Javascript API.
<script>
window.RufflePlayer = window.RufflePlayer || {};
window.addEventListener("DOMContentLoaded", () => {
let ruffle = window.RufflePlayer.newest();
let player = ruffle.createPlayer();
let container = document.getElementById("container");
container.appendChild(player);
player.load("movie.swf");
});
</script>
<script src="path/to/ruffle/ruffle.js"></script>
Building, testing or contributing
Please see the ruffle-web README.