Requirements and installation

Understand the system requirements and installation instructions to set up the Microsoft GDK API package.

Requirements

Understand the system requirements before you install the Microsoft GDK package for Unity (com.unity.microsoft.gdk).

Microsoft GDK

To use the package, you must install Microsoft Game Development Kit (GDK). For more information, refer to Game Development Kit (GDK) documentation.

Unity Editor requirements

It’s recommended to use the latest version of the editor stream you're currently using. This package is supported from Unity Editor version 2021.3 and newer.

Note

The Microsoft GDK API package is supported only on Unity Editor for Windows.

Install the Microsoft GDK API package

To install the Microsoft GDK API package, follow the instructions in the Package Manager documentation.

It’s recommended to use the GDK Tools package (com.unity.microsoft.gdk.tools) along with the Microsoft GDK API package (com.unity.microsoft.gdk). The GDK Tools package manages the additional steps needed to produce a working build. Without this package, you are responsible for ensuring everything is in place to produce a functional build.

The provided samples require the use of the Unity Input system package.

Supported features

The Microsoft GDK API package provides:

  • Managed C# wrappers providing access to the native Microsoft GDK API.
  • A set of samples to introduce you to different Microsoft GDK API services.

Support and licensing

Refer to the following files included with the package: