Installation

• A-Frame
• Getting Started
• Universal AR

You can use this library by downloading a standalone zip containing the necessary files, by linking to our CDN, or by installing from NPM for use in a webpack project.

You can find the respective download links and installation instructions here.

Standalone Download

Once downloaded, unzip into your web project and reference from your HTML like this:

<script src="zappar-aframe.js"></script>

CDN

You can reference the zappar.js library from your HTML like this:

<script src="https://libs.zappar.com/zappar-aframe/*/zappar-aframe.js"></script>

* The latest version number can be found here.

NPM Webpack Module

Run the following NPM command inside your project directory:

npm install --save @zappar/zappar-aframe

We also expose a beta version of this package that contains recent tweaks and updates. To install, run the following NPM command inside your project directory:

npm install --save @zappar/zappar-aframe@beta

The beta version of the package is not recommended for live projects. We regularly update it which can lead to bugs. Please rigorously test across multiple devices and browsers if you are using this version of the package.

Then import the library into your JavaScript or TypeScript files:

import * as ZapparAFrame from "@zappar/zappar-aframe";

The final step is to add this necessary entry to your webpack rules:

module.exports = {
  //...
  module: {
    rules: [
      //...
      {
        test: /zcv\.wasm$/,
        type: "javascript/auto",
        loader: "file-loader"
      }
      //...
    ]
  }
};