Samples overview

The Microsoft GDK API package contains a set of samples to help you explore the Xbox Services such as Achievements, Cloud Saves and Leaderboards. A sample contains C# scripts, scenes, a Microsoft Game Configuration file, and a GDK Settings file.

The samples can be found using the following steps:

  1. Create a new Unity Project.
  2. In the main menu, go to Window > Package Manager.
  3. In the packages list view, select the Microsoft GDK API package.
  4. In the Package details view, select Samples.
  5. Import the sample you want to explore.

Provided samples

Sample Description
Achievements Demonstrates basic interaction with Title-Managed Achievements.

Use it to:
  • Query a single achievement to unlock it.
  • Update the status of the achievement.
Cloud saves Demonstrates the use of XGameSaveAPIs to implement cloud saves. Use it to save, upload, and retrieve cloud save data .
Game Save Demonstrates the use of XGameSaveAPIs and full-sync or sync-on-demand mode.

Use it to:
  • Load, save, and delete game save data.
  • Display the state of all the containers and blobs used in a game in the debug output area.
In Game Store Demonstrates an in-game store implementation to present specific items for the users to purchase using the XStore API.
Leaderboards Demonstrates the use of Leaderboards in a title using Player Stats and Player Stat Rules. Use it to rank game participants based on their position in the game in relation to their peers.
Sign-in Demonstrates a scenario where a user signs-in when the game scene starts.
Speech Synthesizer Demonstrates the use of the Speech Synthesizer feature. Use it to set up a speech synthesize engine to convert text messages into audio streams.
Users Demonstrates user identity using the XUser Game Core API. Use it to query the gamertag and check the status of the user sign-in.

Additional resources