Changelog
All notable changes to this package will be documented in this file (reverse chronological order).
The format is based on Keep a Changelog and this project adheres to Semantic Versioning expressed as MAJOR.MINOR.PATCH:
- Different MAJOR: there is at least one breaking change, and neither version of the package can be substituted for the other. For example, versions 1.2.3 and 2.0.0 are not compatible and cannot be used interchangeably.
- Same MAJOR, different MINOR: the highest MINOR introduces functionality in a backward-compatible way. For example, version 1.3.0 can be used to fulfill a dependency on 1.2.0 because 1.3.0 is backward-compatible; however because it introduces new features, the reverse is not true.
- Same MAJOR.MINOR, different PATCH: the highest PATCH introduces bug fixes without changing the API at all, in a backward-compatible way. For example, versions 1.3.0 and 1.3.1 should be interchangeable as they have the same API, although 1.3.1 contains a bug fix not present in 1.3.0.
[1.3.0] - 2024-11-12
Add version 1.3.0 by name.Added
- Added SafeHandle as a base class for all XBL Handles. Unclosed handles will autorelease once out of scope.
- Added support to October 2024 GDK new Extension Libraries paths.
- Generated GDK Settings script file now marks
gameConfigSandbox
as obsolete, it will be removed in a future release.
Fixed
- Fix XPersistentLocalStorageGetPath interop missmatch for string path.
- XGamingRuntimeThunks.dll incorrectly included in some builds.
Changed
- Automatically imported GDK assemblies are now marked as Editor ONLY by default. This makes the assemblies available for in Editor Playmode whilst avoiding the assemblies being deployed to none-compatible target platforms. When using the Microsoft GDK API package without the Microsoft GDK Tools package, the developer will be responsible for ensuring that these assemblies are correctly deployed.
[1.2.3] - 2024-09-09
Add version 1.2.3 by name.Added
- Added public XblAchievementsAddAchievementProgressChangeHandler and XblAchievementsRemoveAchievementProgressChangeHandler
Fixed
- Corrected samples and documentation that incorrectly recommend using coroutine to pull GDK events.
- Improved mouse handling in the samples.
- Updated sample installation documentation to mention dependency on the Input System package.
- Create/OpenKey Access denied error on Windows 11.
- Copy libHttpClient.GDK.dll to
Assets/Plugin/GDK
project folder when using June 2024 GDK.
Changed
Removed
Known Issues
[1.1.0] - 2024-06-17
Add version 1.1.0 by name.Added
- Added public HR constants to Interop.HR to maintain back compatibility with possible upgrade paths
- Added public constructor to XblTitleStorageBlobMetadata.
- Added public XGameSaveSubmitBlobWrite which accepts 'length' parameter.
Fixed
- Fixed the XStoreQueryAssociatedProductsAsync wrapper always returning an error.
- Fixed the Speech Synthesizer Sample UI to not lock when the close button is pressed.
- Fixed Leaderboard sample: better handling of
Http429TooManyRequests
. - Fixed XGameSaveInitializeProviderResult and XGameSaveInitializeProvider to bypass offline mode handles.
- Fixed XblSocialManagerPresenceTitleRecord struct interop missmatch.
- Fixed XblSocialManagerUserGroupGetLocalUser, XblSocialManagerPresenceTitleRecord and XblSocialManagerEvent to avoid XUserHandle autoreleases.
- Fixed abort pulling Gdk Dll's into the project when the GDK is not installed on the local machine.
- Fixed API's with optional parameters to accept null.
- Fixed XUserGetTokenAndSignatureUtf16Async to support null arrays passed to it for the Header and Body parameters.
- Fixed player could crash after XblSocialManagerCreateSocialUserGroupFromFilters call.
Changed
- Updated the included fall-back XGameRuntime thunks DLL.
[1.0.0] - 2024-03-28
Add version 1.0.0 by name.Fixed
- Speech Synthesizer Sample: Avoid trying to close already closed speech synthesizer.
- Speech Synthesizer Sample: Make UI active/inactive based on speech synthesizer state.
Changed
- Bump package version
[1.0.0-pre.3] - 2024-03-18
Add version 1.0.0-pre.3 by name.Added
- Added support for XblPrivacyCheckPermissionForAnonymousUserAsync.
Changed
- Bumped version to keep inline with other related packages.
- Revised documentation
[0.2.0] - 2024-02-06
Add version 0.2.0 by name.Changed
- Bumped version to keep inline with other related packages.
- Updated APIs
[0.1.0] - 2024-01-31
Add version 0.1.0 by name.Added
- Preview implementation of API support
- Preview samples
- Preview documentation
This is the first release of Unity Package com.unity.microsoft.gdk.
Initial release.