Skip to content

Latest commit

 

History

History
57 lines (39 loc) · 1.98 KB

README.md

File metadata and controls

57 lines (39 loc) · 1.98 KB

Tutorial GDK - Xbox services sample

This Godot 4.x project is the reference implementation for the GDK tutorial track. It uses godot_gdk runtime surfaces and does not require PlayFab.

Quick start

  1. Build the addons from the repository root:

    cmake --preset default
    cmake --build build --preset debug
  2. Create MicrosoftGame.config for this sample. Run the setup helper or copy/edit the template manually:

    pwsh -File .\tools\setup_sample.ps1
  3. Open sample/tutorial_gdk/project.godot in Godot and run the picker.

Scenes

# Scene Tutorial
1 g01_signin.tscn GDK 1 — Xbox-only sign-in
2 g02_achievement.tscn GDK 2 — Unlock achievement
3 g03_storage_stats.tscn GDK 3 — Title Storage and stats
4 g04_mpa.tscn GDK 4 — Multiplayer Activity
5 g05_speech.tscn GDK 5 — Text-to-Speech
6 g06_handheld_input.tscn GDK 6 — Windows handheld text input

shared/tutorial_picker.tscn is the default scene.

Autoloads

  • XboxAuth (autoload/gdk_auth.gd) — Xbox-only sign-in; exposes xbox_user, sign_in(), state helpers, and state_changed.

Configuration

  • Requires MicrosoftGame.config with title id, SCID, sandbox, and service configuration.
  • Does not require a PlayFab title id.

Files generated locally (git-ignored)

  • MicrosoftGame.config
  • sample_config.cfg
  • addons/godot_*/
  • .godot/
  • Build/

See also