Getting Started with echo3D

Echo3D is a 3D-ready cloud platform to help manage and deliver 3D, AR or VR content to apps and devices everywhere. Zappar is an augmented reality creator platform. Together, Zappar and echo3D make it super easy to create fun, engaging and scalable AR experiences.

This step-by-step guide explains how you can use both the Zappar and echo3d Unity SDKs together to develop Augmented Reality experiences with streamed 3D models for Unity's WebGL build platform.

Click here to learn more about the echo3d Unity SDK.

Prerequisites

In order to use the echo3D package, you require an echo3D account.

You can register for your free echo3D account here.

Getting Setup

  1. To get started, open a new Unity project and import the Zappar for Unity package.
  2. In your echo3D console, download and import the Unity SDK.

Using echo3D and Zappar

If you have imported the Zappar package, a Zappar menu entry will appear in the main Unity toolbar. The Zappar menu has Zappar context specific components and utilities for ease of use.

  1. To get started with AR development in Unity, add a Zappar Camera from the Zappar menu.
  2. Remove any other cameras you have (Main Camera), or mark the Zappar Camera as your primary/active camera.
  3. Add a Zappar tracking game object from the Zappar menu entry (using the same method as above).
  4. Select the Zappar Camera game object in the Hierarchy and then drag the Zappar tracking type into the camera's Anchor Origin property in the Inspector.

This is required when using echo3d as it allows the Zappar camera to move around 3D space and show the 3D content correctly.

  1. Drag the echo3d script onto the Zappar Tracking Target and fill out the API key and entry ID details in the Inspector.

echo3D script on Zappar Tracking Target

You can also drag the echo3D prefab onto the Zappar tracking type in the Hierarchy to make it a child of the tracker game object for more control.

Testing

You can run the experience in Unity's Play Mode to check the scale, rotation and position of your streamed content to confirm it looks good.

Preloaded holograms will clear and re-load on play. Preserving preloaded holograms will be included in a future echo3d update.

Publishing to WebGL

Before having the ability to publish your developed project, you'll first need to build it for the platform of your choice. To build for WebGL, follow the steps below:

  1. Go to File -> Build Settings in the main Unity toolbar.
  2. Select WebGL as your desired platform.
  3. Go to Player Settings -> Player and select the correct Zappar WebGL template for your version of Unity.
  4. Click Build.

For Unity 2019 and older versions, use the Zappar 2019 template. For Unity 2020 and above, use the Zappar template.

For more about publishing with the Universal AR SDK for Unity, click here.

Locally Hosting (Testing)

You can test your projects by serving the content locally using the ZapWorks CLI tool.

To learn more about testing your projects, click here.

Hosting

Once you're happy with your build, you can host it with ZapWorks or self-host on your own site.

Learn how to host with ZapWorks here and how to self-host here.

zapcode branded_zapcode i