Installation

The SDK is delivered as packaged source code ARTVUnitySDK-VERSION.unitypackage. It contains all of the components needed to bring augmen.tv capabilities to your Unity project.

Prepare your Unity project

Adding required packages

ARTV SDK uses some of the packages that are available through Unity Package Manager. In future updates Unity will support automatic package dependency installation, but as of now they have to be added manually prior to importing ARTV SDK into the project.

  1. Open your project in Unity 2018.4.x (LTS) or create a new one.
  2. From the Unity menu select Window → Package Manager.
  3. In the Packages window make sure to check Advanced → Show Preview Packages option. Note, that updating package list may take a couple of seconds.
  4. Locate and install the following items (make sure to select the correct version from the dropdown near the Install button).

    a. AR Foundation (1.0.0-preview.22)

    b. ARCore XR Plugin (1.0.0-preview.24)

    c. ARKit XR Plugin (1.0.0-preview.27)

It is important to install the appropriate preview versions and not the latest ones because they are not supported in Unity 2018.4.x LTS at the moment.

Rendering layers

NOTE: Make sure that you are not using rendering layer #11 within your project prior to importing ARTV SDK Also make sure package preview version is the right one or else the ARTV hub will not pop-up

ARTV uses rendering layers system for background camera rendering. These settings are not getting transferred via *.unitypackage distribution in order to avoid conflicts with host projects existing rendering layers configuration. As long as your project does not utilize layer #11, everything should work as expected, since its index gets serialized along with the game objects that use particular layer, it just lacks the name.

Our background camera’s Culling Mask field will state “mixed”, however opening the dropdown reveals that no currently listed layers are ticked, meaning that this camera uses some layer that does not have a name. Installation 1.PNG

To import the package into Unity

Optionally, you can add the “Background” name for the layer at index 11 to avoid further accidental overrides. Installation 2.PNG

To import the package into Unity

From the Unity menu

  1. Open your project or create new one.
  2. Click Assets → Import Package → Custom Package…
  3. Find ARTVUnitySDK-VERSION.unitypackage on your hard drive and click Open.
  4. On the Unity Import Package window click Import.

From the Finder or Windows File Explorer

  1. Make sure your target project is opened in Unity.
  2. Double-click on ARTVUnitySDK-VERSION.unitypackage.
  3. On the Unity Import Package window click Import.