Get started

Here's how to get started with the SDK:

  1. Review system requirements
  2. See install and setup instruction and prepare your Unreal Engine project
  3. Get an API key
  4. Set view mode with your preferred scene setting option
  5. Add layers with your preferred scene setting option

1. System requirements

Ensure your development environment meets the system requirements.

For an overview of this release, including enhancements, deprecations, and known issues, see the release notes.

2. Install and setup

The plugin supports Unreal Engine 5 Preview. Older versions are not supported. You have the option to use the plugin in a new project or an existing project, and the plugin provides four options to use ArcGIS data and other geospatial content within a scene: the Modes Panel UI, Components, Blueprints, and the C++ API.

See install and setup for instructions.

3. Get an API key

API keys are required to access ArcGIS services, such as basemaps, geocoding, routing, and others. Visit your dashboard and copy your default API key, or set custom scopes and referrers for your specific needs. Include your API key in the tutorials, samples, and sample apps where required in the instructions.

  1. Log in to your dashboard.
  2. Copy your default API key, or generate a new one.

4. Set view mode

When working with 3D content, you can choose to display your data within one of two different scene environments: global or local. Whether to choose a global or local scene depends on the spatial reference of your data, the layer types, and what you are trying to achieve in your scene.

5. Add layers

Each layer in a map references geographic data, either from an online service or from a local dataset. There are a variety of layers that can be added to a map, each designed to display a particular type of data.

Next steps

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