Visual Studio でリモート Windows デバイス上の PC プロジェクトをデバッグする

XBOX PC Toolbox アプリはプレビュー版です。Windows 上の Microsoft Store からダウンロードしてください。

XBOX PC Remote Tools には、リモート Windows デバイス上で実行されているゲームに Visual Studio 2022 デバッガーをアタッチする機能が含まれています。開発 PC とリモート Windows デバイス間のデバッグトラフィックはすべて暗号化されます。デバッガーをアタッチする機能は、公開の Visual Studio Marketplace で入手できる Visual Studio 2022 拡張機能によって提供されます。デバッグを行う前に、クイックスタートガイドで説明されている手順を使用して、開発 PC とリモート Windows デバイスをプロビジョニングしてペアリングする必要があります。ペアリングとプロビジョニングが完了したら、Visual Studio の拡張機能マネージャーを使用して XBOX PC Remote Debugger 拡張機能をダウンロードします。ペアリングとプロビジョニングが完了したら、Visual Studio の拡張機能マネージャーを使用して XBOX PC Remote Debugger 拡張機能をダウンロードします。

ゲームのプロジェクトで F5 でのデプロイおよびデバッグを有効にする

Visual Studio 用の XBOX PC Remote Debugger 拡張機能は、リモート Windows デバイス上での C++ プロジェクトのデプロイおよびデバッグの完全な「F5」統合をサポートしています。F5 キーを押すと、プロジェクトがビルドされ、必要に応じてリモートデバイスにデプロイされ、ゲームが一時停止状態で起動され、XBOX PC Remote Debugger がアタッチされ、その後デバッガー配下でゲームが再開されます。 XBOX PC Remote Debugger Visual Studio 拡張機能をインストールした後、F5 リモートデプロイおよびデバッグを使用する前に、次のことを確認してください。

クイックスタートガイドで説明されている手順を使用して、開発 PC とリモート Windows デバイスがプロビジョニングされ、ペアリングされている必要があります。
Microsoft Visual Studio Debug Monitor (MSVSMON.EXE) がリモートデバイスにインストールされている必要があります。MSVSMON.EXE は、XBOX PC Toolbox アプリケーションによって自動的にインストールされます。あるいは、リモートデバイス上の管理者プロンプトから WinGet を使用してインストールすることもできます。

   winget install Microsoft.VisualStudio.2022.OnecoreMsvsmon

リモートデバイス上で wdEndpoint.exe が実行されている必要があります。wdEndpoint.exe は、XBOX PC Toolbox アプリケーションによって自動的にインストールされて開始されます。あるいは、リモートデバイス上のコマンドプロンプトから WinGet を使用してインストールすることもできます。

   winget install Microsoft.Gaming.RemoteIterationEndpoint

WinGet を通じてインストールした後は、wdEndpoint.exe を手動で開始してください。

MSBuild プロジェクトへの F5 リモートデバッグサポートの追加

MSBuild を使用するプロジェクトで F5 統合を有効にするには、次の XML を .vcxproj ファイルに追加します。最後の </ItemDefinitionGroup> 要素の後、ソースファイルの <ItemGroup> セクションの前に配置します。

<ItemGroup>
  <ProjectCapability Include="Gaming.Xbox.PC.Remote" />
</ItemGroup>
<Import Condition="'$(XboxPCRemotePath)'!='' AND Exists('$(XboxPCRemotePath)XboxPCcppDebugger.props')"
  Project="$(XboxPCRemotePath)XboxPCcppDebugger.props" />
<ItemGroup>
  <PropertyPageSchema Condition="'$(XboxPCRemotePath)'!=''" Include="$(XboxPCRemotePath)XboxPCcppDebugger.xml" />
</ItemGroup>

最新バージョンの Microsoft GDK テンプレートでは、新しいプロジェクトを作成する際にこの統合を含めるかどうかを確認するメッセージが表示されます。

デプロイを有効にするには、[プロジェクト] > [プロパティ] > [構成マネージャー] に移動し、目的の構成の [デプロイ] オプションをオンにします。 F5 キーを押す前に、デバッグツールバーまたはプロジェクトのプロパティページを使用して、デバッガーを [XBOX PC Remote Debugger] に設定します。デプロイとデバッグを構成するために、いくつかのプロパティが用意されています。

Remote Command Arguments。ゲームに渡すコマンド引数のリスト。
Deployment Directory。リモート Windows デバイスにデプロイする開発 PC 上のディレクトリ。既定は $(Outdir) です。
Remote Folder。リモート Windows デバイス上でゲームがデプロイされるフォルダー。フォルダーは Common Root を基準とした相対パスです。Common Root の詳細については、wdEndpoint.exe のトピックを参照してください。
Remote EndPoint Name。標準の Windows リモートデバッグと同様に、既定のリモートデバイスは開発者マシン自身です。wdEndpoint.exe が実行されているデバイス名に Remote EndPoint Name を更新してください。
File filter for deployment。デプロイから除外するファイルセットを指定します。たとえば、.pdb ファイルをデプロイから除外することは一般的な慣行です。除外するファイルパターンのリストをセミコロンで区切って指定します (例: *.pdb;*.ipdb;*.iobj;*.obj;*.pch;*)。

[構成] の [デプロイ] チェックボックスをオンにし、デバッガーの種類として [XBOX PC Remote Debugger] を選択し、プロパティを入力した後、F5 キーを押すと、ゲームがビルドされ、リモート Windows デバイスにデプロイされ、デバッガー配下で起動されます。

Visual Studio がゲームのシンボルを見つけられるように、シンボルパスの構成が必要な場合があります。[ツール] メニューからアクセスできる [オプション] ダイアログの [デバッグ] 設定を使用して構成してください。

F5 リモートデバッガーのプロジェクトごとの既定値

XBOX PC Remote Debugger 設定の既定値は XboxPCcppDebugger.props ファイルによって設定され、Visual Studio プロジェクトのプロパティダイアログで設定に加えた編集はローカルマシンに「ユーザーごと」に保存されます。各ユーザーがマシン上で設定しなくても済むように、vcxproj で別の既定値を提供するには、次のように MSBuild に追加します。

<ItemGroup>
  <ProjectCapability Include="Gaming.Xbox.PC.Remote" />
</ItemGroup>
<Import Condition="'$(XboxPCRemotePath)'!='' AND Exists('$(XboxPCRemotePath)XboxPCcppDebugger.props')"
  Project="$(XboxPCRemotePath)XboxPCcppDebugger.props" />
<PropertyGroup>
  <RemoteGameshareFolder>MyGameTitle</RemoteGameshareFolder>
</PropertyGroup>
<ItemGroup>
  <PropertyPageSchema Condition="'$(XboxPCRemotePath)'!=''" Include="$(XboxPCRemotePath)XboxPCcppDebugger.xml" />
</ItemGroup>

Visual C++ ランタイム (CRT) のデプロイ

リモートマシンでプログラムを実行するには、Visual C++ ランタイムファイルが必要です。小売 CRT については、リモートマシンに Visual C++ REDIST パッケージをインストールすることでこれを行えます。デバッグ CRT については、これらのファイルをタイトルと一緒にデプロイする必要があります。 MSBuild でのシンプルな解決策は、プロジェクトの Global セクションに次のプロパティを追加することです。

<CopyCppRuntimeToOutputDir>true</CopyCppRuntimeToOutputDir>

これにより、Visual C++ CRT が OutDir にコピーされます。UseDebugLibraries が true に設定されている場合はデバッグ版が使用され、それ以外の場合は Retail 版が使用されます。

CMake プロジェクトへの F5 リモートデバッグサポートの追加

Open Folder プロジェクト (CMake プロジェクトなど) の場合、F5 リモートデバッグのサポートは .vcxproj ファイルではなく launch.vs.json で構成します。

XBOX PC Remote Debugger サポートをインストールし、リモート Windows デバイスがプロビジョニングされて wdEndpoint.exe が実行されていることを確認します。
Visual Studio で CMake プロジェクトフォルダーを開きます。
[ソリューションエクスプローラー] で [CMakeLists.txt] を右クリックし、[デバッグ構成の追加…] を選択します。
[XBOX PC Remote Debugger Folder] を選択します。

Visual Studio は、Xbox PC Remote Debugger の起動構成を含む .vs\launch.vs.json ファイルを作成します。一般的な構成は次のようになります。

   {
     "version": "0.2.1",
     "defaults": {},
     "configurations": [
       {
         "type": "default",
         "name": "MyGame.exe",
         "project": "CMakeLists.txt",
         "projectTarget": "MyGame.exe",
         "deployDirectory": "${workspaceRoot}\\out\\build\\x64-Release\\bin",
         "deployExcludeFilter": "*.pdb;*.ipdb;*.iobj;*.obj;*.pch;*.ilk;*.exp;*.lib;*.winmd;*.appxrecipe;*.log;*.tlog;*unsuccessfulbuild;*.lastbuildstate;*.copycomplete",
         "remoteGameshareFolder": "MyGame",
         "remoteMachineName": "MyROGAlly",
         "targetName": "MyGame.exe",
         "args": [],
         "deployType": "GamingXboxPCRemoteDeploy"
       }
     ]
   }

生成された構成の次のプロパティの値を更新します。
- deployDirectory。デプロイするファイルを含むローカルの出力フォルダー。
- remoteGameshareFolder。リモートデバイス上で作成または使用するフォルダー。
- remoteMachineName。wdEndpoint.exe が実行されているリモートデバイスの名前。
- targetName。デプロイ後に起動するゲーム実行可能ファイル。
必要に応じて、次のプロパティを更新します。
- deployExcludeFilter。デプロイから除外するファイルパターンのセミコロン区切りリスト。
- args。ゲームの起動時に渡すコマンドライン引数。
- disableDeploy。デプロイをスキップし、デバッガーでの起動またはアタッチのみを行う場合に設定します。
ゲームをローカルでビルドしてから、デバッガーのツールバーから [CMakeLists.txt] を選択し、F5 キーを押すと、ゲームがリモートデバイスにデプロイされてデバッガー配下で起動されます。

リモート Windows デバイス上で実行されているゲームへの Visual Studio デバッガーのアタッチ

リモートデバイス上で既に実行されているゲームにデバッガーをアタッチするには、Visual Studio の [デバッグ] メニューから [プロセスにアタッチ…] を選択します。[接続の種類] ドロップダウンから [XBOX PC Remote Device] を選択し、[接続先] テキストボックスにリモートデバイスの IP アドレスまたはホスト名を入力します。リモートデバイス上で実行されているプロセスの一覧が表示されます。デバッグしたいゲームを選択し、[アタッチ] ボタンを選択します。

​ゲームのプロジェクトで F5 でのデプロイおよびデバッグを有効にする

​MSBuild プロジェクトへの F5 リモート デバッグ サポートの追加

​F5 リモート デバッガーのプロジェクトごとの既定値

​Visual C++ ランタイム (CRT) のデプロイ

​CMake プロジェクトへの F5 リモート デバッグ サポートの追加

​リモート Windows デバイス上で実行されているゲームへの Visual Studio デバッガーのアタッチ

​関連項目

ゲームのプロジェクトで F5 でのデプロイおよびデバッグを有効にする

MSBuild プロジェクトへの F5 リモートデバッグサポートの追加

F5 リモートデバッガーのプロジェクトごとの既定値

Visual C++ ランタイム (CRT) のデプロイ

CMake プロジェクトへの F5 リモートデバッグサポートの追加

リモート Windows デバイス上で実行されているゲームへの Visual Studio デバッガーのアタッチ

関連項目