如何将匹配系统集成到您的休闲多人游戏中

-> 本文基于 匹配系统文档。如果您遇到问题或差异，请确保查阅 原始指南，因为它们更新得更频繁。

以下示例将帮助您测试核心 匹配 玩家流，即：

• 在共享的 托管集群上创建匹配器实例，

• 在您的匹配器 配置中定义规则和设置，

• 最后，测试玩家流并通过我们的 API 管理 玩家票务。

有 五个步骤 将我们的匹配系统集成到您的游戏中：

1. 第一步是 创建一个账户 并使用我们的休闲游戏示例。 瞧，您（从技术上讲）已经完成了一半！您只需在您的游戏中集成匹配器即可（见第5步）。

2. 现在，您绝不应该盲目遵循在互联网上找到的 JSON 示例，因此强烈建议您根据游戏的回合制特性调整上述规则。第2步（“探索配置”）是我们的“如何阅读”，它解释了每个 匹配系统 规则 功能（“探索配置”）。

3. 第3步（“审查实例详情”）涵盖了您个人的具体 匹配器，以确保其部署并与您的游戏设计兼容。

4. 第4步，顾名思义（“4. 测试票务API”），全是关于测试玩家的匹配请求是否被匹配器接收的，称为 票务。

5. 第5步（“将匹配系统集成到您的游戏中”）强调如何在您引擎的项目中集成匹配器。

如果您遇到故障排除挑战，我们深入的 学习中心 提供了额外的故障排除提示。

1. 设置免费套餐

注册您的免费 Edgegap 账户，并导航到 匹配器仪表板页面。

从那里，首先单击 创建匹配器 ，然后输入：

• 您的匹配器名称 - 这仅供您参考，例如 快速入门-dev，

• 然后，以下述简单示例上传作为您的休闲游戏的 JSON 配置：

{
  "version": "2.1.0",
  "inspect": true,
  "max_deployment_retry_count": 3,
  "ticket_expiration_period": "5m",
  "ticket_removal_period": "1m",
  "profiles": {
    "social-example": {
      "application": {
        "name": "my-game-server==>CHANGE-THIS",
        "version": "2024.01.30-16.23.00-UTC==>CHANGE-THIS"
      },
      "rules": {
        "initial": {
          "match_size": {
            "attributes": {
              "team_count": 1,
              "team_size": 30
            },
            "type": "player_count"
          },
          "beacons": {
            "attributes": {
              "difference": 80,
              "max_latency": 80
            },
            "type": "latencies"
          },
          "selected_region": {
            "type": "string_equality",
            "attributes": {
              "overlap": 1
            }
          },
          "selected_mode": {
            "type": "intersection",
            "attributes": {
              "overlap": 1
            }
          }
        },
        "expansions": {
          "10": {
            "beacons": {
              "difference": 100,
              "max_latency": 100
            },
            "match_size": {
              "team_count": 1,
              "team_size": 20
            }
          },
          "15": {
            "beacons": {
              "difference": 120,
              "max_latency": 120
            },
            "match_size": {
              "team_count": 1,
              "team_size": 10
            }
          },
          "25": {
            "match_size": {
              "team_count": 1,
              "team_size": 4
            }
          },
          "30": {
            "match_size": {
              "team_count": 1,
              "team_size": 1
            }
          }
        }
      }
    }
  }
}

（温馨提醒，请确保更改应用程序 名称 和 版本 以匹配您的 应用程序和版本！）

如果没有出现验证错误，请点击 创建并启动 ，并等待过程完成。这将导致一个新的免费集群启动，包含您的简单示例匹配器。

您现在可以继续到下一步。

2. 探索配置​

独特的多人休闲游戏规则

团队数量为 1，团队规模为 50，每个游戏需要 50 名玩家（所有玩家在同一团队中）。

特别针对社交游戏，您可以为游戏模式定义 匹配配置文件 的特定规则和设置：

• 让玩家提供他们的游戏模式偏好并选择适合所有人的模式，

• 作为小组加入 以用于预制大厅或填补团队而不超过团队规模，

• 添加 🗺️ 区域选择 UI ，以将对手限制在指定区域，

• 允许更高的延迟，以优先考虑与更多玩家一起进行更快的比赛，

• 在允许更多玩家时，使用不同的 🏷️ 应用版本 分配更多的 CPU 或内存。

扩展限制 以确保快速匹配：

• 快速放宽延迟限制以找到更多玩家，

• 逐步减少团队规模，以要求更少的玩家并尽快开始游戏，

  • 可选择，您可以让服务器用 AI 玩家填补空缺，

• 如果没有找到队友，单人发起游戏并使用 回填 后续添加玩家，

  • 这将允许玩家加入现有比赛，而不是新比赛，以最大化社交互动。

语义版本控制

随着我们向匹配器发布更新，每个新版本均使用 语义版本控制 来通过解释格式 major.minor.patch 明确传达变更的影响：

• major 版本包括破坏性变更，需进行集成评审，

• minor 版本包括实质性的向后兼容改进，

• patch 版本包括错误修复和小改进。

某些 部署可能会导致错误。我们尝试通过自动重试部署最多 max_deployment_retry_count 次来解决此问题（无需客户确认）。

为确保意外的客户崩溃或被遗弃的票务不会滞留并占用您的匹配资源，票务将在 ticket_expiration_period 后被取消，其状态将更改为 已取消 ，然后在 ticket_removal_period 后永久删除。

我们的匹配逻辑核心配置在 匹配配置文件中。每个配置文件都是一个完全独立的匹配队列，指向具有预定义的所需 CPU 和内存（RAM）资源的 应用版本。

匹配规则 在初始规则集中必须满足玩家在一起被分组的要求，每个通过三个属性定义：

• 您选择的名称，例如 - 匹配大小，

• 规则类型，也称为运算符，例如 - 玩家数量，

• 最后是运算符属性，例如 团队数量 或 团队规模。

玩家数量规则

这是一个特殊规则，定义匹配所需的玩家数量以启动分配：

• 团队数量 指的是团队数量，1 个团队可用于合作或自由竞技模式，

• 团队规模 指的是 每个团队的玩家数量。

我们的简单示例演示了一个 2 人合作游戏。

请注意，“玩家数量”规则 是必需的，并且只能在您的初始配置规则中定义一次。

延迟规则

使用此规则为所有玩家提供最低的 ping 值。客户端一旦测量并提交他们相对所有可用信标的往返时间（ping），Gen2 只会考虑在特定的 差异 ping 值范围内的比赛，该值是与 Ping信标 进行比较的。这为分隔您的玩家基础提供了一种“软”的解决方案，允许与邻近地区的匹配，特别改善了人少地区的匹配速度。使用 max_latency防止与远离的玩家匹配。

您现在可以继续到下一步。

我们上面的示例 信标 规则为 "difference": 50, "max_latency": 200 初步：

• Alice 和 Bob 将匹配，因为北京被丢弃（>200），其余的在 | A-B | < 50 之内：

  • Alice {Montreal: 12.3, Newark: 45.6, Dallas: 59.9, 北京: 264.4}; 和

  • Bob {Montreal: 27.3, Newark: 32.4, Dallas: 23.1, 北京: 252.2}。

• Charlie 和 Dave 将无法匹配，因为 | C-D | > 50，Dallas 信标：

  • Alice {Montreal: 5.7, Newark: 44.2, Dallas: 59.5, 北京: 263.2}; 和

  • Bob {Montreal: 57.8, Newark: 32.0, Dallas: 24.2, 北京: 272.3}。

请注意，“延迟规则” 只能在您的初始配置规则中定义一次。

3. 审查实例详情​

在我们的仪表板中审查您新匹配器的详细信息，一旦它初始化：

状态 表示服务健康情况，可能为 ONLINE，OFFLINE 或 ERROR。

• 标识符 有助于 Edgegap 工作人员快速找到您的匹配器，如果您需要故障排除帮助。

• 开始于 可用于追踪最新更新的时间。

• 大小 对应于我们的 定价层级。

• API URL 将被游戏客户端和游戏服务器用于与 Gen2 进行通信。

• Swagger URL 是我们提供的方便的 openAPI 规范 GUI，用于探索 API 架构。

• Auth Token 是游戏客户端和游戏服务器用于身份验证的唯一秘密令牌。

要使用 API 测试您的新匹配器， 您将需要 Swagger URL、API URL 和 Auth Token。

您现在可以继续到下一步。

4. 测试票务API

首先， 打开您的 Swagger URL 以检查您的 openAPI 架构，在 swagger GUI 中

单击“匹配器”标题下的 /...swagger.json URL 以打开原始 JSON 架构：

将此页面另存为文件到您的驱动器上（CTRL/CMD+S）。

打开您的 Postman 应用程序 并登录到您的免费账户。

从上一步导入您的 swagger.json 文件：

• 保持 Postman 集合 选择，

• 选择 查看导入设置 并将设置 参数生成 更改为 示例。

确认导入，这将导致一个新集合出现在左侧的集合列表中，标题为匹配器。

查看更多操作，打开 授权 选项卡并选择：

• Auth 类型 - API 密钥，

• 密钥 - “授权”

• 值 - 在此输入您的 AuthToken 值，

• 添加到 - 标头.

按（CTRL/CMD+S）或保存图标来 保存更改。您在 Postman 标签中的橙点应消失。

在您的匹配器集合中，选择 票务 和 创建一个匹配票务，打开一个新选项卡。

选择 主体 选项卡以预览您的 玩家票务请求：

注意 player_ip 设置为 null - 这将自动使用添加到您请求中的 IP 地址（请参阅 服务器到服务器集成 以获取替代方案），

• profile 指的是您的 匹配配置文件，

• attributes 包括您的匹配器规则的值，在这种情况下为 延迟 规则，

  • 规则 玩家数量 是唯一不需要在玩家票务中包含任何属性的规则。

注意: 请确保参考示例的 Swagger 的导入配置 。

单击 发送 并查看您玩家票务请求的响应：

• id 是您唯一的匹配票务 ID，保留此 ID 以便稍后检查您的票务，

• profile 确认选择的 匹配配置文件，

• group_id 是发给每个票务的唯一组 ID，单个玩家被表示为一个组，

  • 请参见 作为小组加入 以在与朋友或大厅的匹配中，

• player_ip 是玩家的已解析公共 IP 地址，无论使用何种识别方法，

• assignment 设置为 null 以指示票务尚未匹配或分配给服务器，

• created_at 提供有关玩家票务创建时间的信息，以供游戏 UI 使用，

• status 表示票务的当前状态，所有票务都从 搜索中 开始（请参阅 匹配过程 以获取详细信息）。

通过再次点击 发送 来创建第二个票务，以便我们的两个玩家匹配并启动服务器。

在您的匹配器集合中，选择 {ticketId} 和 读取一个匹配票务。

输入上一步响应中的票务 ID 并点击 发送。

检查您玩家票务的更新分配：

• 状态首先更改为 匹配已找到 ，同时保持 assignment 设置为 null 以指示玩家已匹配并且服务器正在被分配，

再次单击 发送 以检查您的票务，并检查您玩家票务的更新分配：

• 状态更改为 主机已分配 ，附带 assignment 包含分配服务器的详细信息。

 在我们的仪表板中检查您的新部署：

• 注意每个部署都标记了所有票务 ID 和配置文件以增加可追踪性。

尝试从您的游戏客户端连接到分配的服务器。

一旦您确认能够无问题地连接到您的部署并测试完毕， 停止您的部署 以释放您账户中的容量，用于下一个构建。

您现在可以继续到下一步。

5. 将匹配系统集成到您的游戏中​

Edgegap 的匹配系统集成：

• 与 游戏客户端 一起，管理 玩家票务，

• 与 游戏服务器 一起，以：

  • 处理通过其票务传递的玩家偏好，

  • 可选择支持 回填 以在启动后添加或替换玩家。

对于 游戏客户端，我们建议在 匹配过程 中，通过游戏内 UI 向玩家提供票务状态更新，以获得最佳的玩家体验。请参见：

• Edgegap - Unity Gen2 匹配 SDK，

  • 导入简单示例 并根据您的需要进行定制，

• Betide Studio - Unreal Engine Edgegap 集成工具包，

  • 下载示例项目 并根据您的需要进行定制。

在 游戏客户端中，确保您处理不可重试的错误：

• HTTP 404 未找到 - 票务已被删除，

• HTTP 500 内部服务器错误 - 临时服务中断。

在 游戏服务器中，处理玩家偏好和初始服务器上下文。无需 API 集成：

1. 读取 注入环境变量 (Gen2) 以检索初始玩家的匹配数据。

2. 读取 注入环境变量 (应用版本) 获取特定版本的参数、设置（玩家容量）和密钥。

3. 读取 注入环境变量 (部署) 以获取有关部署的信息，例如 IP 地址、位置或更多。

一旦玩家连接， 游戏服务器和游戏客户端 开始加载场景以执行同步步骤（例如，选择和加载地图/场景/关卡）。我们建议使用完整的 3D 场景、类似大厅的社交 UI 或带进度条的加载屏幕，以指示正在进行初始化。

一旦 游戏客户端 完全加载，玩家加载/前往主要游戏场景。

可选择， 游戏服务器 可以创建和管理 回填 以及玩家容量（添加或替换离开的玩家）。

确保您的 部署将被停止 ，通过使用 注入的 DELETE_URL ，如果：

• 没有玩家加入比赛，

• 所有玩家已离开比赛，

• 比赛正确结束。

恭喜，您已经完成了 Edgegap 匹配器的集成！如果您想了解更多信息，请在我们的 学习中心 中阅读。