Document your code
Every project on GitHub comes with a version-controlled wiki to give your documentation the high level of care it deserves. Itโs easy to create well-maintained, Markdown or rich text documentation alongside your code.
Sign up for free See pricing for teams and enterprisesUsing Ruffle
Nightly builds of Ruffle are available for all platforms. You will also need an SWF file to run; try some Homestar Runner cartoons as a test!
Desktop
Grab the latest desktop player for your desired platform. Then run it from the command line:
ruffle test.swf
Web
To try out an SWF, navigate to the web demo page, and load the SWF of your choice.
TODO: Add instructions on integrating Ruffle into a website.
Browser extension
The browser extension works in both Chrome and Firefox. Grab the latest extension, unzip it to a folder, and install it using the following steps:
Chrome
- Navigate to chrome://extensions/
- Turn on Developer mode in the top right corner.
- Click Load unpacked.
- Select the extension folder.
Firefox
- Navigate to about:debugging
- Click on This Firefox.
- Click Load Temporary Add-on...
- Select
manifest.jsonfrom your extension folder.