YouTube 游戏大本营 SDK - 使用入门

YouTube 游戏大本营 SDK 是一种 Web SDK，用于将网页游戏与 YouTube 环境连接起来。该 SDK 具有强大的 API，可通过多种方式支持游戏，从而在 YouTube 上打造出色的游戏体验。

将 Playables SDK 添加到您的游戏

游戏应在根目录中包含一个 index.html 文件。如需导入 YouTube 游戏大本营 SDK，请在任何游戏代码之前添加以下这行代码：

<script src="https://www.youtube.com/game_api/v1"></script>

当您的游戏在本地提供时，SDK 会作为空操作运行。如需验证 SDK 集成的正确性，请参阅测试套件指南。

与 Playables SDK 集成

与 Playables SDK 集成时，需要进行一些集成，也可以选择进行一些集成。

集成要求

请全面查看发布要求，重点关注集成 要求。如需了解实现详情，请参阅 Playables SDK 参考文档。

例如：

  • ytgame.game.firstFrameReady()
  • ytgame.game.gameReady()
  • ytgame.IN_PLAYABLES_ENV
  • ytgame.system.isAudioEnabled()
  • ytgame.system.onAudioEnabledChange((isAudioEnabled) => {})
  • ytgame.system.onPause(() => {})
  • ytgame.system.onResume(() => {})
  • ytgame.game.loadData()
  • ytgame.game.saveData(data)

除了集成要求之外，您还可以使用其他几个函数来打造极具吸引力的体验。例如：

  • ytgame.system.getLanguage() - 使用此函数可检索用户的当前 语言区域设置。请勿使用其他函数或将语言存储在云端存档中，因为语言随时可能会发生变化。
  • ytgame.engagement.sendScore({ value: newScore }) - 将最佳得分发送到 YouTube 以供显示。
  • ytgame.engagement.openYTContent({ id: videoID }) - 打开 YouTube 视频。
  • ytgame.health.logError() 和 ytgame.health.logWarning() - 将问题记录到 YouTube。

如需了解实现详情和其他 函数，请参阅 Playables SDK 参考文档。

TypeScript 类型定义

对于使用 TypeScript 的游戏，请下载类型定义。

示例游戏

我们提供了多个示例，演示了如何与 YouTube 游戏大本营 SDK 集成，包括纯 JavaScript、Flutter Web、Godot 和 Unity。

使用测试套件测试游戏

准备就绪后，您可以使用测试套件验证集成。如需了解具体方法，请参阅测试套件指南。