了解Edgegap的工作原理

了解Edgegap的工作原理

如何为多人自由竞争游戏添加匹配机制

已发布

已发布

已发布

关键洞察

关键洞察

关键洞察

Edgegap 的 配对系统 是一个完全托管的、可无限定制的配对系统,能够在全球范围内优化地将玩家分组——在开发您的多人自由竞技游戏期间使用是免费的。

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

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

当您的游戏上线时,由于我们的配对系统是完全托管的,您无需处理基础设施、错误、故障、可扩展性或数据库管理。我们会为您处理所有事务,使您的 DevOps 工作负载降到几乎为零。

如何将匹配集成到多人大乱斗游戏中

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

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

将我们的匹配器实现到游戏中只需五个步骤:

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

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

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

  4. 顾名思义,步骤 4(“4. 测试票证 API”)主要是测试匹配器是否能接收到来自玩家的匹配请求,即所谓的票证。

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

如果您遇到故障排查方面的难题,我们深入详尽的学习中心提供了额外的故障排查技巧。

1. 设置免费层

注册免费的 Edgegap 账户,并前往 Matchmaker 控制台页面。

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

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

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

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

独特的大乱斗游戏规则

针对大乱斗游戏,您可以定义多个匹配配置文件以设置游戏模式特定的规则和设置:

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

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

  • 让玩家提供他们的地图偏好,并选择适合每个人的地图,

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

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

  • 将匹配延迟差限制在最大范围内,以尽可能保证延迟的公平性,

  • 当允许更多玩家加入时,通过不同的应用版本分配更多 CPU 或内存,

  • 使用作为组加入以支持预组队大厅,或在不超过队伍规模的情况下填满队伍。

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

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

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

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

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

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

语义化版本控制

每个新版本都使用语义化版本控制,通过解析 主版本号.次版本号.修订号 格式来明确传达更改的影响:

  • 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 延迟差值内的匹配。这为划分玩家群提供了一种“软性”解决方案,允许与邻近区域进行匹配,尤其可以提高玩家稀少地区的匹配速度。使用 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 和 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。

确认导入后,左侧的 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,请妥善保存以便稍后查询票证,

  • 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 Matchmaker 的集成!如果您想了解更多信息,请在我们的学习中心阅读所有相关内容。

如何将匹配集成到多人大乱斗游戏中

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

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

将我们的匹配器实现到游戏中只需五个步骤:

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

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

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

  4. 顾名思义,步骤 4(“4. 测试票证 API”)主要是测试匹配器是否能接收到来自玩家的匹配请求,即所谓的票证。

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

如果您遇到故障排查方面的难题,我们深入详尽的学习中心提供了额外的故障排查技巧。

1. 设置免费层

注册免费的 Edgegap 账户,并前往 Matchmaker 控制台页面。

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

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

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

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

独特的大乱斗游戏规则

针对大乱斗游戏,您可以定义多个匹配配置文件以设置游戏模式特定的规则和设置:

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

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

  • 让玩家提供他们的地图偏好,并选择适合每个人的地图,

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

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

  • 将匹配延迟差限制在最大范围内,以尽可能保证延迟的公平性,

  • 当允许更多玩家加入时,通过不同的应用版本分配更多 CPU 或内存,

  • 使用作为组加入以支持预组队大厅,或在不超过队伍规模的情况下填满队伍。

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

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

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

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

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

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

语义化版本控制

每个新版本都使用语义化版本控制,通过解析 主版本号.次版本号.修订号 格式来明确传达更改的影响:

  • 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 延迟差值内的匹配。这为划分玩家群提供了一种“软性”解决方案,允许与邻近区域进行匹配,尤其可以提高玩家稀少地区的匹配速度。使用 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 和 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。

确认导入后,左侧的 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,请妥善保存以便稍后查询票证,

  • 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 Matchmaker 的集成!如果您想了解更多信息,请在我们的学习中心阅读所有相关内容。

如何将匹配集成到多人大乱斗游戏中

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

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

将我们的匹配器实现到游戏中只需五个步骤:

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

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

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

  4. 顾名思义,步骤 4(“4. 测试票证 API”)主要是测试匹配器是否能接收到来自玩家的匹配请求,即所谓的票证。

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

如果您遇到故障排查方面的难题,我们深入详尽的学习中心提供了额外的故障排查技巧。

1. 设置免费层

注册免费的 Edgegap 账户,并前往 Matchmaker 控制台页面。

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

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

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

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

独特的大乱斗游戏规则

针对大乱斗游戏,您可以定义多个匹配配置文件以设置游戏模式特定的规则和设置:

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

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

  • 让玩家提供他们的地图偏好,并选择适合每个人的地图,

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

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

  • 将匹配延迟差限制在最大范围内,以尽可能保证延迟的公平性,

  • 当允许更多玩家加入时,通过不同的应用版本分配更多 CPU 或内存,

  • 使用作为组加入以支持预组队大厅,或在不超过队伍规模的情况下填满队伍。

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

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

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

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

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

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

语义化版本控制

每个新版本都使用语义化版本控制,通过解析 主版本号.次版本号.修订号 格式来明确传达更改的影响:

  • 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 延迟差值内的匹配。这为划分玩家群提供了一种“软性”解决方案,允许与邻近区域进行匹配,尤其可以提高玩家稀少地区的匹配速度。使用 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 和 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。

确认导入后,左侧的 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,请妥善保存以便稍后查询票证,

  • 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 Matchmaker 的集成!如果您想了解更多信息,请在我们的学习中心阅读所有相关内容。

如何将匹配集成到多人大乱斗游戏中

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

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

将我们的匹配器实现到游戏中只需五个步骤:

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

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

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

  4. 顾名思义,步骤 4(“4. 测试票证 API”)主要是测试匹配器是否能接收到来自玩家的匹配请求,即所谓的票证。

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

如果您遇到故障排查方面的难题,我们深入详尽的学习中心提供了额外的故障排查技巧。

1. 设置免费层

注册免费的 Edgegap 账户,并前往 Matchmaker 控制台页面。

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

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

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

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

独特的大乱斗游戏规则

针对大乱斗游戏,您可以定义多个匹配配置文件以设置游戏模式特定的规则和设置:

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

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

  • 让玩家提供他们的地图偏好,并选择适合每个人的地图,

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

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

  • 将匹配延迟差限制在最大范围内,以尽可能保证延迟的公平性,

  • 当允许更多玩家加入时,通过不同的应用版本分配更多 CPU 或内存,

  • 使用作为组加入以支持预组队大厅,或在不超过队伍规模的情况下填满队伍。

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

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

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

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

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

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

语义化版本控制

每个新版本都使用语义化版本控制,通过解析 主版本号.次版本号.修订号 格式来明确传达更改的影响:

  • 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 延迟差值内的匹配。这为划分玩家群提供了一种“软性”解决方案,允许与邻近区域进行匹配,尤其可以提高玩家稀少地区的匹配速度。使用 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 和 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。

确认导入后,左侧的 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,请妥善保存以便稍后查询票证,

  • 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 Matchmaker 的集成!如果您想了解更多信息,请在我们的学习中心阅读所有相关内容。

书写者

Edgegap团队

Get your Game Online Easily & in Minutes

立即开始集成!

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