MicrosoftGame.config 要素 - Executable
特定の実行可能ファイルの詳細を指定します。このセクションの属性には、実行可能ファイルの名前 (Name)、対象デバイス (TargetDeviceFamily)、アプリケーション ID (Id)、開発専用の実行可能ファイルかどうか (IsDevOnly)、ShellVisuals ノードの表示名をオーバーライドするかどうか (OverrideDisplayName)、ShellVisuals ノードの Logo をオーバーライドするかどうか (OverrideLogo)、ShellVisuals ノードの Square480x480Logo をオーバーライドするかどうか (OverrideSquare480x480Logo)、ShellVisuals ノードの Square44x44Logo をオーバーライドするかどうか (OverrideSquare44x44Logo)、ShellVisuals ノードの SplashScreenImage をオーバーライドするかどうか (OverrideSplashScreenImage)、そして実行可能ファイルにエイリアスがあるかどうか (現在は Desktop のみ) が含まれます。親要素
この要素の親は ExecutableList 要素です。要件
この要素の設定は必須です。プラットフォーム
この要素は PC および Console に関係します。動作
- 属性は次のとおりです:
- Name
- TargetDeviceFamily
- Architecture
- Id
- IsDevOnly
- OverrideDisplayName
- OverrideLogo
- OverrideSquare480x480Logo
- OverrideSquare44x44Logo
- OverrideSplashScreenImage
- Alias
- 既定値は次のとおりです:
- Name 属性には既定値はありません。
- TargetDeviceFamily 属性の既定値は、タイトルを実行しているデバイスです。
- Architecture の既定値は x64 です。
- Id 属性の既定値は Name 属性に基づきます。Name 属性から有効な Id を生成できない場合は、フォールバックとして Game0 が使用されます。
- IsDevOnly 属性の既定値は false です。
- OverrideDisplayName 属性の既定値は、ShellVisuals の対応する属性です。
- OverrideLogo 属性の既定値は、ShellVisuals の対応する属性です。
- OverrideSquare480x480Logo 属性の既定値は、ShellVisuals の対応する属性です。
- OverrideSquare44x44Logo 属性の既定値は、ShellVisuals の対応する属性です。
- OverrideSplashScreenImage 属性の既定値は、ShellVisuals の対応する属性です。
- Alias には既定値はありません。
- 使用できる値:
- Name の値は、ゲーム ルートからの相対パスで指定される実行可能ファイルです。
- TargetDeviceFamily の値は XboxOne、Scarlett、PC です。
- Architecture の値は x64 および ARM64 です。
- Id の値は最大 64 文字の ASCII 文字列です。
- IsDevOnly の値は true または false です。
- OverrideDisplayName の値は最大 256 文字の文字列です。
- OverrideLogo の値は .png ファイルへの相対ファイル パスです。
- OverrideSquare480x480Logo の値は .png ファイルへの相対ファイル パスです。
- OverrideSquare44x44Logo の値は .png ファイルへの相対ファイル パスです。
- OverrideSplashScreenImage の値は .png ファイルへの相対ファイル パスです。
- Alias の値は実行可能ファイル名です (Name と同じですが、パスは含められません)。
解説
- Name 属性は必須です。
- TargetDeviceFamily 属性はパッケージ化に必須です。
- Architecture = ARM64 の実行可能ファイルを含める場合は、Architecture = x64 の実行可能ファイルも必ず含める必要があります。x64 バイナリを含めない場合、パッケージのビルドはエラー 0x89245212 E_GAMEPACKAGE_CONFIG_x64_EXECUTABLE_REQUIRED で失敗します。
Executable と TargetDeviceFamily
Executable 要素は、タイトルの実行可能ファイルの属性を設定することを目的としています。この要素は DLC パッケージの構成には適用されません。 開発中、ExecutableList 要素内では、ルース ファイル展開のために任意の数の Executable 要素を定義できます。最終パッケージ提出前のパッケージ化では、複数の Executable 要素がサポートされ、IsDevOnly 属性を持つ任意の数の実行可能ファイル要素がパッケージに含まれます。 ただし、マスタリングおよび認定のための最終パッケージ提出時には、IsDevOnly 属性を持つ実行可能ファイルは、MicrosoftGame.config ファイルおよびパッケージ内容から手動で削除する必要があります。2024 年 3 月の GDK 以前は、isDevOnly の実行可能ファイルは暗号化されたパッケージ生成の一部として (MakePkg.exe pack /lk または /l で署名) 自動的に除去されていました。Submission Validator は、isDevOnly の実行可能ファイルが見つかった場合、引き続き FAILURE を発行します。 ExecutableList 要素内で Executable 要素を指定する場合、TargetDeviceFamily という属性を指定できます。これは、実行可能ファイルがビルドされた対象デバイスを指定することを目的としています。TargetDeviceFamily 属性の許可される値は XBOX One、Scarlett、PC です。 XBOX コンソール向けに MakePkg pack を実行した際に、いずれの Executable にも TargetDeviceFamily 属性が定義されていない場合、パッケージ化は既定で XboxOne TargetDeviceFamily になります。MakePkg pack に /pc フラグを指定した場合、いずれの Executable にも TargetDeviceFamily 属性が定義されていない場合、パッケージ化は既定で PC TargetDeviceFamily になります。MakePkg.exe は、タイトルのパッケージを適切に生成するため、MicrosoftGame.config 内のすべての実行可能ファイルが同じ TargetDeviceFamily 指定を使用することを要求します。ExecutableList 要素に 2 つ以上の TargetDeviceFamily 属性が存在する状態で MakePkg.exe を実行しようとすると、次のエラーが表示されます。 Error: All executables must have the same value for TargetDeviceFamily in the MicrosoftGame.config file when building a package. (found XboxOne and Scarlett)ExecutionAlias
Executable 要素の Alias 属性を使用すると、コマンド プロンプトからエイリアス名を用いて PC タイトルを起動し、タイトル ID を維持したまま実行できる ExecutionAlias 機能を利用できます。 エイリアスを使用する際、タイトルが登録され、ID が正しく機能するようにするために、Alias 属性は実行可能ファイル名に設定する必要があります。実行可能ファイルの現在のディレクトリでエイリアスを使用した場合、Windows はエイリアスではなく実行可能ファイル名を優先するため、このシナリオでは登録および正しい ID の利点は機能しません。実行可能ファイルの現在のディレクトリがローカル PC の %PATH% 環境変数に含まれている場合も、エイリアスではなく実行可能ファイルが優先されます。 コマンド プロンプトで実行可能ファイルのエイリアスを実行する場合、<ExecutionAlias> [launch args] の形式でタイトルの引数を渡すことができます。
PC でのタイトル起動の詳細については、「Microsoft Game Development Kit ツールを利用して PC タイトルをインストールおよび起動する」を参照してください。