October 2024 Microsoft Game Development Kit (GDK) release notes
Introduction
Welcome to the October 2024 Microsoft Game Development Kit release. You can use the GDK to develop games that can be certified and approved for release on Windows 11 PCs and Windows 10 PCs.
About this document
We have organized this document into the following sections.
- What's new
- Release notes:
- Documentation
What's new in the October 2024 Microsoft Game Development Kit
- The GDK is released in two types: Major (focused on features, three times a year) and Updates (focused on fixes, as often as needed).
- To view the full What's New section, see the online version of What's New.
October 2024 GDK
Breaking changes
System
Beginning with the October 2024 GDK release, the directory layout of the various extension libraries (for example, XSAPI, XCURL, GameChat, and PlayFab) has been modified to shorten the overall path length and simplify use in custom build systems. These changes are automatically handled by MSBuild rules for those customers who are using the Gaming.*.x64 GDK build platforms. No changes are required in these scenarios.
The changes between March 2024 and August 2024 are described by the following string substitutions.
- "DesignTime\CommonConfiguration\neutral\ExtensionLibrary.props" is now "ExtensionLibrary.props"
- "DesignTime\CommonConfiguration\neutral\Include" is now "Include"
- "DesignTime\CommonConfiguration\neutral\Lib" is now "Lib\x64"
- "Redist\CommonConfiguration\neutral" is now "Redist\x64"
GDK tools
Support for using the Visual Studio 2017 IDE for game development was removed in the October 2022 GDK. Support for building games with the Visual Studio 2017 toolset (v141) remained in place for use with Visual Studio 2019 and Visual Studio 2022 to ease the transition to a newer toolset.
Beginning with the October 2024 GDK, support for building with the v141 toolset will be removed. Note that versions of the GDK prior to October 2024 will continue to support building with the v141 toolset.
Microsoft Azure PlayFab
In the PlayFab Economy inventory redemption APIs,
PFInventoryRedemptionSuccess
andPFInventoryRedemptionFailure
responses now returnmarketplaceAlternateId
instead ofofferId
.
Customers who use these APIs must update their code to use the new
marketplaceAlternateId
field.
Notifications
Multiplayer
- Improved internal diagnostics.
- Updated
PFMultiplayerCreateServerBackfillTicket
to automatically handle failures where a match member is already a member of too many tickets. In this situation, the SDK automatically cancels existing tickets for members of the backfill ticket and retries ticket creation.
Issue fixes
Multiplayer
- Fixed an issue for the Xbox October 20024 GDK where some events wouldn't be queued after suspending and resuming a title.
- Fixed an issue for the Xbox October 2024 GDK that caused a crash after suspending and resuming a title.
- Fixed an issue where the internal
PubSub
notification WebSocket was slow to detect and react to disconnects. This could lead to errors when creating or joining lobbies and matchmaking tickets.- Fixed an issue where failure of
PubSub
to establish a connection with theSignalR
service wouldn't trigger a failed state change and wouldn't allow subsequentMultiplayer
API calls to subscribe toPubSub
.
Known issues
GDK tools
In Visual Studio 2019, opening the GDK Help file by using the "?" button from the Xbox Gaming Explorer or any other Xbox tool windows in Visual Studio 2019 causes the GDK Help file to open to its overview page. This occurs rather than the topic page opening that's specific to the tool being used. This issue doesn't occur when using Visual Studio 2022. [54221676]
Documentation
Offline documentation for the October 2024 release of the GDKX is installed on your development PC by the GDKX Setup program. After running Setup, the Help file for the GDKX (gdk.chm) is in C:\Program Files (x86)\Microsoft GDK\Documentation.
- The online GDKX documentation is at http://aka.ms/gdkonline.