Modelos de projeto no Visual Studio para o desenvolvimento de jogos para PC

Este tópico descreve os modelos de projeto de jogos para PC com Windows disponíveis no Visual Studio.

Modelos de projeto

O Microsoft Game Development Kit (GDK) instala os seguintes modelos de projeto C++ do Visual Studio.

Direct3D 12 Desktop Game (Classic): um projeto para um jogo do Windows que usa Direct3D 12 e C++ com a plataforma MSBuild x64 ‘padrão’.
Direct3D 12 Desktop Game: um projeto para um jogo do Windows que usa Direct3D 12 e C++ com a plataforma personalizada do MSBuild Gaming.Desktop.x64.
Direct3D 12 Desktop Game Makefile: um projeto para um jogo do Windows que usa Direct3D 12 e C++ por meio de um sistema de build externo.
Desktop Static Library: um projeto para uma biblioteca estática do Windows com a plataforma personalizada do MSBuild Gaming.Desktop.x64.
Desktop DLL: um projeto para uma biblioteca de vínculo dinâmico do Windows com a plataforma personalizada do MSBuild Gaming.Desktop.x64.

Modelo autônomo

Como alternativa ao uso dos modelos do GDK instalados para o desenvolvimento para Desktop e dispositivos portáteis, há um modelo de projeto totalmente autônomo que usa o vc Package Manager para adicionar as versões empacotadas do Microsoft GDK, do DirectX 12 Agility SDK etc. Ele pode ser usado como base para lançar na Microsoft Store e no XBOX PC App. Esse pacote inclui um modelo de projeto MSBuild e um CMake, e requer o Visual Studio 2022 v17.6 ou posterior. Veja o Visual Studio Marketplace.

Localizar os modelos de projeto do Microsoft Game Development Kit (GDK)

Localize os modelos do Microsoft Game Development Kit (GDK) pesquisando e filtrando na caixa de diálogo Criar um novo projeto do Visual Studio 2019 ou do Visual Studio 2022. Os modelos do Microsoft Game Development Kit (GDK) podem ser encontrados filtrando pela linguagem C++, pela plataforma Windows e pelo tipo de projeto Jogos, conforme mostrado na captura de tela a seguir.

Captura de tela da caixa de diálogo Criar um novo projeto no Visual Studio 2019 para localizar modelos de jogos para PC com Windows

A plataforma Gaming.Desktop.x64, os arquivos do msbuild e as propriedades

O Microsoft Game Development Kit (GDK) define uma plataforma do msbuild chamada Gaming.Desktop.x64 para ser usada no desenvolvimento de jogos para PC com Windows. A Gaming.Desktop.x64 inclui um conjunto de arquivos de propriedades e destinos do msbuild que definem as diretivas de pré-processador necessárias (como _GAMING_DESKTOP) e configuram os caminhos de modo que, por exemplo, bibliotecas de extensão, arquivos de inclusão e bibliotecas sejam encontrados corretamente em C:\Program Files (x86)\Microsoft GDK\edition\GRDK quando o jogo for compilado. Para obter detalhes específicos sobre as propriedades e os destinos do msbuild definidos pela plataforma Gaming.Desktop.x64, veja Configurar projetos sem instalar o Microsoft Game Development Kit.

Usar a plataforma x64 com o Microsoft Game Development Kit (GDK)

Ao direcionar para PC sem usar a plataforma personalizada do MSBuild Gaming.Desktop.x64, os arquivos de projeto devem implementar toda a funcionalidade necessária.

Para oferecer suporte à instalação ‘lado a lado’, o projeto precisa selecionar a edição apropriada. Isso pode ser feito por meio de uma propriedade definida na seção Globals:

<PropertyGroup Label="Globals">
...
  <GDKPCEditionPath>$(GRDKLatest)</GDKPCEditionPath>
</PropertyGroup>

O uso da variável de ambiente GRDKLatest usa como padrão a edição mais recente instalada no PC de desenvolvimento e tem o formato C:\Program Files (x86)\Microsoft GDK<edition>\GRDK\.

Usamos a propriedade GDKPCEditionPath no restante das configurações de build. O uso direto de GRDKLatest como propriedade no restante do arquivo de projeto não é recomendado, pois isso torna mais difícil experimentar novas versões, gerenciar atualizações, reproduzir problemas etc. Se você usar arquivos .props personalizados para conduzir o processo de build, coloque GDKPCEditionPath neles em vez de em cada arquivo de projeto. Observe também que essa propriedade precisa de uma barra no final para atender às convenções do MSBuild.

No VS 2019, você também deve usar a versão nativa x64 das ferramentas. No VS 2022, esse é o padrão, portanto é opcional.

<PropertyGroup Label="Globals">
...
  <PreferredToolArchitecture>x64</PreferredToolArchitecture>
</PropertyGroup>

Todas as bibliotecas de extensão necessárias do Microsoft Game Development Kit (GDK) devem ter os caminhos de inclusão/bibliotecas apropriados e as DLLs de redistribuição incluídas, conforme necessário. Isso pode ser feito modificando as importações ExtensionSettings do arquivo vcxproj:

Microsoft GDK (outubro de 2024) ou posterior:

<ImportGroup Label="ExtensionSettings">
    <Import Project="$(GDKPCEditionPath)ExtensionLibraries\Xbox.Services.API.C\ExtensionLibrary.props" />
    <Import Project="$(GDKPCEditionPath)ExtensionLibraries\Xbox.XCurl.API\ExtensionLibrary.props" />
    <Import Project="$(GDKPCEditionPath)ExtensionLibraries\Xbox.LibHttpClient\ExtensionLibrary.props" />
    <Import Project="$(GDKPCEditionPath)ExtensionLibraries\Xbox.Game.Chat.2.Cpp.API\ExtensionLibrary.props" />
    <Import Project="$(GDKPCEditionPath)ExtensionLibraries\PlayFab.Multiplayer.Cpp\ExtensionLibrary.props" />
    <Import Project="$(GDKPCEditionPath)ExtensionLibraries\PlayFab.Party.Cpp\ExtensionLibrary.props" />
    <Import Project="$(GDKPCEditionPath)ExtensionLibraries\PlayFab.PartyXboxLive.Cpp\ExtensionLibrary.props" />
</ImportGroup>

Microsoft GDK (junho de 2024) ou anterior:

<ImportGroup Label="ExtensionSettings">
    <Import Project="$(GDKPCEditionPath)ExtensionLibraries\Xbox.Services.API.C\DesignTime\CommonConfiguration\Neutral\ExtensionLibrary.props" />
    <Import Project="$(GDKPCEditionPath)ExtensionLibraries\Xbox.XCurl.API\DesignTime\CommonConfiguration\Neutral\ExtensionLibrary.props" />
    <Import Project="$(GDKPCEditionPath)ExtensionLibraries\Xbox.LibHttpClient\DesignTime\CommonConfiguration\Neutral\ExtensionLibrary.props" />
    <Import Project="$(GDKPCEditionPath)ExtensionLibraries\Xbox.Game.Chat.2.Cpp.API\DesignTime\CommonConfiguration\Neutral\ExtensionLibrary.props" />
    <Import Project="$(GDKPCEditionPath)ExtensionLibraries\PlayFab.Multiplayer.Cpp\DesignTime\CommonConfiguration\Neutral\ExtensionLibrary.props" />
    <Import Project="$(GDKPCEditionPath)ExtensionLibraries\PlayFab.Party.Cpp\DesignTime\CommonConfiguration\Neutral\ExtensionLibrary.props" />
    <Import Project="$(GDKPCEditionPath)ExtensionLibraries\PlayFab.PartyXboxLive.Cpp\DesignTime\CommonConfiguration\Neutral\ExtensionLibrary.props" />
</ImportGroup>

As propriedades de diretórios do VC++ ExecutablePath, IncludePath e LibraryPath devem ser atualizadas para incluir os caminhos do Microsoft Game Development Kit (GDK).

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
  <ExecutablePath>$(GameDK)bin;$(ExecutablePath)</ExecutablePath>
  <IncludePath>$(GDKPCEditionPath)GameKit\Include;$(Console_SdkIncludeRoot);$(IncludePath);</IncludePath>
  <LibraryPath>$(GDKPCEditionPath)GameKit\lib\amd64;$(Console_SdkLibPath);$(LibraryPath)</LibraryPath>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
  <ExecutablePath>$(GameDK)bin;$(ExecutablePath)</ExecutablePath>
  <IncludePath>$(GDKPCEditionPath)GameKit\Include;$(Console_SdkIncludeRoot);$(IncludePath);</IncludePath>
  <LibraryPath>$(GDKPCEditionPath)GameKit\lib\amd64;$(Console_SdkLibPath);$(LibraryPath)</LibraryPath>
</PropertyGroup>

Para o caminho do executável, usamos a variável de ambiente GameDK diretamente, pois ele não é ‘lado a lado’. Isso também pode ser substituído como uma propriedade em um arquivo .props personalizado, se necessário. As propriedades Console_SdkIncludeRoot e Console_SdkLibPath são fornecidas pelo ExtensionLibrary.props do Microsoft Game Development Kit (GDK), que são compatíveis tanto com PC x64 quanto com XBOX.

Para os ItemDefinitionGroups da sua plataforma, adicione _GAMING_DESKTOP às definições do pré-processador para manter a consistência com a Gaming.Desktop.x64 ao usar bibliotecas ou outro middleware.

 <PreprocessorDefinitions>_GAMING_DESKTOP;WIN32;_DEBUG;_WINDOWS;%(PreprocessorDefinitions)</PreprocessorDefinitions>

<PreprocessorDefinitions>_GAMING_DESKTOP;WIN32;NDEBUG;_WINDOWS;%(PreprocessorDefinitions)</PreprocessorDefinitions>

Também nos ItemDefinitionGroups, adicione as seguintes bibliotecas às dependências de bibliotecas adicionais. Especificamente, xgameruntime.lib para o GameRuntime e gameinput.lib para o GameInput no PC.

<AdditionalDependencies>xgameruntime.lib;gameinput.lib;d3d12.lib;dxgi.lib;dxguid.lib;uuid.lib;kernel32.lib;user32.lib;%(AdditionalDependencies)</AdditionalDependencies>

O último elemento necessário é converter o arquivo de origem MicrosoftGameConfig.mgc no MicrosoftGame.config necessário na saída do build. Isso pode ser implementado como uma personalização de build:

<CustomBuild Include="MicrosoftGameConfig.mgc">
  <Command>copy %(Identity) "$(OutDir)MicrosoftGame.config"
makepkg.exe localize /d "$(OutDir)" /pd "$(OutDir)" /gc "%(Identity)"</Command>
  <Message>MGC Compile</Message>
  <Outputs>$(OutDir)MicrosoftGame.config</Outputs>
</CustomBuild>

O MicrosoftGame.config também precisará dos ativos de logotipo necessários para ser válido, o que pode ser feito com uma cópia de arquivos:

<ItemGroup>
  <CopyFileToFolders Include="GraphicsLogo.png" />
  <CopyFileToFolders Include="LargeLogo.png" />
  <CopyFileToFolders Include="SmallLogo.png" />
  <CopyFileToFolders Include="SplashScreen.png" />
  <CopyFileToFolders Include="StoreLogo.png" />
</ItemGroup>

Crie um projeto a partir do modelo Direct3D 12 Desktop Game (Classic) e revise-o para verificar as configurações acima, bem como algumas recomendações adicionais.

Veja também

Visual Studio (para o desenvolvimento de jogos para PC)