PlayCanvas is a browser based, open-source 3D game and interactive application engine. It allows for simultaneous editing from multiple computers via a browser-based interface. It runs in modern browsers that support WebGL, including Mozilla Firefox and Google Chrome.

Our Universal AR for PlayCanvas package allows you to use Zappar's best-in-class AR technology with content built using the PlayCanvas WebGL game engine. It's great for creating AR games and experiences built specifically for the browser.

Getting Started

You can use this library by forking our dedicated project from PlayCanvas.

You can fork the Zappar project here, to get started.

Fork the Project from PlayCanvas

To get started quickly using the Zappar for PlayCanvas package, you can begin with a ready to use template.

Find out more information on how to use the Zappar templates, check out the respective articles below:

We also have a number of free example projects created using our different tracking templates, coupled with other PlayCanvas specific functionality. You can find these examples at Zappar's dedicated PlayCanvas page.

Previewing and Testing

During development, you'll want to preview your project to test how your experience is performing.

You can preview using the 'play' button in the editor.

Play/Preview Button in PlayCanvas Editor

You can also download a zip archive of your project from PlayCanvas and host it yourself. Due to browser restrictions surrounding use of the camera, you must use HTTPS to view or preview your site, even if doing so locally from your computer. If you're using webpack, consider using webpack-dev-server which has an https option to enable this.

Alternatively, you can use the ZapWorks command-line tool to serve a folder over HTTPS for access on your local computer, like this:

$ zapworks serve .

The command also lets you serve the folder for access by other devices on your local network, like this:

$ zapworks serve . --lan

Hosting and Publishing Content

Once you've built your site, you have a number of options for hosting:

  • Using ZapWork's integrated hosting
  • Using PlayCanvas hosting
  • Self-hosting on servers and a domain that you manage

For more information about ZapWork's integrated hosting or self-hosting, head over to our Hosting docs article.

For more information about PlayCanvas hosting, please refer to the PlayCanvas documentation on publishing.

Advanced Usage

This documentation is intended only as a guide for using Zappar's Universal AR SDK for PlayCanvas. For more information about how to use PlayCanvas itself, please refer to the PlayCanvas documentation here.

zapcode branded_zapcode i