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

-> 本文基于 匹配文档。如果您遇到问题或不一致，请确保参考 原始指南，因为它们更频繁地保持更新。

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

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

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

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

有 五个步骤 将我们的匹配器实施到您的游戏中：

1. 第一步是 创建一个帐户 并使用我们的派对游戏示例。 好吧，您（从技术上讲）已经完成了一半！您只需要将匹配器集成到您的游戏中（请参见第5步）。

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

3. 第三步（“审查实例详细信息”）涵盖您个人的特定匹配器，以确保它被部署并与您游戏的设计相适应。

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

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

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

1. 设置免费层

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

在此，首先单击 创建匹配器 ，然后输入：

• 您的匹配器名称 - 这仅仅是为了您自己的参考，例如 quickstart-dev，

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

{
  "version": "2.1.0",
  "inspect": true,
  "max_deployment_retry_count": 3,
  "ticket_expiration_period": "5m",
  "ticket_removal_period": "1m",
  "profiles": {
    "cooperative-example": {
      "application": {
        "name": "my-game-server=>CHANG-THIS-HERE",
        "version": "2024.01.30-16.23.00-UTC=>CHANG-THIS-HERE"
      },
      "rules": {
        "initial": {
          "match_size": {
            "type": "player_count",
            "attributes": {
              "team_count": 1,
              "team_size": 4
            }
          },
          "beacons": {
            "type": "latencies",
            "attributes": {
              "difference": 60,
              "max_latency": 60
            }
          },
          "selected_map": {
            "type": "intersection",
            "attributes": {
              "overlap": 1
            }
          },
          "selected_difficulty": {
            "type": "string_equality"
          },
          "player_level": {
            "type": "number_difference",
            "attributes": {
              "max_difference": 10
            }
          }
        },
        "expansions": {
          "5": {
            "beacons": {
              "difference": 80,
              "max_latency": 80
            }
          },
          "10": {
            "player_level": {
              "max_difference": 20
            }
          },
          "20": {
            "match_size": {
              "team_count": 1,
              "team_size": 3
            },
            "beacons": {
              "difference": 100,
              "max_latency": 100
            }
          },
          "30": {
            "match_size": {
              "team_count": 1,
              "team_size": 2
            },
            "beacons": {
              "max_latency": 200
            }
          },
          "60": {
            "match_size": {
              "team_count": 1,
              "team_size": 1
            }
          }
        }
      }
    }
  }
}

(温馨提示，请确保将应用程序 name 和 version 更改为匹配您的 应用程序和版本！)

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

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

2. 探索配置​

独特的多人派对游戏规则

特别是对于派对游戏，您可以为游戏模式特定规则和设置定义多个 匹配配置文件：

• 让玩家提供其地图偏好并选择适合所有人的地图，

• 让玩家选择适合每个人技能水平的特定游戏难度，

• 限制玩家等级差异，以便将玩家与游戏进度相似的玩家对齐，

• 以小组方式加入 以便于预先创建的大厅或在不超过队伍人数的情况下填充队伍，

• 允许更高延迟，以优先考虑更快的比赛并提供更好的玩家偏好细化，

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

从理想条件开始，并 扩展限制 以确保快速比赛：

• 随着时间推移放宽延迟限制以找到更多玩家，

• 逐渐减少队伍规模以要求更少的玩家并尽早开始游戏，

  • 可选地，您可以让服务器用 AI 队友填充空位，

• 逐渐增加允许的玩家级别差异以找到更多玩家，

• 如果未找到队友，单人启动游戏并使用 补位 稍后添加玩家。

语义版本控制

当我们发布匹配器的更新时，每个新版本使用 语义版本控制 清楚地传达更改的影响，通过解释格式 major.minor.patch：

• major 版本包括重大更改，需进行集成审查，

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

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

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

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

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

匹配规则 在初始规则集中必须满足的条件，以便将玩家组合在一起，每个规则由三个属性定义：

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

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

• 最后是操作符属性，例如 队伍数量 或 队伍规模。

玩家数量规则

这是定义需要匹配多少玩家以启动分配的特殊规则：

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

• 队伍规模 指每支队伍的 玩家数量。

我们的简单示例演示了一个合作游戏，包含 2 名玩家。

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

延迟规则

使用此规则为所有玩家提供最低的 ping。 一旦客户端测量并提交其往返时间（ping）与所有可用信标，Gen2 将仅在特定的 difference 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, Beijing: 264.4}; 和

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

• Charlie 和 Dave 将不匹配，因为 | C-D | > 50 的达拉斯信标：

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

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

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

3. 审查实例详细信息​

在我们的仪表板上查看您的新匹配器的详细信息，直到它初始化：

状态 显示服务健康状况，可能是在线、离线或错误。

• 标识符 帮助 Edgegap 员工快速找到您的匹配器，万一您需要帮助进行故障排除。

• 启动于 可以追踪最新更新的时间。

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

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

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

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

要使用 API 测试您的新匹配器， 您将需要 Swagger URL、API URL 和认证令牌。

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

4. 测试票务 API

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

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

将此页面保存为您驱动器上的文件 (CTRL/CMD+S)。

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

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

• 保持选择 Postman Collection ，

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

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

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

• 认证类型 - API 密钥，

• 键 - “授权”

• 值 - 在此处插入您的 AuthToken 值，

• 添加到 - 头部。

按 (CTRL/CMD+S) 或保存图标以 保存更改。您在 Postman 选项卡中的橙点应消失。

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

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

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

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

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

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

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

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

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

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

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

  • 请参见 以小组方式加入 以与您的朋友或大厅进行匹配，

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

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

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

• status 指示票的当前状态，所有票务开始为 SEARCHING （有关详细信息，请参见 匹配过程）。

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

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

输入上一步响应中的票 ID，然后单击 发送。

查看您玩家票的更新分配：

• 状态首先更改为 MATCH_FOUND ，同时保持 assignment 设置为 null 以表明玩家已匹配并正在分配服务器，

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

• 状态更改为 HOST_ASSIGNED ，并且 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 匹配器集成！如果您想了解更多，请在我们的 学习中心 中阅读所有内容。