> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Use the GDK with Godot

> Integrate the XBOX GDK, XBOX services, PlayFab, and GameInput into a Godot project using the source-only XBOX Godot Sample to ship to XBOX on PC.

This article describes how to get started using Godot to build XBOX games for PC with the Microsoft Game Development Kit (GDK). It points you to the **XBOX Godot sample**, which shows how to integrate the GDK, XBOX services, and PlayFab into a Godot project, and explains where to find guidance for shipping a Godot game to XBOX Series X|S or XBOX One.

Godot is one of several engines you can use with the GDK. For an overview of the engine options and how the GDK fits into each one, see [Microsoft Game Development Kit and game engines](/build/gdk-and-engines/gdk-and-engines).

## XBOX Godot sample

The [XBOX Godot sample](https://aka.ms/XBOXGodotSample) is a public, source-only reference on GitHub. It is a working example of how you can build a Godot extension that integrates the Microsoft GDK, XBOX services, and PlayFab. You can build your title for XBOX on PC without leaving the engine you already love. This sample provides a modular reference that includes how to integrate the Microsoft GDK and PlayFab SDK together, or on their own.

<Tip>
  The **v0.2.0 & v0.3.0** releases add PlayFab Party chat indicators, voice controls, text-to-speech, and network diagnostics, complete the XUser API wrappers, add Godot .NET (C#) support, broaden GDK and Godot version compatibility, and expand GDK API reference coverage to 100%, along with community-reported fixes. For details on these releases, see [Release notes](#release-notes).
</Tip>

<Note>
  **v0.3.0 contains a breaking change.** Every script-visible type in the GDK addon was renamed, for example `GDKUser` is now `XboxUser`, and the C# namespace `GodotGdk` is now `GodotXbox`. No deprecated aliases are provided, so existing projects must update their type references before they will load. The engine singleton is still named `GDK`, so calls such as `GDK.initialize()` are unaffected. The sample ships a codemod to automate most of the change. For details, see [Breaking change: GDK addon type rename](/build/gdk-and-engines/godot-release-notes/godot-release-notes-0-3-0#breaking-change-gdk-addon-type-rename).
</Note>

### What's included

The XBOX Godot sample covers a substantial portion of what a Godot game developer needs to build for XBOX on PC, with key features demonstrated in:

* Microsoft GDK platform services
* XBOX services
* PlayFab Core + Services
* PlayFab Multiplayer (Lobby, Matchmaking, Party)
* PlayFab Game Saves
* GameInput (including bridging to Godot's Input / InputMap)

Starting with v0.2.0, the sample also supports Godot .NET (C#) projects through a managed C# track, in addition to GDScript.

From XBOX services to GameInput, this sample shows you how to bring sign-in, gamepad controller support capabilities and more into your game with Godot. It includes insights and re-usable integration code, and supports a broad range of GDK editions and Godot versions out of the box. For the specific editions and versions validated in each release, see [Release notes](#release-notes).

### What this is and what it isn't

* This is a source-only sample, not a product. It's MIT-licensed at the wrapper layer; the GDK and PlayFab dependencies still require their own installs and license acceptance, consistent with our other XBOX samples.
* There is no set update cadence for support or maintenance. We'll watch the repo, monitor issues, and iterate where it makes sense, but this isn't a commercial release. That said, we're excited to hear your feedback, and see any community PRs, as we evolve this together.
* This is the first step in bringing Godot for XBOX on PC. We plan to evolve it over time based on what the community tells us is most valuable.
* This sample is built specifically for XBOX on PC. It doesn't include support for XBOX Series X|S or XBOX One. For information about console support, see the XBOX Series X|S and XBOX One support section below.

### Get started

Use these resources to clone the repository, build the extension, and start integrating with your Godot project:

* **XBOX Godot Sample:** [XBOX Godot Sample](https://aka.ms/XBOXGodotSample) - An example implementation binding the Microsoft GDK, PlayFab, and GameInput to Godot.
* **Microsoft GDK:** [microsoft/GDK](https://github.com/microsoft/GDK) - Microsoft Public GDK.
* **PlayFab SDK:** [PlayFab Unified SDK](https://aka.ms/PlayFabUnifiedSDK) - PlayFab Unified SDK.
* **GameInput:** [GameInput](https://aka.ms/GameInput) - A next-generation input API that exposes input devices of all kinds through a single consistent interface.
* **Documentation:** [XBOX Godot Docs](https://aka.ms/XBOXGodotDocs) - Documentation for the Godot XBOX sample.
* **Issues:** [XBOX Godot Issues](https://aka.ms/XBOXGodotIssues) - Report bugs, request features, or contribute back.

After you have integrated the Microsoft GDK with your Godot project, follow the rest of the PC end-to-end guide to register your title, set up your product in Partner Center, and publish your game to the Microsoft Store.

## Release notes

The XBOX Godot sample evolves over time based on community feedback. Per-release notes describe the new features, improvements, and fixes in each version, along with the GDK editions and Godot versions validated for that release.

* [XBOX Godot Sample v0.3.0 Release](/build/gdk-and-engines/godot-release-notes/godot-release-notes-0-3-0)
* [XBOX Godot Sample v0.2.0 Release](/build/gdk-and-engines/godot-release-notes/godot-release-notes-0-2-0)
* [XBOX Godot Sample v0.1.0 Release](/build/gdk-and-engines/godot-release-notes/godot-release-notes-0-1-0)

For the complete history of releases and downloads, see [XBOX Godot sample releases](https://github.com/microsoft/XBOX-Godot-Sample/releases) on GitHub.

## Support for XBOX Series X|S and XBOX One

The XBOX Godot sample is built specifically for XBOX on PC and does not include support for XBOX Series X|S or XBOX One.

Because Godot is open source and MIT-licensed, the Godot Foundation does not officially maintain console export templates. Console SDKs ship under NDA and require legal contracts and closed access that are incompatible with the engine's open development model.

For current details on the console porting process, the list of middleware providers, and links to additional Godot Foundation guidance, see [Godot and console porting](https://godotengine.org/consoles/) on the official Godot Engine website.

If you are already building for XBOX Series X|S or XBOX One, contact your XBOX representative. If you are not yet registered, see Register for the ID\@XBOX program to get started.

## Related topics

* [Microsoft Game Development Kit and game engines](/build/gdk-and-engines/gdk-and-engines)
* [PC end-to-end guide overview](/build/gdk-and-engines/overview)


## Related topics

- [Use the GDK with Unity, Unreal, and other engines](/build/gdk-and-engines/gdk-and-engines.md)
- [XBOX Game Development Documentation](/index.md)
- [Use the GDK with Unity](/build/gdk-and-engines/unity/unity.md)
- [Use the GDK with Unreal Engine](/build/gdk-and-engines/unreal/unreal.md)
- [Use Clang/LLVM with the GDK](/tools/tools-pc/visualstudio/gr-vs-clang.md)
