Integrate the GDK with a pre-4.26 Unreal Engine project

​

Using an earlier version of Unreal Engine (prior to version 4.26)

​

Add headers and import libraries for Gaming Runtime and XSAPI

1. Find the build file for your Unreal project: /Source/(ProjectName)/(ProjectName).Build.cs
2. Add the line below to define the _GAMING_DESKTOP macro
       PublicDefinitions.Add("_GAMING_DESKTOP");  // For Unreal 4.12 or earlier, use "Definitions.Add()" instead
   
3. Add the following include paths
       // Add the include path for Gaming Runtime
       PublicIncludePaths.Add(@"C:\Program Files (x86)\Microsoft GDK\241000\GRDK\GameKit\Include");
       // Add the include path for XSAPI
       PublicIncludePaths.Add(@"C:\Program Files (x86)\Microsoft GDK\241000\GRDK\ExtensionLibraries\Xbox.Services.API.C\Include");
   

For Microsoft GDK (June 2024) or earlier use: C:\Program Files (x86)\Microsoft GDK\230300\GRDK\ExtensionLibraries\Xbox.Services.API.C\DesignTime\CommonConfiguration\Neutral\Include

1. Add the following library paths for the import libraries
       // Add the import library for Gaming Runtime
       PublicAdditionalLibraries.Add(@"C:\Program Files (x86)\Microsoft GDK\241000\GRDK\GameKit\Lib\amd64\xgameruntime.lib");
       // Add the import library for XSAPI
       PublicAdditionalLibraries.Add(@"C:\Program Files (x86)\Microsoft GDK\241000\GRDK\ExtensionLibraries\Xbox.Services.API.C\Lib\Release\Microsoft.Xbox.Services.142.GDK.C.Thunks.lib");
   

For Microsoft GDK (June 2024) or earlier use: C:\Program Files (x86)\Microsoft GDK\230300\GRDK\ExtensionLibraries\Xbox.Services.API.C\DesignTime\CommonConfiguration\Neutral\Lib\Release\Microsoft.Xbox.Services.141.GDK.C.Thunks.lib

​

Access Gaming Runtime and XSAPI from C++ code files

1. Determine where you would like to add the integration for things like sign-in and unlocking achievements
2. Add headers for Gaming Runtime and XSAPI
       // When using Unreal Engine 4.15 or later
       THIRD_PARTY_INCLUDES_START
       
       #include "XGameRuntimeInit.h" // For Gaming Runtime 
       #include "xsapi-c\services_c.h"  // For XSAPI
       // When using Unreal Engine 4.15 or later
       THIRD_PARTY_INCLUDES_END
   
3. Integrate with service calls. See examples below:

• How to: best practice to sign in a user
• Updating title-managed Achievements

​

Creating a product in Partner Center

​

Create a MicrosoftGame.config file for your game

​

Create and register your game package

1. Access the packaging dialog box by selecting File > Package Project > Windows > Windows (64-bit).
2. Choose a folder for the build output from the File Explorer dialog box, and then select Select Folder.
3. Launch your game with wdapp.
       wdapp launch {full path to the game's executable in the same directory containing the MicrosoftGame.Config file}
   
4. Alternatively, you can register the package with wdapp and then launch the game from Start menu.
       wdapp register {full path to the directory containing the MicrosoftGame.Config file}
   

​

See also