jsora

A frontend/browser javascript library for reading, writing, and rendering OpenRaster (ORA) files.

Usage no npm install needed!

<script type="module">
  import jsora from 'https://cdn.skypack.dev/jsora';
</script>

README

jsora

A frontend/browser javascript library for reading and writing OpenRaster (ORA) files.

Code Repository: https://gitlab.com/inklabapp/jsora

NPM: https://www.npmjs.com/package/jsora

what is supported

  • reading, extracting image data and metadata from ORA files
  • writing (creating new and modifying) ORA files, with any path structure and metadata
  • api support for layers / groups in a easy-to-use manner
  • rendering ORA files and edits to a browser canvas

limitations

  • Currently there is limited support for using multiple layers with the same path (same name in the same group)

why not use...?

  • I took note of another library with similar goals; https://github.com/zsgalusz/ora.js . However, I ended up not liking it because of the seeming lack of layer / group structure support.

help

  • for new style, all of the useful exports come from src/index.js . The repository is also preconfigured with webpack.
  • for 'old style', there will be a jsora.min.js file in the 'dist' dir built for use in a script tag after each release.
  • There is a useful html file in examples/tutorial.html which makes use of all of the high level features with some commentary. In addition, please feel free to reach out anytime for assistance. I am actively working on both developing this library and the standard itself.