Add the plugin to an existing project

Open existing projects

In the Unity Hub, click on your Project and open it with the 2021.3.x LTS version of Unity. If the Unity Hub can't find a matching Editor version for the Project, it displays a warning message asking you to download that version.

Download the plugin

The ArcGIS Maps SDK for Unity is delivered as a package in a tarball file format. The download is available on the download area in ArcGIS Developer site.

To download the ArcGIS Maps SDK for Unity:

  1. Have an ArcGIS Developer account or ArcGIS Online account. If you don't have an account, sign up for free.

  2. Sign in to your ArcGIS account and go to the download area.

  3. Find ArcGIS Maps SDK for Unity from the left side menu and click on it.

  4. Click on the button to download the plugin and save it somewhere convenient.

Install the plugin

You can install the plugin via the Unity Package Manager.

  1. Open the project in the Editor where you want to import the package.

  2. In the top menu, click on Window > Package Manager to open the Package Manager window.

    Unity's Package Manager

  3. Click on the + icon in the Package Manager window.

  4. Select Add package from tarball from the list and bring up a file browser.

    Add package from tarball

  5. Navigate to the folder where you saved your tarball file.

With the plugin installed, you can find the ArcGIS Maps SDK folder under the Packages section in the Project window. See Unity's Package Manager for more information about the Package Manager and how it works.

Convert the project to URP or HDRP

The ArcGIS Maps SDK for Unity requires a minimum of the Universal Render Pipeline (URP) 12.x package or the High Definition Render Pipeline (HDRP) 12.x package. (The Legacy built-in render pipeline is not supported.) If your project is currently configured to use the Legacy render pipeline, you will need to convert the project to use either URP or HDRP.

To convert:

  1. Open the Package Manager by clicking on Window > Package Manager from the top menu and select Unity Registry from the package drop-down menu.

    Package Manager

  2. Find Universal RP or High Definition RP to install.

  3. Click the Install button.

    Required packages

For more information on upgrading a project to HDRP see Converting a Project from the Built-in Renderer to the High Definition Render Pipeline.

For more information on upgrading a project to URP see Upgrading your Shaders.

Manage locations of existing contents

To allow your project's existing game objects to track within an ArcGIS Map with geographic coordinates, you can add an ArcGIS Location component.

To position your project's existing game objects in real world locations, you can add an ArcGIS Location component. You can search for it in the project folder.

If you are going to develop an app with the C# API, make sure game objects with the ArcGIS Location component are children of the game object that contains the ArcGIS MapView component.

If you select the Map Creator UI or components development option in order to use an ArcGIS Location component:

  1. Click on the game object in the Hierarchy window and click Add Component to select ArcGIS Location component to add the script. For more information on components see Unity's documentation: Use components.

    ArcGIS Location component

  2. Select the game object and set the initial position and rotation of the game object in the Inspector.

    • X (Longitude) : Specifies the east–west position of the Actor on the Earth's surface. A projected position value for projected coordinate systems or a longitude value for geographic coordinate systems.
    • Y (Latitude) : Specifies the north–south position of the Actor on the Earth's surface. A projected position value for projected coordinate systems or a latitude value for geographic coordinate systems.
    • Z (Altitude): Sets the vertical distance of the Actor above the Earth. The units depend on the spatial reference.
    • Spatial Reference WKID: Well-known ID (WKID) of the spatial reference for the X, Y and Z values.
    • Heading: Sets the heading or up axis of the Actor. This is also known as yaw or azimuth. It represents the number of degrees by which the game object will be rotated, measured counterclockwise from the north. To rotate clockwise, use a negative value.
    • Pitch: Sets the pitch or right axis of the Actor. Pitch is the equivalent of moving a plane's nose up or down (rotating along the axis that passes through the plane's wings). Positive values, looking forward, are above the horizon (pointing upward) and negative values are below the horizon (pointing downward).
    • Roll: Sets the roll or forward axis of the Actor. Roll is the equivalent of tilting a plane's wings up or down (rotating along the axis that passes through the center of the plane from front to back). A zero value is perfectly horizontal. Positive values will tilt the left side upward (or right side downward). Negative values do the opposite.
Learn more about the ArcGIS Location component

Import sample assets

ArcGIS Maps SDK for Unity comes with additional samples and tools that can be used to add functionality and visual fidelity to your scene.

To import sample assets that comes with the plugin:

  1. In the top menu, click on Window > Package Manager to open the Package Manager window.

  2. Select ArcGIS Maps SDK for Unity from the list on the left side.

  3. Click on Samples on the right side panel to expand the section.

  4. Click on the Import button next to All Samples.

    Import sample assets

When the sample assets are imported to the project, you can find the folder and its content under Assets > Samples in the Project window.

Samples folder

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.