https://github.com/rodrigocam/ar-gif

Easy to use augmented reality web components
https://github.com/rodrigocam/ar-gif

ar-gif ar-markers augmented-reality gif gif-animation hacktoberfest html javascript jsartoolkit mp4 threejs web web-component webm

Last synced: 2 days ago
JSON representation

Easy to use augmented reality web components

• Host: GitHub
• URL: https://github.com/rodrigocam/ar-gif
• Owner: rodrigocam
• License: mit
• Created: 2019-02-11T06:12:28.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-02T23:17:03.000Z (almost 2 years ago)
• Last Synced: 2024-09-21T02:32:13.841Z (6 days ago)
• Topics: ar-gif, ar-markers, augmented-reality, gif, gif-animation, hacktoberfest, html, javascript, jsartoolkit, mp4, threejs, web, web-component, webm
• Language: JavaScript
• Homepage:
• Size: 1.42 MB
• Stars: 57
• Watchers: 7
• Forks: 19
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](https://github.com/memeLab/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.

```html

  

  

```

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](https://github.com/rodrigocam/ar-gif/blob/master/example/index.html) in the [example](https://github.com/rodrigocam/ar-gif/blob/master/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:

```bash

$ npm install

$ npm run build