カスタム C/C++ エンジンに GDK を統合する

• Partner Center でプロダクトを作成する
• GDK を C/C++ ゲームに統合する
• ゲームで XBOX services をテストする
• 公開

​

Partner Center でプロダクトを作成する

​

GDK を C/C++ ゲームに統合する

1. API のシグネチャとデータ構造を記述する GDK および XBOX Services API (XSAPI) の ヘッダー。
2. GDK のエクスポートされた関数への外部参照をリンカーが解決できるようにする インポート ライブラリ。
3. XSAPI DLL のエクスポートされた関数への外部参照をリンカーが解決できるようにする XSAPI 静的ライブラリまたは インポート ライブラリ。
   • XSAPI は静的な形と動的な形の両方で利用できます。詳細については以下の表を参照し、静的または動的のいずれかを選択してください。
4. GDK および XSAPI 関数の実行時実装を実際に含む ダイナミック リンク ライブラリ（XSAPI の動的版を利用する場合）。

​

Gaming Runtime Services と XSAPI の要件をプロジェクトに追加する

1. x64 をターゲットにしていることを確認してください。Visual Studio では Build -> Configuration Manager で Active solution platform を x64 に設定します。
2. 次のインクルード パスを追加します: C:\Program Files (x86)\Microsoft GDK\[GDK version number]\GRDK\GameKit\Include C:\Program Files (x86)\Microsoft GDK\[GDK version number]\GRDK\ExtensionLibraries\Xbox.Services.API.C\Include C:\Program Files (x86)\Microsoft GDK\[GDK version number]\GRDK\ExtensionLibraries\Xbox.LibHttpClient\Include GDK version number は、リリースの年、月、サブバージョン番号でディレクトリ名になります。たとえば June 2022 GDK ならディレクトリ名は 220600 です。Microsoft GDK (June 2024) 以前では、C:\Program Files (x86)\Microsoft GDK\[GDK version number]\GRDK\ExtensionLibraries\Xbox.Services.API.C\DesignTime\CommonConfiguration\Neutral\Include と C:\Program Files (x86)\Microsoft GDK\[GDK version number]\GRDK\ExtensionLibraries\Xbox.LibHttpClient\DesignTime\CommonConfiguration\Neutral\Include を使用してください。Visual Studio では、プロジェクトのプロパティ ページの Configuration Properties -> VC++ Directories -> Include Directories でこれらのパスを追加します。
3. インポート ライブラリ用に次のライブラリ パスを追加します: C:\Program Files (x86)\Microsoft GDK\[GDK version number]\GRDK\GameKit\Lib\amd64 C:\Program Files (x86)\Microsoft GDK\[GDK version number]\GRDK\ExtensionLibraries\Xbox.Services.API.C\Lib\x64\Release C:\Program Files (x86)\Microsoft GDK\[GDK version number]\GRDK\ExtensionLibraries\Xbox.LibHttpClient\Lib\x64 GDK version number は、リリースの年、月、サブバージョン番号でディレクトリ名になります。たとえば June 2022 GDK ならディレクトリ名は 220600 です。Microsoft GDK (June 2024) 以前では、C:\Program Files (x86)\Microsoft GDK\[GDK version number]\GRDK\ExtensionLibraries\Xbox.Services.API.C\DesignTime\CommonConfiguration\Neutral\Lib\Release と C:\Program Files (x86)\Microsoft GDK\[GDK version number]\GRDK\ExtensionLibraries\Xbox.LibHttpClient\DesignTime\CommonConfiguration\Neutral\Lib を使用してください。Visual Studio では、プロジェクトのプロパティ ページの Configuration Properties -> VC++ Directories -> Library Directories でこれらのパスを追加します。
4. プロジェクトにリンクされるライブラリのリストに次のライブラリを追加します: C:\Program Files (x86)\Microsoft GDK\[GDK version number]\GRDK\GameKit\Lib\amd64\xgameruntime.lib C:\Program Files (x86)\Microsoft GDK\[GDK version number]\GRDK\ExtensionLibraries\Xbox.Services.API.C\Lib\x64\Release\Microsoft.Xbox.Services.GDK.C.Thunks.lib (または静的にリンクする場合は Microsoft.Xbox.Services.142.GDK.C.lib) C:\Program Files (x86)\Microsoft GDK\[GDK version number]\GRDK\ExtensionLibraries\Xbox.LibHttpClient\Lib\x64\libHttpClient.GDK.lib GDK version number は、リリースの年、月、サブバージョン番号でディレクトリ名になります。たとえば June 2022 GDK ならディレクトリ名は 220600 です。Microsoft GDK (June 2024) 以前では、C:\Program Files (x86)\Microsoft GDK\[GDK version number]\GRDK\ExtensionLibraries\Xbox.Services.API.C\DesignTime\CommonConfiguration\Neutral\Lib\Release\Microsoft.Xbox.Services.GDK.C.Thunks.lib (または静的にリンクする場合は Microsoft.Xbox.Services.142.GDK.C.lib) と C:\Program Files (x86)\Microsoft GDK\[GDK version number]\GRDK\ExtensionLibraries\Xbox.LibHttpClient\DesignTime\CommonConfiguration\Neutral\Lib\libHttpClient.GDK.lib を使用してください。Visual Studio では、プロジェクトのプロパティ ページの Configuration Properties -> Linker -> Input -> Additional Dependencies でライブラリを追加します。
5. _GAMING_DESKTOP と WINAPI_FAMILY=WINAPI_FAMILY_DESKTOP_APP を定義します。Visual Studio では、プロジェクトのプロパティ ページの C/C++ -> Command Line -> Additional Options に次の行を追加します: /D "_GAMING_DESKTOP" /D "WINAPI_FAMILY=WINAPI_FAMILY_DESKTOP_APP"
6. MicrosoftGame.config ファイルを作成し、ビルド時に .exe と同じ場所にコピーされるようにしてください。注意: エンジンが実行時に異なる .exe を使用するエディター内実行機能をサポートしている場合、MicrosoftGame.config が該当する .exe と同じディレクトリにもコピーされるようにする必要があります。MicrosoftGame.config が .exe と同じディレクトリにない場合、エディター内実行機能を使用するときに XBOX services が動作しません。開発の開始には、次の例のようなデフォルト値の config を使用できます。Identity Name、Executable Name、Executable Alias の値はすべて実行ファイルの名前に置き換えてください。
   <?xml version="1.0" encoding="utf-8"?>
   <Game configVersion="1">
   <Identity Name="Direct3DGame1_test"
               Publisher="CN=Publisher"
               Version="1.0.0.0"/>
   <ExecutableList>
       <Executable Name="Direct3DGame1_test.exe"
                   Id="Game"
                   Alias="Direct3DGame1_test.exe"/>
   </ExecutableList>
   <ShellVisuals DefaultDisplayName="Direct3DGame1_test"
                   PublisherDisplayName="PublisherName"
                   Square480x480Logo="LargeLogo.png"
                   Square150x150Logo="GraphicsLogo.png"
                   Square44x44Logo="SmallLogo.png"
                   Description="Direct3DGame1_test"
                   ForegroundText="light"
                   BackgroundColor="#000040"
                   SplashScreenImage="SplashScreen.png"
                   StoreLogo="StoreLogo.png"/>
   </Game>
   
7. Microsoft.Xbox.Services.GDK.C.Thunks.dll（動的にリンクする場合）、XCurl.dll、libHttpClient.GDK.dll のコピーが、ビルド時に .exe と同じ場所にコピーされることを確認してください。注意: エンジンが実行時に異なる .exe を使用するエディター内実行機能をサポートしている場合、その .exe もこれらの .dll を参照するようにする必要があります。.exe から .dll が参照されないと、エディター内実行機能を使用するときに XBOX services が動作しません。XSAPI に動的にリンクする場合、Microsoft.Xbox.Services.GDK.C.Thunks.dll は GDK インストールの次のディレクトリにあります: C:\Program Files (x86)\Microsoft GDK\[GDK version number]\GRDK\ExtensionLibraries\Xbox.Services.API.C\Lib\x64\[Debug|Release] XCurl.dll は GDK インストールの次のディレクトリにあります: C:\Program Files (x86)\Microsoft GDK\[GDK version number]\GRDK\ExtensionLibraries\Xbox.XCurl.API\Redist\x64 libHttpClient.GDK.dll は GDK インストールの次のディレクトリにあります: C:\Program Files (x86)\Microsoft GDK\[GDK version number]\GRDK\ExtensionLibraries\Xbox.LibHttpClient\Redist\x64 GDK version number は、リリースの年、月、サブバージョン番号でディレクトリ名になります。たとえば June 2022 GDK ならディレクトリ名は 220600 です。Microsoft GDK (June 2024) 以前では、C:\Program Files (x86)\Microsoft GDK\[GDK version number]\GRDK\ExtensionLibraries\Xbox.Services.API.C\DesignTime\CommonConfiguration\Neutral\Lib\[Debug|Release]、C:\Program Files (x86)\Microsoft GDK\[GDK version number]\GRDK\ExtensionLibraries\Xbox.XCurl.API\Redist\CommonConfiguration\neutral、および C:\Program Files (x86)\Microsoft GDK\[GDK version number]\GRDK\ExtensionLibraries\Xbox.LibHttpClient\Redist\CommonConfiguration\neutral を使用してください。

​

MicrosoftGame.config を更新する

1. Partner Center dashboard に移動します。
2. プロダクトのリストからゲームを選択します。
3. Game setup タブを選択し、次に Identity details を選択します。
4. Show Details を選択して Identity details セクションを展開します。
5. Identity details セクションの表から次の値を使用し、それらの値を Partner Center から MicrosoftGame.config の対応する要素とフィールドにコピーします。

<?xml version="1.0" encoding="utf-8"?>
<Game configVersion="1">

  <Identity Name='41336MicrosoftATG.Achievements2017Redux' Version="1.1.0.0" Publisher='CN=A4954634-DF4B-47C7-AB70-D3215D246AF1' />


  <TitleId>64353034</TitleId>
  <MSAAppId>0000000000000000</MSAAppId>

  <ExecutableList>
    <Executable Name="Achievements2017_desktop.exe"
                TargetDeviceFamily="PC"
                Id="Game"/>
  </ExecutableList>

  <ShellVisuals DefaultDisplayName="Achievements2017 Desktop Sample"
                PublisherDisplayName="Xbox Advanced Technology Group"
                StoreLogo="Assets\StoreLogo.png"
                Square150x150Logo="Assets\Logo.png"
                Square44x44Logo="Assets\SmallLogo.png"
                Square480x480Logo="Assets\LargeLogo.png"
                Description="Achievements2017"
                ForegroundText="dark"
                BackgroundColor="#000000"
                SplashScreenImage="Assets\SplashScreen.png"/>
</Game>

​

ゲーム ランタイムと XSAPI を初期化する

1. XGameRuntime ヘッダーと XSAPI services-c ヘッダーをインクルードします。
   #include <XGameRuntime.h>
   #include <xsapi-c/services_c.h>
   
2. XGameRuntimeInitialize を呼び出して GDK ランタイムを初期化します。
   // Initialize the GameRuntime
   HRESULT hr = XGameRuntimeInitialize();
   if (FAILED(hr))
   {
       if (hr == E_GAMERUNTIME_DLL_NOT_FOUND || hr == E_GAMERUNTIME_VERSION_MISMATCH)
       {
           (void)MessageBoxW(nullptr, L"Game Runtime is not installed on this system or needs updating.", g_szAppName, MB_ICONERROR | MB_OK);
       }
       return 1;
   }
   
3. XblInitialize を呼び出して XSAPI を初期化します。
    XblInitArgs xblArgs = {};
    //xblArgs.queue = queue; // 独自の XTaskQueue を作成した場合は、この行のコメントを外してください。それ以外の場合、デフォルトではこの行は不要です。
    xblArgs.scid = "00000000-0000-0000-0000-000000000000"; // Partner Center プロジェクトの scid をここに追加してください;
    HRESULT hr = XblInitialize(&xblArgs);
    if (FAILED(hr))
    {
        // 失敗を処理する
    }
   

​

ゲーム ランタイムを解放する

 // 他のすべてのアクティビティが完了した後で
 // Gaming Runtime を解放する。
 XGameRuntimeUninitialize();

​

ゲームで XBOX services をテストする

​

テスト アカウントを作成する

​

サンドボックスを切り替える

1. サンドボックス ID を確認するには、Partner Center に移動します。
2. XBOX services を選択し、次に Gameplay Settings を選択します。
   サンドボックス ID は最初のタブにあり、「ABCDEF.0」のような名前になっています。
3. Start メニューを開きます。
4. Microsoft GDK Command Prompts と入力し、キーボードの Enter を選択します。
5. 最初のコマンド プロンプトを開きます。
6. コマンド プロンプトで XblPCSandbox.exe [サンドボックス ID] と入力します。
7. コマンド プロンプトがいくつかのアプリを起動したら、XBOX アプリにテスト アカウントでサインインします。

​

公開

• ゲームと GDK の統合を完了していること
• Getting started with packaging titles for a PC by using the MSIXVC packaging tools の手順に従ってゲーム パッケージを作成していること