如何为您的多人集换式卡牌游戏 (TCG) 集成匹配系统

-> 本文基于匹配文档。如果您遇到问题或发现差异，请务必参考原始指南，因为那里的内容更新更频繁。

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

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

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

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

只需五个步骤即可将我们的匹配器实现到您的游戏中：

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

2. 现在，绝不应该盲目套用在网上找到的 JSON 示例，因此强烈建议根据您的游戏调整上述规则。步骤 2（“探索配置”）是我们的“使用指南”，深入介绍了各项匹配规则的功能（“探索配置”）。

3. 步骤 3（“查看实例详情”）涵盖了针对您个人、特定的匹配器，以确保其已部署并与您的游戏设计相配合。

4. 步骤 4 正如其名（“4. 测试票证 API”），完全是关于测试来自玩家的匹配请求是否被匹配器接收，这些请求被称为票证。

5. 步骤 5（“在游戏中集成匹配”）重点介绍了如何在您的引擎项目中集成匹配器。

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

1. 设置免费层

注册您的免费 Edgegap 账户，然后导航至 Matchmaker 控制面板页面。

在该页面中，先点击 Create Matchmaker，然后输入：

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

• 然后，上传以下简单的 JSON 配置示例，用于您的 TCG 游戏：

{
  "version": "1.0.0",
  "max_deployment_retry_count": 3,
  "ticket_expiration_period": "5m",
  "ticket_removal_period": "1m",
  "profiles": {
    "casual-example": {
      "application": {
        "name": "my-game-server=>CHANGE-THIS-NAME-HERE",
        "version": "2024.01.30-16.23.00-UTC=>CHANGE-THIS-HERE "
      },
      "rules": {
        "initial": {
          "match_size": {
            "type": "player_count",
            "attributes": {
              "team_count": 2,
              "team_size": 5
            }
          },
          "beacons": {
            "type": "latencies",
            "attributes": {
              "difference": 25,
              "max_latency": 100
            }
          },
          "league_rank": {
            "type": "number_difference",
            "attributes": {
              "max_difference": 1
            }
          },
          "selected_maps": {
            "type": "intersection",
            "attributes": {
              "overlap": 1
            }
          },
          "selected_beacons": {
            "type": "intersection",
            "attributes": {
              "overlap": 1
            }
          }
        },
        "expansions": {
          "10": {
            "beacons": {
              "difference": 40,
              "max_latency": 150
            }
          },
          "30": {
            "beacons": {
              "difference": 50
            }
          },
          "60": {
            "league_rank": {
              "max_difference": 2
            }
          },
          "180": {
            "beacons": {
              "difference": 100,
              "max_latency": 500
            }
          }
        }
      }
    },
    "competitive-example": {
      "application": {
        "name": "my-game-server",
        "version": "2024.01.30-16.23.00-UTC"
      },
      "rules": {
        "initial": {
          "match_size": {
            "type": "player_count",
            "attributes": {
              "team_count": 2,
              "team_size": 5
            }
          },
          "beacons": {
            "type": "latencies",
            "attributes": {
              "difference": 25,
              "max_latency": 100
            }
          },
          "league_rank": {
            "type": "number_difference",
            "attributes": {
              "max_difference": 0
            }
          },
          "selected_maps": {
            "type": "intersection",
            "attributes": {
              "overlap": 1
            }
          },
          "selected_beacons": {
            "type": "intersection",
            "attributes": {
              "overlap": 1
            }
          }
        },
        "expansions": {
          "30": {
            "beacons": {
              "difference": 40,
              "max_latency": 150
            }
          },
          "60": {
            "beacons": {
              "difference": 50
            }
          },
          "180": {
            "beacons": {
              "max_latency": 250
            }
          }
        }
      }
    },
    "challenger-example": {
      "application": {
        "name": "my-game-server",
        "version": "2024.01.30-16.23.00-UTC"
      },
      "rules": {
        "initial": {
          "match_size": {
            "type": "player_count",
            "attributes": {
              "team_count": 2,
              "team_size": 5
            }
          },
          "beacons": {
            "type": "latencies",
            "attributes": {
              "difference": 25,
              "max_latency": 100
            }
          },
          "league_rank": {
            "type": "number_difference",
            "attributes": {
              "max_difference": 0
            }
          },
          "selected_maps": {
            "type": "intersection",
            "attributes": {
              "overlap": 1
            }
          },
          "selected_beacons": {
            "type": "intersection",
            "attributes": {
              "overlap": 1
            }
          }
        },
        "expansions": {
          "30": {
            "beacons": {
              "difference": 40,
              "max_latency": 150
            }
          },
          "180": {
            "beacons": {
              "difference": 50
            }
          },
          "240": {
            "beacons": {
              "max_latency": 250
            }
          }
        }
      }
    }
  }
}

（温馨提示：请务必修改应用程序 name 和 version 以匹配您的 应用程序和版本！）

如果没有出现验证错误，请点击 Create and Start 并等待过程完成。这将启动一个新的免费集群，其中包含您的简易示例匹配器。

您现在可以继续进行下一步。

2. 探索配置​

独特的 TCG 游戏规则

专门针对 TCG 游戏，您可以为游戏模式特定的规则和设置定义多个匹配配置文件：

• 在较休闲的游戏中，将两名玩家之间的段位分差限制在一定范围内，

• 在排位赛中，限制段位差异仅允许相同段位的对手匹配，

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

• 添加 Hub 选择 UI 以将对手限制在指定的 Ping 信标，

• 将匹配延迟限制在最大阈值以内，以防止与较远的玩家匹配，

• 将匹配延迟差异限制在最大范围内，以最大化 Ping 公平性，

• 在允许更多玩家加入时，使用不同的 App 版本分配更多 CPU 或内存，

• 针对预组队大厅使用作为队伍加入，或在不超出队伍人数上限的情况下填满队伍。

从理想条件开始，然后放宽限制以确保快速匹配：

• 随时间逐渐放宽延迟限制，以寻找更多玩家，

• 随时间逐渐增加允许的段位分差，以寻找更多玩家，

• 由于高段位（挑战者）可用玩家较少，延长每次放宽限制之间的间隔时间。

为晋级赛创建具有更高段位的票证，以便与更强劲的对手匹配。

定义单独的作弊者配置文件，以确保被标记的作弊者或受到大量管理举报的玩家不会对排位赛中正常玩家的体验产生负面影响。

语义化版本控制

每个新版本都使用语义化版本控制，通过解释 major.minor.patch 格式来清晰传达更改的影响：

• major 版本包含重大破坏性更改，需要进行集成审查，

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

• patch 版本包含问题修复和细微改进。

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

为了确保客户端意外崩溃或被遗弃的票证不会一直滞留并占用您的匹配器资源，票证将在 ticket_expiration_period 后被取消，导致其状态变为 CANCELLED，然后在 ticket_removal_period 后被永久删除。

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

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

• 您选择的名称，例如 match size，

• 规则类型，也称为运算符，例如 player_count，

• 最后是运算符属性，例如 team_count 或 team_size。

玩家数量规则

这是一条特殊规则，定义了需要匹配多少名玩家才能启动分配：

• team_count 指队伍数量，合作或混战（全员对抗）模式可以使用 1 支队伍，

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

我们的简易示例演示了 2 名玩家的合作游戏。

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

延迟规则

使用此规则为所有玩家提供尽可能低的 Ping。一旦客户端针对所有可用信标测量并提交其往返时间 (ping)，Gen2 将仅考虑在针对Ping 信标测得的特定 difference（差值）以内的匹配。这为划分玩家群体提供了一种“软性”解决方案，允许与邻近区域进行匹配，尤其可以提高人口较少区域的匹配速度。使用 max_latency 可防止与地理位置过远的玩家进行匹配。

您现在可以继续进行下一步。

我们上面示例中的 beacons 规则初始为 "difference": 50, "max_latency": 200：

• Alice 和 Bob 可以匹配，因为 Beijing 被丢弃（>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 无法匹配，因为 Dallas 信标的 | 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. 查看实例详情​

新匹配器初始化后，在我们的控制面板中查看其详细信息：

Status 指示服务运行状况，可能是 ONLINE、OFFLINE 或 ERROR。

• Identifier 有助于 Edgegap 工作人员在您需要排查故障时快速找到您的匹配器。

• Started at 可用于追踪最新的更新时间。

• Size 对应我们的定价层之一。

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

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

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

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

您现在可以继续进行下一步。

4. 测试票证 API

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

点击“Matchmaker”标题下方的 /...swagger.json URL 打开原始 JSON 架构：

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

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

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

• 保持选择 Postman Collection，

• 选择 View Import Settings 并将设置 Parameter generation 更改为 Example。

确认导入，这将在左侧集合列表中显示一个标题为 Matchmaker 的新集合。

View more actions，打开标签页 Authorization 并选择：

• Auth Type - API Key，

• Key - “Authorization”

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

• Add to - Header。

按 (CTRL/CMD+S) 或保存图标以保存更改。Postman 标签页中的橙色圆点应该会消失。

在您的 Matchmaker 集合中，选择 tickets 和 Create a matchmaking ticket，打开一个新标签页。

选择标签页 Body 以预览您的玩家票证请求：

注意 player_ip 设置为 null——这将使用自动添加到请求中的 IP 地址（其他备选方案请参见服务器到服务器集成），

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

• attributes 包含您的匹配器规则的值，在此示例中为 latencies 规则，

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

注意：请务必参考示例的Swagger 导入配置。 

点击 Send 并查看对您的玩家票证请求的响应：

• id 是您的唯一匹配票证 ID，请妥善保存以便稍后查询票证，

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

• group_id 是发放给每张票证的唯一队伍 ID，单人玩家表示为 1 人的队伍，

  • 关于与好友或大厅一起匹配，请参见作为队伍加入，

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

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

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

• status 指示票证的当前状态，所有票证开始时均为 SEARCHING（详情请参见匹配流程）。

再次点击 Send 创建第二张票证，以便我们的两名玩家进行匹配并启动服务器。

在您的 Matchmaker 集合中，选择 {ticketId} 和 Read a matchmaking ticket。

输入上一步响应中的票证 ID，然后点击 Send。

查看您的玩家票证的更新后分配情况：

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

再次点击 Send 检查您的票证，并查看玩家票证的更新后分配：

• 状态变更为 HOST_ASSIGNED，并且 assignment 包含所分配服务器的详细信息。

 在我们的控制面板中检查您的新部署：

• 注意每个部署都会标记所有票证 ID 和配置文件，以增加可追溯性。

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

一旦您验证能够顺利连接到部署并完成测试，请停止您的部署，以释放账户中的容量供下一次构建使用。

您现在可以继续进行下一步。

5. 在您的游戏中集成匹配器​

Edgegap 的匹配系统集成了：

• 与游戏客户端集成，以管理玩家票证，

• 与游戏服务器集成，以：

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

  • 可选支持补位以在开始后添加或替换玩家。

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

• Edgegap - Unity Gen2 匹配 SDK，

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

• Betide Studio - Unreal Engine Edgegap 集成套件，

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

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

• HTTP 404 Not Found - 票证已被删除，

• HTTP 500 Internal Server Error - 服务临时中断。

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

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

2. 读取 注入的环境变量 (App 版本) 以获取特定于版本的参数、设置（玩家容量）和机密信息。

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

玩家连接后，游戏服务器和游戏客户端将启动加载场景以执行同步步骤（例如选择并加载地图/场景/关卡）。我们建议使用成熟的 3D 场景、类似大厅的社交 UI 或带有进度条的加载界面，以表明初始化正在进行中。

一旦游戏客户端完全加载，玩家即可加载/传送至主游戏场景。

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

确保在以下情况下，使用 注入的 DELETE_URL 正确停止您的部署：

• 没有玩家加入对战，

• 所有玩家都已离开对战，

• 对战正常结束。

恭喜，您已完成 Edgegap Matchmaker 集成！如果您想了解更多信息，请在我们的学习中心阅读所有相关内容。