Welcome to the Microsoft Game Development Kit (GDK) repository. This project aims to provide developers with the essential tools and resources to create amazing games for the Xbox ecosystem. Whether you're targeting PC, console, or cloud gaming, the GDK has you covered.
The GDK contains the common tools, libraries, and documentation needed to build games for Xbox Game Pass for PC on Windows 10/11, Xbox consoles (Xbox Series X|S, Xbox One), and cloud gaming with Xbox Game Pass Ultimate.
• Comprehensive Toolset: The GDK includes a wide range of tools and APIs to support game development across multiple platforms.
• Cross-Platform Development: Develop games for Windows PCs, Xbox consoles, and cloud gaming with a single set of tools.
• Extensive Documentation: Access detailed documentation, tutorials, and examples to help you make the most of the GDK.
• Install
If you are new to game development and want to learn more, we recommend reviewing the getting started documentation.
The GDK can be installed through the following methods:
WinGet, the Windows Package Manager, is a command-line tool that simplifies the installation process, enabling users to discover, install, upgrade, remove, and configure applications on Windows client computers.
It's particularly useful for automating installations and ensuring consistency across multiple machines.
This tool is the client interface to the Windows Package Manager service and it is bundled with Windows 11 and modern versions of Windows 10 by default.
Note
• See the winget documentation for a list of system requirements and install instructions.
• winget isn't available on Windows Server 2022 or earlier versions.
• Windows Server 2025 Preview Build 26085 and later includes winget for Windows Server with Desktop Experience only.
The following commands can be used to install the GDK using the published winget packages:
winget search Microsoft.Gaming.GDK
winget install Microsoft.Gaming.GDK
winget upgrade Microsoft.Gaming.GDK
NuGet is a package manager for .NET that handles dependencies and versioning. It's beneficial for managing libraries and tools within Visual Studio projects.
It also allows to ensure compatibility of the GDK with other packages in your project.
To install NuGet packages, you can use various methods such as the NuGet Package Manager in Visual Studio, the Package Manager Console, or the .NET CLI.
The NuGet package for the Microsoft GDK can be found here: https://www.nuget.org/packages/Microsoft.GDK.PC
To install it, you can follow these instructions:
-
Open Visual Studio: Start by launching your Visual Studio IDE.
-
Create or Open a Project: You can either create a new project or open an existing one. To create a new project, go to File > New > Project, select the type of project you want to create, and follow the prompts.
-
Open NuGet Package Manager: There are a few ways to open the NuGet Package Manager:
- Right-click on your project in the Solution Explorer and select Manage NuGet Packages....
- Go to Tools > NuGet Package Manager > Manage NuGet Packages for Solution....
-
Browse for Packages: In the NuGet Package Manager, go to the Browse tab and search for Microsoft.GDK.PC
-
Install the Package: Once you find the Microsoft.GDK.PC package, select it and click the Install button. Follow any prompts to complete the installation.
-
Use the Package in Your Code: After installing the package, you can use it in your code by adding the appropriate using statement at the top of your file and calling the package's API as needed.
Note
This section is deprecated and should only be used for installation of GDK versions up to the 2410 version (OCTOBER_2024_GDK_UPDATE_1)
• Download: Go to the Releases page and pick the latest and greatest. Alternatively, you can pick the branch that fits your needs and clone or download that branch.
• Install: Run PGDK.EXE to launch the install wizard. If you have a previous version of the GDK you may need to uninstall that first.
• GDK documentation is here on docs.microsoft.com (DMC): https://aka.ms/gamedevdocs
• Check out the Xbox public sample repository: https://github.com/microsoft/Xbox-GDK-Samples/
• Latest release of the GDK on GitHub: https://aka.ms/gdk
• The GDK is intended for developers learning about and onboarding into the Xbox ecosystem to build Win32 games for PC Game Pass on Windows 10/11.
• The GDK is available to all developers free of charge, helping them learn how to build games for the Xbox App on Windows and Game Pass without requiring a license for learning.
• The GDK can be used to publish through the Xbox Creators Program (registration required) .
• Additional licensing is required to obtain the Xbox Extensions to build games optimized for Xbox consoles or publish games to the Microsoft catalog for any platform
More information can be found in our GDK public documentation. (http://aka.ms/gamedevdocs)
A version of the GDK with Xbox Extensions (GDKX) to target Xbox consoles is only available to licensed partners in a managed program (https://aka.ms/gdkdl).
Game development on Microsoft platforms has a history going back 40+ years which means that there have been and still are many options to build games that reach gamers on PC. The GDK is an evolution to the Win32 legacy, to unify the app model between Xbox consoles, Windows PCs, and now Cloud Gaming to enable game developers to reach even more gamers on more devices, with less effort. Microsoft Gaming Services are agnostic across many ecosystems and the GDK is sharing the app model across millions of devices.
- Get started setting up your developer environment here!
- Using Win32 + GDK is the primary, supported app model to build games for Xbox console, Xbox Game Pass (both Xbox and PC), and Xbox Game Streaming**.
- Key Feature is that only Win32 + GDK fully supports all Microsoft Gameplay Services (Xbox Live identity, multiplayer, chat, leaderboards, achievements, commerce, etc.), and is required for Xbox Game Pass[1] on both console and PC.
- For developers building Win32 games on PC today, Win32 + GDK builds on the Win32 C/C++ programming models to unify development across Xbox consoles and Windows PCs with the Microsoft Game Development Kit (GDK).
[1] Requires software and licensing which is only available via an NDA Xbox program (e.g. ID@Xbox program).
❔How do I run a GDK game built for the Xbox App on Windows 10/11 or Xbox Game Pass for PC on Xbox Consoles?
- Xbox console development requires the “Microsoft Game Development Kit with Xbox Extensions (GDKX)”. Games will need to retarget and rebuild for Xbox One or Xbox Series X|S with the GDKX installed.
- You need to download, install, and retarget your project for Xbox consoles using the GDKX
- The GDKX is currently only available under confidential license within an NDA Xbox program (e.g. ID@Xbox).
- The GDKX is just a bundled installer of the GDK + Xbox Extensions. Building a game with the GDK shares around ~80% of the same interfaces, but does not include the Xbox environment APIs and tools included in the Xbox Extensions.
- The primary difference between games built with the GDK and the GDKX is the interaction with the Xbox graphics driver and DirectX12 Shader Compiler.
- For developers building Xbox One games, Win32 + GDK is a direct replacement for the WinRT-based Exclusive Resource Application (ERA) app model using the XDK, introduced on Xbox One; Xbox 360 developers similarly migrated to ERA in 2013.
- The Universal Windows Platform was introduced in 2015 for Windows 10 as a bridge between all the devices in the Windows family (Windows Phone, Surface, Windows PCs, and Xbox One*).
- Key feature for is open development and self-publishing to Windows Mixed Reality (MR) or the Microsoft Store on Windows 10 PCs and Xbox; particularly well suited for interactive media applications.
- For developers building Win32 games today, UWP requires porting to the WinRT programming model*.
- UWP apps and games are community-supported only; partners inside Xbox managed programs (Xbox, Xbox Game Pass, Xbox Game Streaming) should use Microsoft Win32 + GDK.
In the “When to use the GDK” section above, we cover the scenarios for which the GDK was designed to provide a modern app model that flows across Xbox consoles, Windows PCs, and Cloud Gaming.
In this section, we cover some of the more practical, basic questions that are also answered in the documentation, but come up frequently from developers getting started with this app model.
- Three major GDK release branches a year with a mix of new features and fixes (flexibly April, June, and October to align with game development cycles).
- GDK updates can release in parallel as needed, on separate branches, focused on reliability, stability, and fixes. Developers can take updates vs. another major version to reduce churn and risk of breaking changes affecting compatibility (e.g. April Update #1, April Update #2, April Update #3, June Update #1, etc).
- A public version of the release notes can be found here: GDK Release Notes
- Change Log information is available to be reviewed here Change Log as well as on the Microsoft Learn site.
- The Xbox developer environment APIs and Tools required to target and build games that run on Xbox consoles, currently only bundled as the GDKX installer package.
- The Xbox graphics driver and related DirectX 12 components (e.g. Shader Compiler) required to build binaries that work with proprietary Xbox hardware and software interfaces.
- The corresponding confidential documentation for Xbox environment APIs and Tools; though some topics are only discoverable with access to the GDKX, most topics are available as public docs (~60%) or are discoverable via the table of contents as a redirect to the confidential documentation libraries (~35%).
- Xbox console development is limited to licensed partners inside managed development programs, such as ID@Xbox
- License and login required
- GDKX (confidential program downloads): https://aka.ms/gdkdl
- GDKX Documentation (secure): https://aka.ms/gdkxdocs
- Xbox Developer Forums: https://forums.xboxlive.com