Get started
Add one script and one element to a page. There is nothing for your visitors to install.
Put a movie on a page
<script type="module" src="https://osanimator.com/player/0.1.0/osa-player.js"></script>
<osa-player src="movie.osa.json">
<img src="movie-poster.svg" alt="What the movie shows">
<p>A description for browsers that can't run the player.</p>
</osa-player>Inside the element, put a picture of the movie and a sentence about it. Browsers that can't run the player show them instead, and so does the player if a movie fails to load.
The scene heading the player makes is a level 2 heading. If your page needs another level, set it: heading-level="3".
The files
| File | What it is |
|---|---|
| Player, served here | https://osanimator.com/player/0.1.0/osa-player.js, an ES module. Other sites may load it from this address. |
| Player, minified | https://osanimator.com/player/0.1.0/osa-player.min.js |
| Download | osa-player.js and osa-player.min.js from the repository, to serve from your own site |
| The format | SPEC.md: how a movie file is written, and what the player guarantees |
| The guide | README.md: building, testing and making a poster picture |
Not in version 0.1
The editor, scripting, sound, video and bitmaps are still to come. So far the player is tested in Chromium; Safari, Firefox and phones are next.