了解Edgegap的工作原理

了解Edgegap的工作原理

如何在MMO游戏中添加匹配系统

已发布

已发布

已发布

如何在MMO游戏中添加匹配系统

关键洞察

关键洞察

关键洞察

Edgegap 的 匹配系统 是一个完全托管、无限自定义的匹配系统,能够优化全球玩家的分组——在开发你的休闲多人游戏期间使用是免费的。

这也是我们所知道的 唯一 拥有 基于延迟的匹配规则 的匹配系统,能够为你的游戏提供理想的在线多人体验,无论使用何种引擎(Unity、Unreal 等)或游戏服务(EOS、UGS、PlayFab、Heroic Labs Nakama、Braincloud 等)。

由于我们的匹配系统基于参数,因此无需编写代码。集成非常简单,如果需要,我们的 入门指南 将在每一步中指导你。

当你的游戏上线时,由于我们的匹配系统是完全托管的,你无需处理基础设施、错误、停机、可扩展性或数据库管理。我们会为你处理所有的事情。将你的 DevOps 工作负载减少到几乎为零。

如何将匹配集成到您的 MMO 多人游戏中

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

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

将我们的匹配器实现到您的游戏中共有五个步骤:

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

  2. 现在,切勿盲目遵循在网上找到的 JSON 示例,因此强烈建议针对您的回合制游戏调整上述规则。步骤 2(“探索配置”)是我们的“阅读指南”,深入探讨了各项匹配规则的功能(“探索配置”)。

  3. 步骤 3(“查看实例详情”)涵盖了您个人专属的匹配器,以确保其已部署并与您的游戏设计协同工作。

  4. 步骤 4 正如其名(“4. 测试票据 API”),主要是测试玩家发出的匹配请求是否被匹配器接收,这些请求被称为票据。

  5. 步骤 5(“在游戏中集成匹配”)重点介绍如何在引擎项目中集成匹配器。

如果您遇到疑难解答方面的挑战,我们深入的学习中心提供了额外的排错提示。

1. 设置免费层

注册您的免费 Edgegap 账户,然后导航至匹配器仪表板页面。

在页面中,首先点击 Create Matchmaker,然后输入:

  • 匹配器的名称 —— 仅供您个人参考,例如 quickstart-dev,

  • 然后,上传以下简单的 JSON 配置示例作为您的 MMO 游戏配置:

{
  "version": "2.1.0",
  "inspect": true,
  "max_deployment_retry_count": 3,
  "ticket_expiration_period": "5m",
  "ticket_removal_period": "1m",
  "profiles": {
    "custom-lobby-example": {
      "application": {
        "name": "my-game-server",
        "version": "2024.01.30-16.23.00-UTC"
      },
      "rules": {
        "initial": {
          "match_size": {
            "type": "player_count",
            "attributes": {
              "team_count": 1,
              "team_size": 4
            }
          },
          "lobby_id": {
            "type": "string_equality"
          }
        },
        "expansions": {}
      }
    }
  }
}

(温馨提示:请确保更改应用程序 name 和 version 以匹配您的应用程序和版本!)

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

现在您可以继续下一步。

2. 探索配置​

独特的 MMO 多人游戏规则

自定义大厅(私人大厅、沙盒关卡)不仅是非常受欢迎的本地多人游戏选项,而且在竞争或合作游戏进入主要游戏模式之前测试新功能时也广为采用。这些游戏通常需要最少的限制,但旨在确保玩家能够成组加入。

回填票据可以使用自定义大厅配置文件来可靠地支持邀请好友,前提是回填票据有效。

  • 提示:在其他配置文件之外将 custom-lobby-example 配置文件添加到您的配置中,以支持自定义大厅。

语义化版本控制

当我们发布匹配器的更新时,每个新版本都使用语义化版本控制,通过解释 major.minor.patch 格式来清晰传达更改的影响:

  • major 版本包含重大破坏性更改,需要重新审查集成,

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

  • patch 版本包含错误修复和细微改进。

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

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

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

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

  • 您选择的名称,例如 - match size,

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

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

玩家数量规则

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

  • team_count 指队伍数量,1 支队伍可用于合作或混战模式,

  • team_size 指每队玩家数量。

我们的简单示例展示了一个 2 名玩家的合作游戏。

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

延迟规则

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

现在您可以继续下一步。

我们上述示例的 beacons 规则最初设置为 "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. 查看实例详情​

新匹配器初始化后,请在我们的仪表板中查看其详细信息:

状态 (Status) 指示服务运行状况,可能为 ONLINE、OFFLINE 或 ERROR。

  • 标识符 (Identifier) 有助于 Edgegap 工作人员在您需要排错帮助时快速找到您的匹配器。

  • 启动时间 (Started at) 可用于追踪最新的更新时间。

  • 规格 (Size) 对应于我们的定价层之一。

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

  • Swagger URL 是我们提供的方便的 OpenAPI 规范 GUI,用于浏览 API 模式。

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

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

现在您可以继续下一步。

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。

确认导入,这将在左侧的 Collections 列表中显示一个名为 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,请保存此 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 向玩家提供票据状态更新,以获得最佳玩家体验。请参阅:

在游戏客户端中,确保处理不可重试的错误:

  • HTTP 404 Not Found - 票据已被删除,

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

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

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

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

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

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

一旦游戏客户端完全加载,玩家就会加载/传送至主游戏场景。

可选地,游戏服务器可以创建和管理回填以及玩家容量(添加或替换离开的玩家)。

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

  • 没有玩家加入比赛,

  • 所有玩家都已离开比赛,

  • 比赛正常结束。

祝贺您,您已完成 Edgegap 匹配器集成!如果您想了解更多信息,请在我们的学习中心阅读所有相关内容。

如何将匹配集成到您的 MMO 多人游戏中

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

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

将我们的匹配器实现到您的游戏中共有五个步骤:

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

  2. 现在,切勿盲目遵循在网上找到的 JSON 示例,因此强烈建议针对您的回合制游戏调整上述规则。步骤 2(“探索配置”)是我们的“阅读指南”,深入探讨了各项匹配规则的功能(“探索配置”)。

  3. 步骤 3(“查看实例详情”)涵盖了您个人专属的匹配器,以确保其已部署并与您的游戏设计协同工作。

  4. 步骤 4 正如其名(“4. 测试票据 API”),主要是测试玩家发出的匹配请求是否被匹配器接收,这些请求被称为票据。

  5. 步骤 5(“在游戏中集成匹配”)重点介绍如何在引擎项目中集成匹配器。

如果您遇到疑难解答方面的挑战,我们深入的学习中心提供了额外的排错提示。

1. 设置免费层

注册您的免费 Edgegap 账户,然后导航至匹配器仪表板页面。

在页面中,首先点击 Create Matchmaker,然后输入:

  • 匹配器的名称 —— 仅供您个人参考,例如 quickstart-dev,

  • 然后,上传以下简单的 JSON 配置示例作为您的 MMO 游戏配置:

{
  "version": "2.1.0",
  "inspect": true,
  "max_deployment_retry_count": 3,
  "ticket_expiration_period": "5m",
  "ticket_removal_period": "1m",
  "profiles": {
    "custom-lobby-example": {
      "application": {
        "name": "my-game-server",
        "version": "2024.01.30-16.23.00-UTC"
      },
      "rules": {
        "initial": {
          "match_size": {
            "type": "player_count",
            "attributes": {
              "team_count": 1,
              "team_size": 4
            }
          },
          "lobby_id": {
            "type": "string_equality"
          }
        },
        "expansions": {}
      }
    }
  }
}

(温馨提示:请确保更改应用程序 name 和 version 以匹配您的应用程序和版本!)

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

现在您可以继续下一步。

2. 探索配置​

独特的 MMO 多人游戏规则

自定义大厅(私人大厅、沙盒关卡)不仅是非常受欢迎的本地多人游戏选项,而且在竞争或合作游戏进入主要游戏模式之前测试新功能时也广为采用。这些游戏通常需要最少的限制,但旨在确保玩家能够成组加入。

回填票据可以使用自定义大厅配置文件来可靠地支持邀请好友,前提是回填票据有效。

  • 提示:在其他配置文件之外将 custom-lobby-example 配置文件添加到您的配置中,以支持自定义大厅。

语义化版本控制

当我们发布匹配器的更新时,每个新版本都使用语义化版本控制,通过解释 major.minor.patch 格式来清晰传达更改的影响:

  • major 版本包含重大破坏性更改,需要重新审查集成,

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

  • patch 版本包含错误修复和细微改进。

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

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

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

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

  • 您选择的名称,例如 - match size,

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

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

玩家数量规则

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

  • team_count 指队伍数量,1 支队伍可用于合作或混战模式,

  • team_size 指每队玩家数量。

我们的简单示例展示了一个 2 名玩家的合作游戏。

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

延迟规则

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

现在您可以继续下一步。

我们上述示例的 beacons 规则最初设置为 "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. 查看实例详情​

新匹配器初始化后,请在我们的仪表板中查看其详细信息:

状态 (Status) 指示服务运行状况,可能为 ONLINE、OFFLINE 或 ERROR。

  • 标识符 (Identifier) 有助于 Edgegap 工作人员在您需要排错帮助时快速找到您的匹配器。

  • 启动时间 (Started at) 可用于追踪最新的更新时间。

  • 规格 (Size) 对应于我们的定价层之一。

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

  • Swagger URL 是我们提供的方便的 OpenAPI 规范 GUI,用于浏览 API 模式。

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

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

现在您可以继续下一步。

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。

确认导入,这将在左侧的 Collections 列表中显示一个名为 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,请保存此 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 向玩家提供票据状态更新,以获得最佳玩家体验。请参阅:

在游戏客户端中,确保处理不可重试的错误:

  • HTTP 404 Not Found - 票据已被删除,

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

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

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

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

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

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

一旦游戏客户端完全加载,玩家就会加载/传送至主游戏场景。

可选地,游戏服务器可以创建和管理回填以及玩家容量(添加或替换离开的玩家)。

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

  • 没有玩家加入比赛,

  • 所有玩家都已离开比赛,

  • 比赛正常结束。

祝贺您,您已完成 Edgegap 匹配器集成!如果您想了解更多信息,请在我们的学习中心阅读所有相关内容。

如何将匹配集成到您的 MMO 多人游戏中

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

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

将我们的匹配器实现到您的游戏中共有五个步骤:

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

  2. 现在,切勿盲目遵循在网上找到的 JSON 示例,因此强烈建议针对您的回合制游戏调整上述规则。步骤 2(“探索配置”)是我们的“阅读指南”,深入探讨了各项匹配规则的功能(“探索配置”)。

  3. 步骤 3(“查看实例详情”)涵盖了您个人专属的匹配器,以确保其已部署并与您的游戏设计协同工作。

  4. 步骤 4 正如其名(“4. 测试票据 API”),主要是测试玩家发出的匹配请求是否被匹配器接收,这些请求被称为票据。

  5. 步骤 5(“在游戏中集成匹配”)重点介绍如何在引擎项目中集成匹配器。

如果您遇到疑难解答方面的挑战,我们深入的学习中心提供了额外的排错提示。

1. 设置免费层

注册您的免费 Edgegap 账户,然后导航至匹配器仪表板页面。

在页面中,首先点击 Create Matchmaker,然后输入:

  • 匹配器的名称 —— 仅供您个人参考,例如 quickstart-dev,

  • 然后,上传以下简单的 JSON 配置示例作为您的 MMO 游戏配置:

{
  "version": "2.1.0",
  "inspect": true,
  "max_deployment_retry_count": 3,
  "ticket_expiration_period": "5m",
  "ticket_removal_period": "1m",
  "profiles": {
    "custom-lobby-example": {
      "application": {
        "name": "my-game-server",
        "version": "2024.01.30-16.23.00-UTC"
      },
      "rules": {
        "initial": {
          "match_size": {
            "type": "player_count",
            "attributes": {
              "team_count": 1,
              "team_size": 4
            }
          },
          "lobby_id": {
            "type": "string_equality"
          }
        },
        "expansions": {}
      }
    }
  }
}

(温馨提示:请确保更改应用程序 name 和 version 以匹配您的应用程序和版本!)

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

现在您可以继续下一步。

2. 探索配置​

独特的 MMO 多人游戏规则

自定义大厅(私人大厅、沙盒关卡)不仅是非常受欢迎的本地多人游戏选项,而且在竞争或合作游戏进入主要游戏模式之前测试新功能时也广为采用。这些游戏通常需要最少的限制,但旨在确保玩家能够成组加入。

回填票据可以使用自定义大厅配置文件来可靠地支持邀请好友,前提是回填票据有效。

  • 提示:在其他配置文件之外将 custom-lobby-example 配置文件添加到您的配置中,以支持自定义大厅。

语义化版本控制

当我们发布匹配器的更新时,每个新版本都使用语义化版本控制,通过解释 major.minor.patch 格式来清晰传达更改的影响:

  • major 版本包含重大破坏性更改,需要重新审查集成,

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

  • patch 版本包含错误修复和细微改进。

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

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

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

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

  • 您选择的名称,例如 - match size,

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

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

玩家数量规则

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

  • team_count 指队伍数量,1 支队伍可用于合作或混战模式,

  • team_size 指每队玩家数量。

我们的简单示例展示了一个 2 名玩家的合作游戏。

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

延迟规则

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

现在您可以继续下一步。

我们上述示例的 beacons 规则最初设置为 "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. 查看实例详情​

新匹配器初始化后,请在我们的仪表板中查看其详细信息:

状态 (Status) 指示服务运行状况,可能为 ONLINE、OFFLINE 或 ERROR。

  • 标识符 (Identifier) 有助于 Edgegap 工作人员在您需要排错帮助时快速找到您的匹配器。

  • 启动时间 (Started at) 可用于追踪最新的更新时间。

  • 规格 (Size) 对应于我们的定价层之一。

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

  • Swagger URL 是我们提供的方便的 OpenAPI 规范 GUI,用于浏览 API 模式。

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

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

现在您可以继续下一步。

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。

确认导入,这将在左侧的 Collections 列表中显示一个名为 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,请保存此 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 向玩家提供票据状态更新,以获得最佳玩家体验。请参阅:

在游戏客户端中,确保处理不可重试的错误:

  • HTTP 404 Not Found - 票据已被删除,

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

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

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

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

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

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

一旦游戏客户端完全加载,玩家就会加载/传送至主游戏场景。

可选地,游戏服务器可以创建和管理回填以及玩家容量(添加或替换离开的玩家)。

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

  • 没有玩家加入比赛,

  • 所有玩家都已离开比赛,

  • 比赛正常结束。

祝贺您,您已完成 Edgegap 匹配器集成!如果您想了解更多信息,请在我们的学习中心阅读所有相关内容。

如何将匹配集成到您的 MMO 多人游戏中

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

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

将我们的匹配器实现到您的游戏中共有五个步骤:

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

  2. 现在,切勿盲目遵循在网上找到的 JSON 示例,因此强烈建议针对您的回合制游戏调整上述规则。步骤 2(“探索配置”)是我们的“阅读指南”,深入探讨了各项匹配规则的功能(“探索配置”)。

  3. 步骤 3(“查看实例详情”)涵盖了您个人专属的匹配器,以确保其已部署并与您的游戏设计协同工作。

  4. 步骤 4 正如其名(“4. 测试票据 API”),主要是测试玩家发出的匹配请求是否被匹配器接收,这些请求被称为票据。

  5. 步骤 5(“在游戏中集成匹配”)重点介绍如何在引擎项目中集成匹配器。

如果您遇到疑难解答方面的挑战,我们深入的学习中心提供了额外的排错提示。

1. 设置免费层

注册您的免费 Edgegap 账户,然后导航至匹配器仪表板页面。

在页面中,首先点击 Create Matchmaker,然后输入:

  • 匹配器的名称 —— 仅供您个人参考,例如 quickstart-dev,

  • 然后,上传以下简单的 JSON 配置示例作为您的 MMO 游戏配置:

{
  "version": "2.1.0",
  "inspect": true,
  "max_deployment_retry_count": 3,
  "ticket_expiration_period": "5m",
  "ticket_removal_period": "1m",
  "profiles": {
    "custom-lobby-example": {
      "application": {
        "name": "my-game-server",
        "version": "2024.01.30-16.23.00-UTC"
      },
      "rules": {
        "initial": {
          "match_size": {
            "type": "player_count",
            "attributes": {
              "team_count": 1,
              "team_size": 4
            }
          },
          "lobby_id": {
            "type": "string_equality"
          }
        },
        "expansions": {}
      }
    }
  }
}

(温馨提示:请确保更改应用程序 name 和 version 以匹配您的应用程序和版本!)

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

现在您可以继续下一步。

2. 探索配置​

独特的 MMO 多人游戏规则

自定义大厅(私人大厅、沙盒关卡)不仅是非常受欢迎的本地多人游戏选项,而且在竞争或合作游戏进入主要游戏模式之前测试新功能时也广为采用。这些游戏通常需要最少的限制,但旨在确保玩家能够成组加入。

回填票据可以使用自定义大厅配置文件来可靠地支持邀请好友,前提是回填票据有效。

  • 提示:在其他配置文件之外将 custom-lobby-example 配置文件添加到您的配置中,以支持自定义大厅。

语义化版本控制

当我们发布匹配器的更新时,每个新版本都使用语义化版本控制,通过解释 major.minor.patch 格式来清晰传达更改的影响:

  • major 版本包含重大破坏性更改,需要重新审查集成,

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

  • patch 版本包含错误修复和细微改进。

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

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

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

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

  • 您选择的名称,例如 - match size,

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

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

玩家数量规则

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

  • team_count 指队伍数量,1 支队伍可用于合作或混战模式,

  • team_size 指每队玩家数量。

我们的简单示例展示了一个 2 名玩家的合作游戏。

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

延迟规则

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

现在您可以继续下一步。

我们上述示例的 beacons 规则最初设置为 "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. 查看实例详情​

新匹配器初始化后,请在我们的仪表板中查看其详细信息:

状态 (Status) 指示服务运行状况,可能为 ONLINE、OFFLINE 或 ERROR。

  • 标识符 (Identifier) 有助于 Edgegap 工作人员在您需要排错帮助时快速找到您的匹配器。

  • 启动时间 (Started at) 可用于追踪最新的更新时间。

  • 规格 (Size) 对应于我们的定价层之一。

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

  • Swagger URL 是我们提供的方便的 OpenAPI 规范 GUI,用于浏览 API 模式。

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

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

现在您可以继续下一步。

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。

确认导入,这将在左侧的 Collections 列表中显示一个名为 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,请保存此 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 向玩家提供票据状态更新,以获得最佳玩家体验。请参阅:

在游戏客户端中,确保处理不可重试的错误:

  • HTTP 404 Not Found - 票据已被删除,

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

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

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

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

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

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

一旦游戏客户端完全加载,玩家就会加载/传送至主游戏场景。

可选地,游戏服务器可以创建和管理回填以及玩家容量(添加或替换离开的玩家)。

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

  • 没有玩家加入比赛,

  • 所有玩家都已离开比赛,

  • 比赛正常结束。

祝贺您,您已完成 Edgegap 匹配器集成!如果您想了解更多信息,请在我们的学习中心阅读所有相关内容。

书写者

Edgegap团队

Get your Game Online Easily & in Minutes

立即开始集成!

轻松在线游戏
且在几分钟内