> ## 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.

# 在 Godot 中使用 GDK

> 使用仅提供源代码的 XBOX Godot Sample,将 XBOX GDK、XBOX 服务、PlayFab 与 GameInput 集成到 Godot 项目中,以在 PC 上发布 XBOX 游戏。

本文介绍如何开始使用 Godot 借助 Microsoft Game Development Kit(GDK)为 PC 构建 XBOX 游戏。它会指引你使用 **XBOX Godot 示例**,展示如何将 GDK、XBOX 服务与 PlayFab 集成到 Godot 项目中,并说明在哪里可以找到将 Godot 游戏发布到 XBOX Series X|S 或 XBOX One 的指南。

Godot 只是可与 GDK 搭配使用的多种引擎之一。要了解各种引擎选项以及 GDK 如何融入其中,参见 [Microsoft Game Development Kit 与游戏引擎](/build/gdk-and-engines/gdk-and-engines)。

## XBOX Godot Sample

[XBOX Godot 示例](https://aka.ms/XBOXGodotSample) 是 GitHub 上一个公开的、仅提供源代码的参考实现。它是一个可运行的示例,展示开发者如何构建一个 Godot 扩展,将 Microsoft GDK、XBOX 服务与 PlayFab 集成起来,让你可以在自己熟悉的引擎中为 PC 上的 XBOX 构建作品。该示例提供了一个模块化的参考,展示了如何将 Microsoft GDK 与 PlayFab SDK 一起集成,或各自单独集成。

<Tip>
  **v0.2.0 与 v0.3.0** 版本新增了 PlayFab Party 聊天指示器、语音控制、文本转语音与网络诊断,补齐了 XUser API 封装,新增了 Godot .NET(C#)支持,扩展了 GDK 与 Godot 版本的兼容性,并将 GDK API 参考覆盖率扩展至 100%,同时还包含来自社区反馈的修复。有关这些版本的详情,请参见 [发布说明](#release-notes)。
</Tip>

<Note>
  **v0.3.0 包含重大变更。** GDK 附加组件中每个脚本可见类型均已重命名,例如 `GDKUser` 现为 `XboxUser`,C# 命名空间 `GodotGdk` 现为 `GodotXbox`。未提供已弃用的别名,因此现有项目必须先更新其类型引用才能加载。引擎单例仍名为 `GDK`,因此 `GDK.initialize()` 等调用不受影响。示例中随附了一个 codemod 可自动完成大部分变更。详情参见 [重大变更:GDK addon 类型重命名](/build/gdk-and-engines/godot-release-notes/godot-release-notes-0-3-0#breaking-change-gdk-addon-type-rename)。
</Note>

### 包含的内容

XBOX Godot 示例覆盖了 Godot 游戏开发者构建 PC 上 XBOX 作品所需的大部分内容,包含如下关键功能演示:

* Microsoft GDK 平台服务
* XBOX 服务
* PlayFab Core + Services
* PlayFab Multiplayer(Lobby、Matchmaking、Party)
* PlayFab Game Saves
* GameInput(包括桥接到 Godot 的 Input / InputMap)

从 v0.2.0 开始,除了 GDScript,示例还通过 C# 托管路径支持 Godot .NET(C#)项目。

从 XBOX 服务到 GameInput,本示例展示了如何在 Godot 中为你的游戏引入登录、手柄支持等能力。它包含洞察与可复用的集成代码,并开箱支持广泛的 GDK 版本与 Godot 版本。每个版本所验证的具体 GDK 与 Godot 版本参见 [发布说明](#release-notes)。

### 它是什么,不是什么

* 这是一个仅提供源代码的示例,而不是产品。包装层采用 MIT 许可证;GDK 与 PlayFab 依赖仍需各自的安装与许可证接受,与我们其他 XBOX 示例一致。
* 没有固定的支持或维护更新节奏。我们会关注仓库、跟进 issue,并在合理的地方进行迭代,但这并不是商业版本发布。尽管如此,我们非常乐于听到你的反馈,并欢迎社区 PR,与大家一起共同演进这个项目。
* 这是把 Godot 引入 PC 上 XBOX 的第一步。我们计划根据社区反馈随时间不断改进。
* 本示例专为 PC 上的 XBOX 构建,不包含对 XBOX Series X|S 或 XBOX One 的支持。有关主机支持的信息,请参阅下方的 XBOX Series X|S 与 XBOX One 支持一节。

### 快速开始

使用这些资源克隆仓库、构建扩展并开始与你的 Godot 项目集成:

* **XBOX Godot Sample:** [XBOX Godot Sample](https://aka.ms/XBOXGodotSample) - 将 Microsoft GDK、PlayFab 与 GameInput 绑定到 Godot 的示例实现。
* **Microsoft GDK:** [microsoft/GDK](https://github.com/microsoft/GDK) - Microsoft 公共 GDK。
* **PlayFab SDK:** [PlayFab Unified SDK](https://aka.ms/PlayFabUnifiedSDK) - PlayFab 统一 SDK。
* **GameInput:** [GameInput](https://aka.ms/GameInput) - 通过统一一致的接口暴露各类输入设备的下一代输入 API。
* **Documentation:** [XBOX Godot Docs](https://aka.ms/XBOXGodotDocs) - Godot XBOX 示例的文档。
* **Issues:** [XBOX Godot Issues](https://aka.ms/XBOXGodotIssues) - 报告 bug、提出功能请求或贡献代码。

将 Microsoft GDK 集成到 Godot 项目后,请遵循 PC 端到端指南的其他部分,注册作品、在 Partner Center 中配置产品,并将游戏发布到 Microsoft Store。

## 发布说明

XBOX Godot 示例会根据社区反馈不断演进。每个版本的发布说明描述该版本中的新功能、改进与修复,以及该版本所验证的 GDK 与 Godot 版本。

* [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)

完整的发布历史与下载,请见 GitHub 上的 [XBOX Godot sample releases](https://github.com/microsoft/XBOX-Godot-Sample/releases)。

## 对 XBOX Series X|S 与 XBOX One 的支持

XBOX Godot 示例专为 PC 上的 XBOX 构建,不包含对 XBOX Series X|S 或 XBOX One 的支持。

由于 Godot 是开源且采用 MIT 许可证,Godot Foundation 不会官方维护主机导出模板:主机 SDK 是在保密协议下分发的,需要与引擎的开放开发模型不兼容的法律合同与封闭访问权限。

有关主机移植流程、中间件供应商列表以及来自 Godot Foundation 的其他指南,请参阅 Godot Engine 官方网站上的 [Godot and console porting](https://godotengine.org/consoles/)。

如果你已经在为 XBOX Series X|S 或 XBOX One 构建作品,请联系你的 XBOX 代表。如果尚未注册,请参见 Register for the ID\@XBOX program 开始注册。

## 相关主题

* [Microsoft Game Development Kit 与游戏引擎](/build/gdk-and-engines/gdk-and-engines)
* [PC 端到端指南概览](/build/gdk-and-engines/overview)


## Related topics

- [在 Unity、Unreal 及其他引擎中使用 GDK](/zh-CN/build/gdk-and-engines/gdk-and-engines.md)
- [在 Unity 中使用 GDK](/zh-CN/build/gdk-and-engines/unity/unity.md)
- [在 GDK 中使用 Clang/LLVM](/zh-CN/tools/tools-pc/visualstudio/gr-vs-clang.md)
- [在 Unreal Engine 中使用 GDK](/zh-CN/build/gdk-and-engines/unreal/unreal.md)
- [在 GameMaker 中使用 GDK](/zh-CN/build/gdk-and-engines/gamemaker.md)