Skip to content

Latest commit

 

History

History
59 lines (45 loc) · 4.56 KB

README.md

File metadata and controls

59 lines (45 loc) · 4.56 KB

OfferZen Make Day Augmented Reality Starter Project

This is a starter project to build an augmented reality app with Root insurance for the Make day course by OfferZen.

Prerequisites

  1. Clone or download this starter project to your machine.
  2. Download and install Unity via Unity Hub. Vuforia comes bundled with Unity. While it's downloading, continue with this process.
  3. Get a Vuforia App Licence Key and put it in the "App Licence Key" field under Vuforia Configuration -> Global via the "Window" option in the app toolbar.
  4. Create a new Vuforia "Device" database to hold your tracking images.
  5. Upload the following two target tracking images to your Vuforia database:
    1. egg1
    2. egg2
  6. Download your Vuforia database to a known location and import it into your Unity project.

Walkthrough Screencast

Watch the walkthrough screencast detailing how to set up Unity and Vuforia, or jump to your area of concern:

  1. Register for Vuforia 00:15
  2. Overview of Unity 01:27
  3. Activate Vuforia License Key in Unity 02:10
  4. Turn on Vuforia "AR Support" 02:44
  5. Create online Vuforia database and upload image targets 03:36
  6. Download the Vuforia database and import it in Unity 06:50
  7. Manipulate an ImageTarget 07:10
  8. Add a second ImageTarget and a prefab (prefabicated asset) 09:37
  9. Interact with ImageTarget using a script 12:25
  10. Collision detection between a ball and a capsule 16:30
  11. Reset ball position 19:35
  12. Make a Root API call 20:32
  13. Questions and Bye! 23:38

Great, you got this far. You're almost there!

Get Started with Local Development

  1. Open this repository as a project in Unity.
  2. Import the Vuforia "Device" database you downloaded in the previous section.
  3. In the bottom-left, you should see two tabs titled "Project" and "Console". Take note of any unexpected errors under the "Console" tab. Common pitfalls are addressed below.
  4. Under the "Project" tab, navigate to the folder Assets -> Scenes and open the scene called SampleScene.
  5. Under the "Project" tab, navigate to Assets -> Resources and click on Vuforia Configuration.
  6. Add your generated Vuforia App License Key in the Vuforia Inspector (on the right).
  7. Tick the Vuforia Augmented Reality Support checkbox under Edit -> Project Settings -> Player.
  8. Select the imported targed in Image Target Behaviour In the ImageTarget GameObject.
  9. Click the Play button (middle top) and have fun!

Common Pitfalls

  • "My external USB webcam not listed in Vuforia." This can be caused by version migration issues, or when the webcam was unplugged while starting Unity.
  • "Vuforia only tracks one target at a time." There is a default limit of 1 tracking targets.

Where to change maximum simultaneous image tracking

Helpful Hints

  • Right-click inside the hierachy tree (on the left) to quickly add new nodes.
  • To rotate the viewport, hold Alt (on PC) or Option (on Mac) while dragging.
  • To pan the viewport, hold Alt+Cmd (on Mac) or Option (on PC) while dragging.