Skip to content

8thwall/aframe-image-targets-example

Repository files navigation

A-Frame: Image Targets

This example uses image targets to display information about jellyfish on a flyer. It uses the xrextras-named-image-target component to connect an to an image target by name while the xrextras-play-video component enables video playback.

Preview of the experience showing a printed flyer with a 3D jellyfish and playable video aligned to the graphics

Try it out

https://8thwall.org/aframe-image-targets-example/

QR Code for the preview link

Flyer design showing image targets

Usage

  1. On this repository, click Code > Download ZIP. If you clone the repository instead, make sure you have Git LFS installed and run git lfs pull
  2. Unzip the folder to the location you'd like to work in
  3. npm install
  4. npm run serve
  5. To connect to a mobile device, follow these instructions
  6. Recommended: Track your files using git to avoid losing progress

Preparing Target Images

Image targets can be generated using the interactive CLI tool:

npx @8thwall/image-target-cli@latest

More information can be found here: https://github.com/8thwall/8thwall/blob/main/apps/image-target-cli/README.md

You can also use the 8th Wall Desktop app to generate image targets, then copy them into this project to use them in A-Frame.

Deployment

This project contains Github Actions configuration for deployment to Github Pages, which triggers automatically by pushing the main branch. You can also create a production build using npm run build, which outputs the production build to the dist folder, and publish to the web using this guide.

Questions?

Please raise any questions on Github Discussions or join the Discord to connect with the community.

Releases

No releases published

Packages

 
 
 

Contributors