GDK project workflow

Use the following workflow to learn how to use the GDK Tools package to build a project for the Windows platform.

Note

When targeting Standalone Windows, only 64-bit Windows is supported.

To set up and build a project using the GDK Tools package, complete the following tasks:

Create a GDK Settings asset

Your project must include an activated GDK Settings asset. Use the following steps to create and activate the GDK Settings asset:

  1. Create a new Unity project.
  2. In the main menu, go to Assets > Create > GDK > GDK Settings. This creates a GDKSettings.asset file in the root of your Assets folder. You can rename this file if needed.
  3. In the Project window, locate your newly created GDKSettings.asset file and double-click to activate it.

Create a Microsoft game configuration file

To create a Microsoft game configuration file, use the following steps:

  1. In the main menu, go to Assets > Create > GDK > Microsoft Game Config.
    • This creates a basic MicrosoftGameConfig.mgc file in the root of your Assets folder.
  2. Configure this asset to meet your specific requirements before your GDK project can be fully functional.
Note

If you are using the GDK API package, you can import a .mgc asset from the samples provided within the package.

Configure the GDK Settings

Configure the GDK Settings for the target platform, Windows, using the following steps:

  1. In the main menu, go to Edit > Project Settings > Microsoft GDK.
  2. Select Add Target GDK Settings.
  3. Enable Build for Microsoft GDK.
  4. Set Microsoft Game Config to the Microsoft Game configuration asset created earlier.

Build your project

When you build your project, the Microsoft GDK Tools package runs the additional steps required during the build process. This includes generating shell visuals resources required to localize your game splash screen, logo, and in-game text. For more information on configuring localization, refer to Localize your application. Make sure you configure the Microsoft Game Configuration file correctly per your requirements.

Additional resources