Qu’est-ce que MicrosoftGame.config?
Chaque jeu distribué par l’intermédiaire du Microsoft Store doit inclure un manifeste qui déclare au minimum l’identité du titre, le nom de l’éditeur et un ensemble d’éléments visuels du shell propres au titre (chaînes, icônes et images) qui servent à afficher le nom du jeu et sa représentation graphique dans le Microsoft Store et le shell (pour la console) ainsi que dans le menu Démarrer, la barre des tâches et d’autres emplacements du shell Windows (pour le PC). De plus, un jeu peut implémenter des fonctionnalités facultatives, comme du contenu téléchargeable (DLC), qui reposent sur des valeurs de configuration également stockées dans le manifeste du jeu. Le nom du fichier manifeste est MicrosoftGame.config.Pourquoi créer un nouveau schéma de manifeste?
Chaque package du Microsoft Store contient un manifeste appelé AppXManifest.xml. Son schéma a évolué au fil de nombreuses années pour prendre en charge un large éventail de fonctionnalités et de scénarios d’application. Avec MicrosoftGame.config, les développeurs de jeux interagissent avec un schéma de manifeste axé sur les jeux plus simple, plus accessible, moins sujet aux erreurs et plus productif. Lorsque le développeur empaquette ou inscrit un jeu, les outils valident le contenu de MicrosoftGame.config et génèrent un fichier AppXManifest.xml bien formé pour le compte du développeur du jeu. LeAppXManifest généré est inclus dans le package obtenu.
Depuis le Microsoft Game Development Kit (GDK) de mars 2022, la valeur configVersion de Game est passée de 0 à 1 pour les nouveaux titres créés avec ce Microsoft Game Development Kit (GDK) et les versions ultérieures. Les titres existants peuvent adopter cette mise à jour de version pour profiter de ces améliorations. Pour plus d’informations, consultez Référence de MicrosoftGame.config (exemple de MicrosoftGame.config et schéma).
Documentation disponible
Dans le fichier de documentation hors ligne du Microsoft Game Development Kit (GDK) (GDK.chm), vous trouverez de la documentation sur MicrosoftGame.config aux emplacements indiqués dans le tableau suivant.Création de MicrosoftGame.config
Lorsque vous créez un nouveau projet pour la plateforme Gaming.Desktop.x64, Gaming.Xbox.XboxOne.x64 ou Gaming.Xbox.Scarlett.x64, un fichier MicrosoftGameConfig.mgc est associé à votre projet dans Visual Studio. Il contient des valeurs par défaut qui permettent un développement précoce sur PC et sur XBOX sans configuration supplémentaire, jusqu’à ce que vous commenciez à utiliser des fonctionnalités du Gaming Runtime, du Microsoft Store et de l’identité du titre. Lorsque votre projet est généré, le fichier MicrosoftGameConfig.mgc est renommé MicrosoftGame.config lorsqu’il est copié dans le répertoire de sortie de votre projet. Voici un exemple de ce fichier MicrosoftGameConfig.mgc par défaut, pour XBOX.Si vous ajoutez manuellement un fichier Microsoftgame.config à votre projet, vous devez vous assurer de modifier les propriétés du fichier pour en faire un type de fichier
copy.Ajout manuel d’un fichier MicrosoftGame.config
Un ou plusieurs fichiers MicrosoftGame.config peuvent également être ajoutés manuellement à votre projet. L’ajout manuel d’un fichier peut se faire de deux façons :- En définissant les propriétés appropriées sur un fichier existant afin que Visual Studio le reconnaisse comme un fichier MicrosoftGame.config.
- En utilisant un modèle d’élément fourni avec le système de projet C++ du Microsoft Game Development Kit (GDK).
- Réglez votre configuration sur la plateforme « Gaming.Xbox.XboxOne.x64 », « Gaming.Xbox.Scarlett.x64 » ou « Gaming.Desktop.x64 ».
- Ajoutez le fichier MicrosoftGame.config de votre jeu en tant que fichier dans votre projet Visual Studio.
- Dans les propriétés du fichier MicrosoftGame.config, réglez Type d’élément sur Microsoft Game Config, comme illustré ci-dessous.
- Cliquez avec le bouton droit sur un projet et sélectionnez Ajouter->Nouvel élément.
- Le modèle MicrosoftGameConfig.mgc se trouve dans le nœud Visual C++->Gaming->Microsoft Game Development Kit->Edition de l’arborescence, comme illustré ci-dessous.
Propriété de projet Visual Studio pour MicrosoftGame.config
Chaque fois qu’un fichier MicrosoftGameConfig.mgc est ajouté à un projet, soit automatiquement lors de la création du projet, soit manuellement, une propriété (MGCCompile) est ajoutée à votre projet Visual Studio. La propriété MGCCompile est utilisée par le système de projet pour automatiser ce qui suit :
- La génération d’un fichier .pri si vous avez des ressources de chaînes localisées
- Le renommage du fichier MicrosoftGameConfig.mgc en MicrosoftGame.config, au besoin
- La copie de votre MicrosoftGame.config dans votre dossier de sortie
- L’inscription de votre MicrosoftGame.config après la génération
- Le lancement de votre jeu avec identité dans le débogueur
Gestion de plusieurs fichiers MicrosoftGameConfig.mgc dans Visual Studio et MSBuild
Un projet Visual Studio du Microsoft Game Development Kit (GDK) peut être associé à plusieurs fichiers MicrosoftGameConfig.mgc. Il est courant d’utiliser différents fichiers MicrosoftGameConfig.mgc pour différentes configurations de génération, ou pour les builds XBOX et PC, par exemple. Si vous utilisiez auparavant une logique de génération personnalisée pour gérer plusieurs fichiers MicrosoftGameConfig.mgc, ce scénario est désormais directement pris en charge par le système de projet. Un fichier MicrosoftGameConfig.mgc peut être attribué à des configurations de génération individuelles de deux façons. Premièrement, la fenêtre d’outil XBOX Gaming Project Control prend en charge la gestion de plusieurs fichiers MicrosoftGameConfig.mgc (rubrique sous NDA), comme illustré ci-dessous.
DefaultApplyTo de la propriété MGCCompile pour spécifier un fichier MicrosoftGameConfig.mgc par défaut. Ce fichier par défaut sera utilisé pour toutes les configurations, sauf s’il est explicitement remplacé. Utilisez l’élément ApplyTo de la propriété MGCCompile pour attribuer un fichier de configuration à une configuration de génération particulière.
L’extrait suivant d’un fichier de projet spécifie MicrosoftGameConfig_dev.mgc comme fichier de configuration par défaut. MicrosoftGameConfig_dev.mgc sera utilisé pour toutes les configurations de génération autres que Release, pour laquelle un remplacement (MicrosoftGameConfig_release.mgc) a été spécifié.
Prise en charge d’IntelliSense pour MicrosoftGame.config
La modification d’un fichier MicrosoftGame.config dans Visual Studio prend désormais en charge les fonctionnalités IntelliSense. Cela fournit des renseignements supplémentaires, comme le montrent les deux captures d’écran suivantes. Les noms d’éléments valides sont automatiquement listés lors de la rédaction d’un élément.
Exigences de plateforme pour MicrosoftGame.config
Lorsque vous créez un fichier MicrosoftGame.config pour votre titre, vous devez en créer un pour chaque plateforme du Microsoft Game Development Kit (GDK) (Gaming.Xbox.XboxOne.x64, Gaming.Xbox.Scarlett.x64 et Gaming.Desktop.x64). Cela est nécessaire pour garantir que les valeurs d’éléments stockées dans MicrosoftGame.config correspondent de façon biunivoque à la plateforme pour laquelle votre exécutable est généré. Cela est principalement spécifié par l’attributTargetDeviceFamily de l’élément Executable dans le fichier MicrosoftGame.config. Pour plus d’informations, consultez la section Détails supplémentaires sur les éléments de la rubrique de référence.
Lors du lancement, votre titre se comporte différemment selon les exigences de plateforme, l’appareil sur lequel le titre est lancé et le type d’exécutable, comme le montre le tableau suivant.
Dans le scénario où un titre XBOX Series X|S est lancé sur une trousse de développement XBOX Series X sans MicrosoftGame.config, il réutilisera l’état existant de la machine virtuelle du Microsoft Game Development Kit (GDK), le cas échéant. Par exemple, si un titre Microsoft Game Development Kit (GDK) rétrocompatible (XBOX One sur XBOX Series X|S) a été lancé avant la tentative de lancement d’un titre natif XBOX Series X|S, ce dernier sera exécuté dans cette même machine virtuelle de rétrocompatibilité du Microsoft Game Development Kit (GDK). Si vous rencontrez ce scénario, nous vous recommandons d’utiliser un MicrosoftGame.config dont TargetDeviceFamily est configuré pour indiquer l’intention appropriée. Les titres ERA s’exécutent dans un état de machine virtuelle distinct et n’influencent donc pas le comportement de la machine virtuelle du Microsoft Game Development Kit (GDK) dans ce scénario.
Création et modification d’un MicrosoftGame.config en dehors de Visual Studio
Comme indiqué ci-dessus, Visual Studio offre de nombreuses façons de créer et de gérer le fichier MicrosoftGame.config de votre titre. En plus de la création et de la modification dans Visual Studio, il existe un outil autonome qui permet de créer et de rédiger directement le fichier MicrosoftGame.config. L’éditeur MicrosoftGame.config est un outil d’interface utilisateur qui facilite la rédaction et la modification des fichiers .config. Cet éditeur comprend également des points d’intégration avec les informations de votre titre dans Partner Center afin de récupérer et de synchroniser automatiquement des informations comme votre TitleId, votre MSAAppId et votre StoreId, au moyen d’un Assistant d’association au Store. Vos commentaires sont les bienvenus : utilisez l’outil de suggestion de l’éditeur pour nous faire part de vos idées.Lancement d’un jeu sans MicrosoftGame.config
Dans le Microsoft Game Development Kit (GDK), vous pouvez lancer un jeu PC ou un jeu XBOX sans qu’un fichier MicrosoftGame.config soit présent. Cela est permis pour le développement précoce, avant la création d’un MicrosoftGame.config, et vise à offrir de la souplesse quant au moment où vous souhaitez adopter les fonctionnalités du Gaming Runtime, du Microsoft Store et de l’identité du titre. Pour livrer un titre avec le Microsoft Game Development Kit (GDK), un MicrosoftGame.config est requis pour créer le package de votre titre avant la soumission au Microsoft Store. Il est recommandé d’adopter et de configurer le MicrosoftGame.config de votre titre dès que vous commencez à développer des fonctionnalités qui nécessitent le Gaming Runtime, les XBOX services, le Microsoft Store ou l’identité du titre. Les jeux PC qui n’ont pas de MicrosoftGame.config peuvent être générés et lancés en double-cliquant sur l’exécutable généré. Ils s’exécuteront sans aucune intégration des fonctionnalités du Gaming Runtime. Pour la prise en charge des fonctionnalités du Gaming Runtime, de l’identité du titre, de l’empaquetage MSIXVC et de la possibilité de soumettre au Microsoft Store, un MicrosoftGame.config est requis. Les jeux XBOX qui n’ont pas de MicrosoftGame.config pourront utiliser les outils du GDK pour déployer des builds en fichiers libres, les lancer, les déboguer et utiliser un sous-ensemble des fonctionnalités du Microsoft Game Development Kit (GDK) d’emblée. Pour la prise en charge complète des fonctionnalités du Microsoft Game Development Kit (GDK), de l’identité du titre, de l’empaquetage XVC et de la possibilité de soumettre au Microsoft Store, un MicrosoftGame.config est requis. Pour lancer votre titre sur XBOX sans MicrosoftGame.config, vous pouvez :- Utiliser la commande launch de xbapp.exe (rubrique sous NDA).
- Utiliser la fonctionnalité de déploiement/lancement de XBOX Manager.
- Lancer le titre à partir de Developer Home (Dev Home) sur votre XBOX.
Lancement d’un jeu Win32
Un jeu PC Win32 qui n’utilise ni le Gaming Runtime ni les services infonuagiques de jeu peut être lancé et/ou débogué comme n’importe quel autre exécutable Windows. Il suffit de cliquer sur l’exécutable du jeu avec votre souris ou d’exécuter directement l’exécutable dans une fenêtre d’invite de commandes, et le processus du jeu est créé. Les services de jeu effectuent du travail pour le compte d’un jeu. Pour utiliser le Gaming Runtime ou les services infonuagiques de jeu, un jeu doit fournir des données contextuelles. Par exemple, un jeu peut transmettre aux XBOX services un identificateur unique appelé identité du titre, qui permet au service de déterminer quel jeu accorde des succès aux joueurs. Les informations contextuelles comme l’identité du titre peuvent être stockées de façon persistante dans le référentiel d’applications Windows au moyen d’un processus appelé inscription. C’est également par l’inscription qu’un jeu spécifie les chaînes et les logos que le shell Windows doit utiliser pour représenter le jeu dans la liste des applications du menu Démarrer. Grâce à une action appelée lancement d’application (app-launch), un processus de jeu est créé et le jeu obtient l’accès à ses informations contextuelles persistantes provenant du référentiel d’applications. Si vous ne lancez pas le jeu par app-launch, un processus est créé pour exécuter le jeu, mais son contexte ne sera pas disponible. Cela empêche le jeu d’utiliser correctement le Gaming Runtime et les services infonuagiques de jeu. Vous pouvez lancer votre jeu par app-launch de l’une des façons suivantes.- Menu Démarrer (liste des applications, vignette d’application)
- Recherche dans la barre des tâches (liste des résultats de recherche/volet de détails)
- Commande launch de wdapp.exe
- Windows Device Portal (WDP) : Installed Apps > Start
Débogage d’un jeu Win32
Dans le Microsoft Game Development Kit (GDK), les jeux PC Win32 passent par les chemins d’inscription et de lancement d’application lorsque vous appuyez sur F5 pour générer et exécuter. Ce flux de travail atteint ainsi la même norme que celle qui existe sur XBOX. En ce qui concerne la fonction Déboguer le package d’application installé sur PC Win32, la fonction Déboguer le package d’application installé de Visual Studio n’ajoute pas votre jeu à sa liste de packages pouvant être débogués si le manifeste de votre jeu s’appelle MicrosoftGame.config. Déboguer le package d’application installé ne reconnaît votre jeu comme un package que si un fichier nommé AppXManifest.xml est présent dans le dossier contenant votre exécutable. Pour contourner ce problème, vous pouvez créer unAppXManifest simple contenant des valeurs valides pour votre jeu et l’enregistrer manuellement dans le dossier contenant votre exécutable et MicrosoftGame.config.