# Getting Started

How to set up and get started with Resight Engine

# Updates & Fixes (v.0.3.1)

Improved mesh for faster and more stable scans of large areas

# System Requirements

       - Unity 2021.3.22f1 >
         - Default Unity Render Pipeline
       - iOS 15.4 >
       - iPhone 12 >
         - Pro devices are needed in order to utilize 3D scans
       - Xcode 14.2 >

# Resight Engine Setup

  1. Create a new project in Unity

    • Choose the 3D project template

  2. Switch to the iOS platform in File/Build Settings

  • Unpack Resight SDK to a local folder (resight-engine-XXX.zip)

  • Download and extract Resight Engine into your project’s Packages folder. The project will restart automatically

  • Import the sample apps to your project in Window/Package Manager

# Project Settings

  1. Go to Edit / Project Settings > 'XR Plug-in Management' tab

    • Make sure that 'Apple ARKit' is selected

  2. Go to Edit / Project Settings > 'Player' tab > 'Other Settings' section

  3. Deselect 'Multithreaded Rendering'

# Shadows (Optional)

  1. Go to Edit / Project Settings > 'Quality' tab

    • Select the quality level for the iOS build (the line that has a green checkmark under the iOS column)

      - Shadow Resolution: Medium or High
      - Shadow Projection: Close Fit
      - Shadow Distance: 10
      - Shadow Cascades: Two Cascades

# Lighting (Optional)

  1. Find the Directional Light object in the Hierarchy

    • Light settings:

       - Change intensity to 0.35
       - Change Bias to 0.02
       - Change Normal Bias to 0.02
       - Change Near Plane to 0.2

# Resight Engine Settings

  1. Open the sample scene: Assets / Samples / Resight Engine / 0.3.1 /Resight Samples

  2. Go to the 'Resight' game object in the open scene

    • Find the 'LibResight' component
    • Enter your developer key (provided by Resight) and a namespace
    • A namespace can be any string (without spaces), for example, Default / Production / Test-1
    • A namespace is a unique data store under your developer account
    • Mapping data and snapped objects are not shared between different namespaces

# Get a Developer Key


To obtain the development key, sign-up (opens new window) on our website. If you've registered and haven't received it yet, please contact us.

# Upgrading Resight Engine

To update Resight Engine, follow steps 3-4 from Engine Setup section. Make sure you override the existing Resignt Engine folder (usually, it's under Packages/io.resight.sdk)