Skip to content

Latest commit

 

History

History
33 lines (21 loc) · 1.34 KB

README.md

File metadata and controls

33 lines (21 loc) · 1.34 KB
Raw

AR-gif

Easy to use augmented reality web components that support GIFs and Videos!

Introduction

ar-gif is an effort to bring augmented reality with web components in a easy way. It supports gif, png, jpg, mp4 and webm playing with pattern detection markers, but if you want to add new functionalities feel free to contribute.

This web-component is used in Jandig, a project the aims to bring AR and Art for everyone.

Usage

ar-gif has a simple API, we have an ar-scene and one or more ar-markers.

<ar-scene>
  <ar-marker patt="hiro.patt" content="hiro.gif"></ar-marker>
  <ar-marker patt="cat.patt" content="cat.mp4"></ar-marker>
</ar-scene>

Each ar-scene is responsible to detect every marker inside it and each marker is reponsible to show his content. The "patt" attribute indicates which pattern will be registered for that marker and the content is the gif, image or video that will be played.

For more information about how to use, check index.html in the example folder.

Build

To build AR-gif locally, to test or create new features, you need to use webpack-cli. You can use our shortcut on npm:

$ npm install

$ npm run build