了解Edgegap的工作原理

了解Edgegap的工作原理

如何为多人射击游戏添加 matchmaking

已发布

已发布

已发布

关键洞察

关键洞察

关键洞察

Edgegap的匹配器是一个完全托管、无限可定制的匹配系统,可以在全球范围内优化分组玩家——在开发您的多人射击游戏期间其使用是免费的。

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

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

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

如何将匹配集成到多人射击游戏中

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

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

将我们的匹配器实施到游戏中分为五个步骤:

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

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

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

  4. 步骤 4 正如其名(“4. 测试票证 API”),完全是测试玩家的匹配请求是否被匹配器接收,这些请求被称为票证 (tickets)。

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

独特的射击游戏规则

特别是对于体育类游戏,您可以定义多个 匹配配置文件 (Matchmaking Profiles) 来设置游戏模式特有的规则和配置:

  • 在较为休闲的比赛中,将两名玩家之间的段位差限制在一定范围内,

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

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

  • 添加 中心选择 UI (Hub Selection UI) 以将对手限制在指定的 Ping 信标 (Ping Beacons),

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

  • 将 匹配延迟 限制在最大差值内,以最大程度保证 Ping 值的公平性,

  • 当允许更多玩家时,使用不同的 应用版本 (App Versions) 分配更多 CPU 或内存,

  • 作为队伍加入 (Join as Group) 以用于预组队大厅或在不超过队伍人数限制的情况下填补队伍。

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

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

  • 慢慢增加允许的段位差距,以寻找更多玩家,

  • 对于最高段位(挑战者),增加规则放宽的间隔时间,因为可用玩家较少。

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

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

语义化版本控制 (Semantic Versioning)

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

  • major (主版本)包含不兼容的重大变更,需要进行集成审查,

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

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

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

为了确保突发的客户端崩溃或废弃的票证不会滞留并占用您的匹配器资源,票证将在 ticket_expiration_period 后取消,导致其状态更改为 CANCELLED,然后在 ticket_removal_period 后永久删除。

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

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

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

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

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

玩家数量规则 (Player Count Rule)

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

  • team_count 是指队伍数量,1 支队伍可用于合作或混战 (free-for-all) 模式,

  • team_size 是指每队的玩家数量。

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

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

延迟规则 (Latencies Rule)

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

您现在可以进行下一步。

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

  • Alice 和 Bob 将会匹配,因为 Beijing 被舍弃(>200),其余均在 | A-B | < 50 范围内:

    • Alice {Montreal: 12.3, Newark: 45.6, Dallas: 59.9, Beijing: 264.4};以及

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

  • Charlie 和 Dave 将不会匹配,因为 Dallas 信标的 | C-D | > 50:

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

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

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

3. 查看实例详情​

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

Status 指示服务健康状况,可能为 ONLINE、OFFLINE 或 ERROR。

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

  • Started at 有助于追踪最新的更新时间。

  • Size 对应我们的某一 价格层级。

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

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

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

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

您现在可以进行下一步。

4. 测试票证 API

首先,打开您的 Swagger URL,在 Swagger GUI 中检查您的 openAPI 模式

点击“Matchmaker”标题下方的 /...swagger.json URL 以打开原始 JSON 模式:

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

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

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

  • 保持选中 Postman Collection,

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

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

View more actions,打开标签页 Authorization 并选择:

  • Auth Type - API Key,

  • Key - “Authorization”

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

  • Add to - Header。

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

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

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

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

  • profile 指的是您的 匹配配置文件 (Matchmaking Profiles),

  • attributes 包含您的匹配器规则的值,在本例中为 latencies 规则,

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

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

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

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

  • profile 确认所选的 匹配配置文件 (Matchmaking Profiles),

  • 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 或带有进度条的加载屏幕,以指示初始化正在进行。

一旦游戏客户端完全加载,玩家即可加载/移动到主游戏场景。

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

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

  • 没有玩家加入比赛,

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

  • 比赛正常结束。

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

如何将匹配集成到多人射击游戏中

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

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

将我们的匹配器实施到游戏中分为五个步骤:

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

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

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

  4. 步骤 4 正如其名(“4. 测试票证 API”),完全是测试玩家的匹配请求是否被匹配器接收,这些请求被称为票证 (tickets)。

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

独特的射击游戏规则

特别是对于体育类游戏,您可以定义多个 匹配配置文件 (Matchmaking Profiles) 来设置游戏模式特有的规则和配置:

  • 在较为休闲的比赛中,将两名玩家之间的段位差限制在一定范围内,

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

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

  • 添加 中心选择 UI (Hub Selection UI) 以将对手限制在指定的 Ping 信标 (Ping Beacons),

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

  • 将 匹配延迟 限制在最大差值内,以最大程度保证 Ping 值的公平性,

  • 当允许更多玩家时,使用不同的 应用版本 (App Versions) 分配更多 CPU 或内存,

  • 作为队伍加入 (Join as Group) 以用于预组队大厅或在不超过队伍人数限制的情况下填补队伍。

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

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

  • 慢慢增加允许的段位差距,以寻找更多玩家,

  • 对于最高段位(挑战者),增加规则放宽的间隔时间,因为可用玩家较少。

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

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

语义化版本控制 (Semantic Versioning)

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

  • major (主版本)包含不兼容的重大变更,需要进行集成审查,

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

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

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

为了确保突发的客户端崩溃或废弃的票证不会滞留并占用您的匹配器资源,票证将在 ticket_expiration_period 后取消,导致其状态更改为 CANCELLED,然后在 ticket_removal_period 后永久删除。

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

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

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

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

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

玩家数量规则 (Player Count Rule)

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

  • team_count 是指队伍数量,1 支队伍可用于合作或混战 (free-for-all) 模式,

  • team_size 是指每队的玩家数量。

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

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

延迟规则 (Latencies Rule)

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

您现在可以进行下一步。

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

  • Alice 和 Bob 将会匹配,因为 Beijing 被舍弃(>200),其余均在 | A-B | < 50 范围内:

    • Alice {Montreal: 12.3, Newark: 45.6, Dallas: 59.9, Beijing: 264.4};以及

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

  • Charlie 和 Dave 将不会匹配,因为 Dallas 信标的 | C-D | > 50:

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

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

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

3. 查看实例详情​

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

Status 指示服务健康状况,可能为 ONLINE、OFFLINE 或 ERROR。

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

  • Started at 有助于追踪最新的更新时间。

  • Size 对应我们的某一 价格层级。

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

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

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

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

您现在可以进行下一步。

4. 测试票证 API

首先,打开您的 Swagger URL,在 Swagger GUI 中检查您的 openAPI 模式

点击“Matchmaker”标题下方的 /...swagger.json URL 以打开原始 JSON 模式:

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

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

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

  • 保持选中 Postman Collection,

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

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

View more actions,打开标签页 Authorization 并选择:

  • Auth Type - API Key,

  • Key - “Authorization”

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

  • Add to - Header。

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

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

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

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

  • profile 指的是您的 匹配配置文件 (Matchmaking Profiles),

  • attributes 包含您的匹配器规则的值,在本例中为 latencies 规则,

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

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

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

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

  • profile 确认所选的 匹配配置文件 (Matchmaking Profiles),

  • 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 或带有进度条的加载屏幕,以指示初始化正在进行。

一旦游戏客户端完全加载,玩家即可加载/移动到主游戏场景。

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

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

  • 没有玩家加入比赛,

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

  • 比赛正常结束。

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

如何将匹配集成到多人射击游戏中

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

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

将我们的匹配器实施到游戏中分为五个步骤:

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

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

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

  4. 步骤 4 正如其名(“4. 测试票证 API”),完全是测试玩家的匹配请求是否被匹配器接收,这些请求被称为票证 (tickets)。

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

独特的射击游戏规则

特别是对于体育类游戏,您可以定义多个 匹配配置文件 (Matchmaking Profiles) 来设置游戏模式特有的规则和配置:

  • 在较为休闲的比赛中,将两名玩家之间的段位差限制在一定范围内,

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

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

  • 添加 中心选择 UI (Hub Selection UI) 以将对手限制在指定的 Ping 信标 (Ping Beacons),

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

  • 将 匹配延迟 限制在最大差值内,以最大程度保证 Ping 值的公平性,

  • 当允许更多玩家时,使用不同的 应用版本 (App Versions) 分配更多 CPU 或内存,

  • 作为队伍加入 (Join as Group) 以用于预组队大厅或在不超过队伍人数限制的情况下填补队伍。

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

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

  • 慢慢增加允许的段位差距,以寻找更多玩家,

  • 对于最高段位(挑战者),增加规则放宽的间隔时间,因为可用玩家较少。

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

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

语义化版本控制 (Semantic Versioning)

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

  • major (主版本)包含不兼容的重大变更,需要进行集成审查,

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

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

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

为了确保突发的客户端崩溃或废弃的票证不会滞留并占用您的匹配器资源,票证将在 ticket_expiration_period 后取消,导致其状态更改为 CANCELLED,然后在 ticket_removal_period 后永久删除。

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

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

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

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

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

玩家数量规则 (Player Count Rule)

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

  • team_count 是指队伍数量,1 支队伍可用于合作或混战 (free-for-all) 模式,

  • team_size 是指每队的玩家数量。

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

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

延迟规则 (Latencies Rule)

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

您现在可以进行下一步。

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

  • Alice 和 Bob 将会匹配,因为 Beijing 被舍弃(>200),其余均在 | A-B | < 50 范围内:

    • Alice {Montreal: 12.3, Newark: 45.6, Dallas: 59.9, Beijing: 264.4};以及

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

  • Charlie 和 Dave 将不会匹配,因为 Dallas 信标的 | C-D | > 50:

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

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

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

3. 查看实例详情​

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

Status 指示服务健康状况,可能为 ONLINE、OFFLINE 或 ERROR。

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

  • Started at 有助于追踪最新的更新时间。

  • Size 对应我们的某一 价格层级。

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

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

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

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

您现在可以进行下一步。

4. 测试票证 API

首先,打开您的 Swagger URL,在 Swagger GUI 中检查您的 openAPI 模式

点击“Matchmaker”标题下方的 /...swagger.json URL 以打开原始 JSON 模式:

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

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

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

  • 保持选中 Postman Collection,

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

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

View more actions,打开标签页 Authorization 并选择:

  • Auth Type - API Key,

  • Key - “Authorization”

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

  • Add to - Header。

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

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

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

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

  • profile 指的是您的 匹配配置文件 (Matchmaking Profiles),

  • attributes 包含您的匹配器规则的值,在本例中为 latencies 规则,

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

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

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

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

  • profile 确认所选的 匹配配置文件 (Matchmaking Profiles),

  • 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 或带有进度条的加载屏幕,以指示初始化正在进行。

一旦游戏客户端完全加载,玩家即可加载/移动到主游戏场景。

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

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

  • 没有玩家加入比赛,

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

  • 比赛正常结束。

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

如何将匹配集成到多人射击游戏中

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

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

将我们的匹配器实施到游戏中分为五个步骤:

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

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

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

  4. 步骤 4 正如其名(“4. 测试票证 API”),完全是测试玩家的匹配请求是否被匹配器接收,这些请求被称为票证 (tickets)。

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

独特的射击游戏规则

特别是对于体育类游戏,您可以定义多个 匹配配置文件 (Matchmaking Profiles) 来设置游戏模式特有的规则和配置:

  • 在较为休闲的比赛中,将两名玩家之间的段位差限制在一定范围内,

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

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

  • 添加 中心选择 UI (Hub Selection UI) 以将对手限制在指定的 Ping 信标 (Ping Beacons),

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

  • 将 匹配延迟 限制在最大差值内,以最大程度保证 Ping 值的公平性,

  • 当允许更多玩家时,使用不同的 应用版本 (App Versions) 分配更多 CPU 或内存,

  • 作为队伍加入 (Join as Group) 以用于预组队大厅或在不超过队伍人数限制的情况下填补队伍。

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

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

  • 慢慢增加允许的段位差距,以寻找更多玩家,

  • 对于最高段位(挑战者),增加规则放宽的间隔时间,因为可用玩家较少。

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

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

语义化版本控制 (Semantic Versioning)

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

  • major (主版本)包含不兼容的重大变更,需要进行集成审查,

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

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

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

为了确保突发的客户端崩溃或废弃的票证不会滞留并占用您的匹配器资源,票证将在 ticket_expiration_period 后取消,导致其状态更改为 CANCELLED,然后在 ticket_removal_period 后永久删除。

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

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

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

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

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

玩家数量规则 (Player Count Rule)

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

  • team_count 是指队伍数量,1 支队伍可用于合作或混战 (free-for-all) 模式,

  • team_size 是指每队的玩家数量。

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

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

延迟规则 (Latencies Rule)

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

您现在可以进行下一步。

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

  • Alice 和 Bob 将会匹配,因为 Beijing 被舍弃(>200),其余均在 | A-B | < 50 范围内:

    • Alice {Montreal: 12.3, Newark: 45.6, Dallas: 59.9, Beijing: 264.4};以及

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

  • Charlie 和 Dave 将不会匹配,因为 Dallas 信标的 | C-D | > 50:

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

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

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

3. 查看实例详情​

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

Status 指示服务健康状况,可能为 ONLINE、OFFLINE 或 ERROR。

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

  • Started at 有助于追踪最新的更新时间。

  • Size 对应我们的某一 价格层级。

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

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

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

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

您现在可以进行下一步。

4. 测试票证 API

首先,打开您的 Swagger URL,在 Swagger GUI 中检查您的 openAPI 模式

点击“Matchmaker”标题下方的 /...swagger.json URL 以打开原始 JSON 模式:

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

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

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

  • 保持选中 Postman Collection,

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

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

View more actions,打开标签页 Authorization 并选择:

  • Auth Type - API Key,

  • Key - “Authorization”

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

  • Add to - Header。

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

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

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

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

  • profile 指的是您的 匹配配置文件 (Matchmaking Profiles),

  • attributes 包含您的匹配器规则的值,在本例中为 latencies 规则,

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

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

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

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

  • profile 确认所选的 匹配配置文件 (Matchmaking Profiles),

  • 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 或带有进度条的加载屏幕,以指示初始化正在进行。

一旦游戏客户端完全加载,玩家即可加载/移动到主游戏场景。

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

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

  • 没有玩家加入比赛,

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

  • 比赛正常结束。

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

书写者

Edgegap团队

Get your Game Online Easily & in Minutes

立即开始集成!

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