了解Edgegap的工作原理

了解Edgegap的工作原理

如何在MOBA中添加匹配机制

已发布

已发布

已发布

关键洞察

关键洞察

关键洞察

Edgegap的 matchmaking 是一个全托管、无限自定义的 matchmaking 系统,能够最佳地将全球玩家分组 - 在您开发 MOBA 游戏期间其使用是免费的。

它也是我们所知的唯一具备基于延迟的 matchmaking 规则的 matchmaking 系统,能够为您的游戏提供理想的在线多人体验,无论引擎(Unity、Unreal等)或游戏服务(EOS、UGS、PlayFab、Heroic Labs Nakama、Braincloud等)如何。

由于我们的 matchmaker 是基于参数的,因此无需编写代码。因此集成非常简单,如果需要,我们的入门指南会在每一步中帮助您。

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

如何在您的 MOBA 游戏中集成匹配系统

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

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

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

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

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

将我们的匹配器应用到您的游戏包含五个步骤:

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

  2. 现在,绝不应该盲目照搬在网上找到的 JSON 示例,因此强烈建议根据您的游戏调整上述规则。步骤 2(“探索配置”)是我们的“阅读指南”,深入介绍了每项匹配规则的功能(“探索配置”)。

  3. 步骤 3(“查看实例详情”)涵盖您个人的特定匹配器,以确保其已部署并与您的游戏设计相配合。

  4. 步骤 4,顾名思义(“4. 测试票证 API”),完全是关于测试来自玩家的匹配请求(称为票证)是否已被匹配器接收。

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

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

1. 设置免费层级

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

在那里,先点击 Create Matchmaker(创建匹配器),然后输入:

  • 匹配器的名称 – 纯粹供您自己参考,例如 quickstart-dev,

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

{
  "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. 探索配置​

独特的 MOBA 游戏规则

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

  • 在较为休闲的游戏中限制两名玩家之间的段位分差,

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

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

  • 添加 中心选择界面 以将对手限制在指定的 Ping 信标,

  • 将 匹配延迟 限制在最大阈值内,以防止匹配相距过远的玩家,

  • 将 匹配延迟 限制在最大差值内,以最大化 Ping 公平性,

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

  • 通过 作为组加入 用于预设大厅或在不超过队伍人数上限的情况下填满队伍。

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

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

  • 逐步增大允许的段位分差,以找到更多玩家,

  • 由于高段位(挑战者)可用玩家较少,因此增加每次放宽之间的时间间隔。

为晋级赛创建更高段位的票证,以匹配更强大的对手。

定义单独的作弊者配置文件,以确保被标记的作弊者或收到大量违规举报的玩家不会对排位赛中合法玩家的体验造成负面影响。

语义化版本控制

每个新版本均采用 语义化版本控制,通过解释 主版本.次版本.修订版本 格式来清晰传达更改的影响:

  • 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 信标 测量的特定 Ping 值 difference(差值)范围内的匹配。这为划分玩家群提供了一种“软性”解决方案,允许与邻近区域进行匹配,尤其可以提高玩家较少区域的匹配速度。使用 max_latency 可防止与距离过远的玩家匹配。

现在您可以继续下一步。

以上述带有初始 "difference": 50, "max_latency": 200 的示例 beacons 规则为例:

  • 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. 查看实例详情​

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

状态 表示服务运行状况,可能是 ONLINE(在线)、OFFLINE(离线)或 ERROR(错误)。

  • Identifier(标识符)在您需要排查问题时,帮助 Edgegap 人员快速找到您的匹配器。

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

  • Size(规格)对应我们的某个 定价层级。

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

  • Swagger URL 是我们提供的一个便捷 openAPI 规范图形用户界面,用于探索 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 和配置文件打上标记,以增加可追溯性。

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

一旦您确认能够顺利连接到您的 Deployment(部署)并且完成测试,请停止您的部署,以释放账户中的容量供下一次构建使用。

现在您可以继续下一步。

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 匹配器的集成!如果您想了解更多信息,请在我们的 学习中心 阅读全部内容。

如何在您的 MOBA 游戏中集成匹配系统

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

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

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

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

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

将我们的匹配器应用到您的游戏包含五个步骤:

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

  2. 现在,绝不应该盲目照搬在网上找到的 JSON 示例,因此强烈建议根据您的游戏调整上述规则。步骤 2(“探索配置”)是我们的“阅读指南”,深入介绍了每项匹配规则的功能(“探索配置”)。

  3. 步骤 3(“查看实例详情”)涵盖您个人的特定匹配器,以确保其已部署并与您的游戏设计相配合。

  4. 步骤 4,顾名思义(“4. 测试票证 API”),完全是关于测试来自玩家的匹配请求(称为票证)是否已被匹配器接收。

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

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

1. 设置免费层级

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

在那里,先点击 Create Matchmaker(创建匹配器),然后输入:

  • 匹配器的名称 – 纯粹供您自己参考,例如 quickstart-dev,

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

{
  "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. 探索配置​

独特的 MOBA 游戏规则

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

  • 在较为休闲的游戏中限制两名玩家之间的段位分差,

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

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

  • 添加 中心选择界面 以将对手限制在指定的 Ping 信标,

  • 将 匹配延迟 限制在最大阈值内,以防止匹配相距过远的玩家,

  • 将 匹配延迟 限制在最大差值内,以最大化 Ping 公平性,

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

  • 通过 作为组加入 用于预设大厅或在不超过队伍人数上限的情况下填满队伍。

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

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

  • 逐步增大允许的段位分差,以找到更多玩家,

  • 由于高段位(挑战者)可用玩家较少,因此增加每次放宽之间的时间间隔。

为晋级赛创建更高段位的票证,以匹配更强大的对手。

定义单独的作弊者配置文件,以确保被标记的作弊者或收到大量违规举报的玩家不会对排位赛中合法玩家的体验造成负面影响。

语义化版本控制

每个新版本均采用 语义化版本控制,通过解释 主版本.次版本.修订版本 格式来清晰传达更改的影响:

  • 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 信标 测量的特定 Ping 值 difference(差值)范围内的匹配。这为划分玩家群提供了一种“软性”解决方案,允许与邻近区域进行匹配,尤其可以提高玩家较少区域的匹配速度。使用 max_latency 可防止与距离过远的玩家匹配。

现在您可以继续下一步。

以上述带有初始 "difference": 50, "max_latency": 200 的示例 beacons 规则为例:

  • 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. 查看实例详情​

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

状态 表示服务运行状况,可能是 ONLINE(在线)、OFFLINE(离线)或 ERROR(错误)。

  • Identifier(标识符)在您需要排查问题时,帮助 Edgegap 人员快速找到您的匹配器。

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

  • Size(规格)对应我们的某个 定价层级。

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

  • Swagger URL 是我们提供的一个便捷 openAPI 规范图形用户界面,用于探索 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 和配置文件打上标记,以增加可追溯性。

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

一旦您确认能够顺利连接到您的 Deployment(部署)并且完成测试,请停止您的部署,以释放账户中的容量供下一次构建使用。

现在您可以继续下一步。

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 匹配器的集成!如果您想了解更多信息,请在我们的 学习中心 阅读全部内容。

如何在您的 MOBA 游戏中集成匹配系统

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

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

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

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

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

将我们的匹配器应用到您的游戏包含五个步骤:

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

  2. 现在,绝不应该盲目照搬在网上找到的 JSON 示例,因此强烈建议根据您的游戏调整上述规则。步骤 2(“探索配置”)是我们的“阅读指南”,深入介绍了每项匹配规则的功能(“探索配置”)。

  3. 步骤 3(“查看实例详情”)涵盖您个人的特定匹配器,以确保其已部署并与您的游戏设计相配合。

  4. 步骤 4,顾名思义(“4. 测试票证 API”),完全是关于测试来自玩家的匹配请求(称为票证)是否已被匹配器接收。

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

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

1. 设置免费层级

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

在那里,先点击 Create Matchmaker(创建匹配器),然后输入:

  • 匹配器的名称 – 纯粹供您自己参考,例如 quickstart-dev,

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

{
  "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. 探索配置​

独特的 MOBA 游戏规则

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

  • 在较为休闲的游戏中限制两名玩家之间的段位分差,

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

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

  • 添加 中心选择界面 以将对手限制在指定的 Ping 信标,

  • 将 匹配延迟 限制在最大阈值内,以防止匹配相距过远的玩家,

  • 将 匹配延迟 限制在最大差值内,以最大化 Ping 公平性,

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

  • 通过 作为组加入 用于预设大厅或在不超过队伍人数上限的情况下填满队伍。

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

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

  • 逐步增大允许的段位分差,以找到更多玩家,

  • 由于高段位(挑战者)可用玩家较少,因此增加每次放宽之间的时间间隔。

为晋级赛创建更高段位的票证,以匹配更强大的对手。

定义单独的作弊者配置文件,以确保被标记的作弊者或收到大量违规举报的玩家不会对排位赛中合法玩家的体验造成负面影响。

语义化版本控制

每个新版本均采用 语义化版本控制,通过解释 主版本.次版本.修订版本 格式来清晰传达更改的影响:

  • 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 信标 测量的特定 Ping 值 difference(差值)范围内的匹配。这为划分玩家群提供了一种“软性”解决方案,允许与邻近区域进行匹配,尤其可以提高玩家较少区域的匹配速度。使用 max_latency 可防止与距离过远的玩家匹配。

现在您可以继续下一步。

以上述带有初始 "difference": 50, "max_latency": 200 的示例 beacons 规则为例:

  • 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. 查看实例详情​

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

状态 表示服务运行状况,可能是 ONLINE(在线)、OFFLINE(离线)或 ERROR(错误)。

  • Identifier(标识符)在您需要排查问题时,帮助 Edgegap 人员快速找到您的匹配器。

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

  • Size(规格)对应我们的某个 定价层级。

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

  • Swagger URL 是我们提供的一个便捷 openAPI 规范图形用户界面,用于探索 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 和配置文件打上标记,以增加可追溯性。

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

一旦您确认能够顺利连接到您的 Deployment(部署)并且完成测试,请停止您的部署,以释放账户中的容量供下一次构建使用。

现在您可以继续下一步。

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 匹配器的集成!如果您想了解更多信息,请在我们的 学习中心 阅读全部内容。

如何在您的 MOBA 游戏中集成匹配系统

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

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

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

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

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

将我们的匹配器应用到您的游戏包含五个步骤:

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

  2. 现在,绝不应该盲目照搬在网上找到的 JSON 示例,因此强烈建议根据您的游戏调整上述规则。步骤 2(“探索配置”)是我们的“阅读指南”,深入介绍了每项匹配规则的功能(“探索配置”)。

  3. 步骤 3(“查看实例详情”)涵盖您个人的特定匹配器,以确保其已部署并与您的游戏设计相配合。

  4. 步骤 4,顾名思义(“4. 测试票证 API”),完全是关于测试来自玩家的匹配请求(称为票证)是否已被匹配器接收。

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

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

1. 设置免费层级

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

在那里,先点击 Create Matchmaker(创建匹配器),然后输入:

  • 匹配器的名称 – 纯粹供您自己参考,例如 quickstart-dev,

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

{
  "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. 探索配置​

独特的 MOBA 游戏规则

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

  • 在较为休闲的游戏中限制两名玩家之间的段位分差,

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

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

  • 添加 中心选择界面 以将对手限制在指定的 Ping 信标,

  • 将 匹配延迟 限制在最大阈值内,以防止匹配相距过远的玩家,

  • 将 匹配延迟 限制在最大差值内,以最大化 Ping 公平性,

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

  • 通过 作为组加入 用于预设大厅或在不超过队伍人数上限的情况下填满队伍。

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

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

  • 逐步增大允许的段位分差,以找到更多玩家,

  • 由于高段位(挑战者)可用玩家较少,因此增加每次放宽之间的时间间隔。

为晋级赛创建更高段位的票证,以匹配更强大的对手。

定义单独的作弊者配置文件,以确保被标记的作弊者或收到大量违规举报的玩家不会对排位赛中合法玩家的体验造成负面影响。

语义化版本控制

每个新版本均采用 语义化版本控制,通过解释 主版本.次版本.修订版本 格式来清晰传达更改的影响:

  • 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 信标 测量的特定 Ping 值 difference(差值)范围内的匹配。这为划分玩家群提供了一种“软性”解决方案,允许与邻近区域进行匹配,尤其可以提高玩家较少区域的匹配速度。使用 max_latency 可防止与距离过远的玩家匹配。

现在您可以继续下一步。

以上述带有初始 "difference": 50, "max_latency": 200 的示例 beacons 规则为例:

  • 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. 查看实例详情​

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

状态 表示服务运行状况,可能是 ONLINE(在线)、OFFLINE(离线)或 ERROR(错误)。

  • Identifier(标识符)在您需要排查问题时,帮助 Edgegap 人员快速找到您的匹配器。

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

  • Size(规格)对应我们的某个 定价层级。

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

  • Swagger URL 是我们提供的一个便捷 openAPI 规范图形用户界面,用于探索 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 和配置文件打上标记,以增加可追溯性。

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

一旦您确认能够顺利连接到您的 Deployment(部署)并且完成测试,请停止您的部署,以释放账户中的容量供下一次构建使用。

现在您可以继续下一步。

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

立即开始集成!

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