README.html 5.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. <!-- This page kind of looks like a mess, but that's only as I used https://markdowntohtml.com to convert MD to HTML -->
  2. <!DOCTYPE html>
  3. <html lang="en">
  4. <head>
  5. <title>README.md | OWLY.FANS</title>
  6. <meta charset="utf-8">
  7. <meta itemprop="name" content="OWLY.FANS">
  8. <meta property="og:title" content="OWLY.FANS">
  9. <meta itemprop="description" content="OWLY.FANS">
  10. <meta name="description" content="OWLY.FANS">
  11. <meta property="og:description" content="OWLY.FANS">
  12. <meta name="keywords" content="owly, cass python, neocities, neozones, brit, uk, archive, site ran by a stud, england, wales">
  13. <meta property="og:site_name" content="README.md | OWLY.FANS">
  14. <meta property="og:type" content="website">
  15. <meta property="og:image" content="https://owly.fans/floppy.png">
  16. <meta property="og:url" content="https://owly.fans">
  17. <meta name="referrer" content="no-referrer-when-downgrade">
  18. <link rel="shortcut icon" type="image/x-icon" href="../favicon.ico">
  19. <a class="account-link" rel="me" href="https://digipres.club/@Owly"></a><link rel="me" href="https://github.com/DynTylluan"><link rel="me" href="https://github.com/NeoZones"><link rel="me" href="mailto:owlgal69@protonmail.com"><link rel="me" href="https://owly.fans"><link rel="me" href="https://owlyfans.neocities.org"><meta content="#9B4F96" data-react-helmet="true" name="theme-color" />
  20. <link rel="stylesheet" href="../style_nobg.css">
  21. </head>
  22. <body><p><h1>README.md</h1></p><hr><h1 id="ruffle-selfhosted">ruffle-selfhosted</h1>
  23. <p>ruffle-selfhosted is the intended way to get Ruffle onto your website.</p>
  24. <p>You may either include it and forget about it, and we will polyfill existing Flash content,
  25. or use our APIs for custom configurations or more advanced usages of the Ruffle player.</p>
  26. <h2 id="using-ruffle-selfhosted">Using ruffle-selfhosted</h2>
  27. <p>For more examples and in-depth documentation on how to use Ruffle on your website, please
  28. <a href="https://github.com/ruffle-rs/ruffle/wiki/Using-Ruffle#web">check out our wiki</a>.</p>
  29. <h3 id="host-ruffle">Host Ruffle</h3>
  30. <p>The <code>selfhosted</code> package is configured for websites that do not use bundlers or npm and just want
  31. to get up and running. If you&#39;d prefer to use Ruffle through npm and a bundler, please
  32. <a href="https://github.com/ruffle-rs/ruffle/tree/master/web/packages/core">refer to ruffle core</a>.</p>
  33. <p>Before you can get started with using Ruffle on your website, you must host its files yourself.
  34. Either take the <a href="https://github.com/ruffle-rs/ruffle/releases">latest build</a>
  35. or <a href="https://github.com/ruffle-rs/ruffle/blob/master/web/README.md">build it yourself</a>, and make these files accessible by your web server.</p>
  36. <p>Please note that the <code>.wasm</code> file must be served properly, and some web servers may not do that
  37. correctly out of the box. Please see <a href="https://github.com/ruffle-rs/ruffle/wiki/Using-Ruffle#configure-wasm-mime-type">our wiki</a>
  38. for instructions on how to configure this, if you encounter a <code>Incorrect response MIME type</code> error.</p>
  39. <h3 id="-plug-and-play-">&quot;Plug and Play&quot;</h3>
  40. <p>If you have an existing website with flash content, you can simply include Ruffle as a script and
  41. our polyfill magic will replace everything for you. No fuss, no mess.</p>
  42. <pre><code class="lang-html"><span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"path/to/ruffle/ruffle.js"</span>&gt;</span><span class="undefined"></span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
  43. </code></pre>
  44. <h3 id="javascript-api">Javascript API</h3>
  45. <p>If you want to control the Ruffle player, you may use our Javascript API.</p>
  46. <pre><code class="lang-html"><span class="hljs-tag">&lt;<span class="hljs-name">script</span>&gt;</span><span class="javascript">
  47. <span class="hljs-built_in">window</span>.RufflePlayer = <span class="hljs-built_in">window</span>.RufflePlayer || {};
  48. <span class="hljs-built_in">window</span>.addEventListener(<span class="hljs-string">"DOMContentLoaded"</span>, () =&gt; {
  49. <span class="hljs-keyword">let</span> ruffle = <span class="hljs-built_in">window</span>.RufflePlayer.newest();
  50. <span class="hljs-keyword">let</span> player = ruffle.createPlayer();
  51. <span class="hljs-keyword">let</span> container = <span class="hljs-built_in">document</span>.getElementById(<span class="hljs-string">"container"</span>);
  52. container.appendChild(player);
  53. player.load(<span class="hljs-string">"movie.swf"</span>);
  54. });
  55. </span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
  56. <span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"path/to/ruffle/ruffle.js"</span>&gt;</span><span class="undefined"></span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
  57. </code></pre>
  58. <h2 id="building-testing-or-contributing">Building, testing or contributing</h2>
  59. <p>Please see <a href="https://github.com/ruffle-rs/ruffle/blob/master/web/README.md">the ruffle-web README</a>.</p><script src="../script.js"></script><script src="../ruffle/ruffle.js"></script><hr><p><a href="../ruffle">See more licenses here</a>.</p><font color="black"><center>&#x2605;</center></font><script src="../script.js"></script>
  60. <script src="../ruffle/ruffle.js"></script>
  61. </body>
  62. </html>