For the complete documentation index, see llms.txt. This page is also available as Markdown.

Lightnet 小型网络中继

了解如何在 Edgegap 上运行自己的小型网络中继,并使用一个通过它进行游戏的 Unity 游戏示例,采用 Mirror, FishNet, PurrNet 或 Netcode for GameObjects (NGO).

该中继是一个基于 LightNet构建的小型 .NET 服务器。Edgegap 会像处理其他服务器一样托管和编排它:一个部署实例,在靠近玩家的位置启动。一名玩家创建房间并获得一个 6 位代码,其他玩家使用该代码加入。没有玩家需要开放端口:包括主机在内的所有人都是中继的客户端。

此示例展示:

  • 一个中继服务器 位于一个 linux/amd64 Docker 镜像中,监听端口 7777 同时用于 TCP(可靠消息)和 UDP(不可靠消息),

  • 带有加入代码的房间 - 多个房间可以共享一个中继部署实例,

  • 四种网络代码上的 Tanks 示例 - 在一个 Unity 项目、一个构建中使用 Mirror、FishNet、PurrNet 和 NGO,

  • 一个设置即可切换网络代码 - 可在设置资源、编辑器菜单、连接前的游戏内或命令行中切换,

  • 可选的 Edgegap 匹配 - 默认关闭: 寻找匹配 将附近的玩家安排到他们附近的中继上;每个房间由一名玩家托管,之后搜索的玩家会加入正在运行的房间;当一个中继的房间已满时,会在启动另一个中继之前创建新房间,

  • 可选的加密连接 - wss:// 通过 Edgegap 的 TLS Upgrade,与普通 TCP 和 UDP 并列提供,

  • 自动化测试 - 游戏客户端通过每种网络代码的中继进行游戏,可使用房间代码或通过匹配器。

替代方案 - 专用服务器 可防止主机玩家占优,并且主机离开后比赛仍会继续。

✔️ 准备工作

在开始之前,你需要:

安装 Docker Desktop(或 Docker CLI)

该仓库包含四个部分:

文件夹
内容

LightNet

作为 Unity 包的 LightNet 网络核心,以及中继协议和与网络代码无关的客户端。

relay-server

中继服务器 - 由相同源代码构建的 .NET 8 控制台应用及其 Dockerfile。

tanks

Unity 项目:在 Mirror、FishNet、PurrNet 和 NGO 上运行的 Mirror Tanks 示例。

matchmaker-config.json

可选的匹配器配置,参见 可选匹配.

🔀 选择网络代码

网络代码是 网络代码 的字段,位于 tanks/Assets/Tanks/Resources/TanksSettings.asset: Mirror, FishNet, PurrNet 或 NGO。同一资源还包含中继地址和端口。

你也可以切换它:

  • 在 Unity 编辑器中,通过 Tanks > Netcode 菜单 - 这也会打开该网络代码的场景,

  • 在游戏中,于托管或加入前使用屏幕顶部的网络代码按钮,

  • 在命令行中,使用 -netcode FishNet.

网络代码
版本
坦克同步

Mirror

66.0.9

SyncVar, Command, ClientRpc,客户端权威 NetworkTransform

FishNet

4.7.4

SyncVar<int>, ServerRpc, ObserversRpc,客户端权威 NetworkTransform

PurrNet

1.24.1

SyncVar<int>, ServerRpc, ObserversRpc,所有者权威 NetworkTransform

NGO

1.13.0

NetworkVariable<int>, ServerRpc, ClientRpc,所有者权威 NetworkTransform

每种网络代码都有自己的中继传输层,构建于同一个中继客户端之上(RelayPeer): MirrorRelayTransport, FishNetRelayTransport, PurrNetRelayTransport 和 NgoRelayTransport。要在自己的游戏中使用中继,请复制 LightNet 包和适用于你的网络代码的传输层。

⚡ 部署并连接

1. 在本地运行中继

☑️ 在仓库根目录中,构建并运行中继镜像:

☑️ 打开 tanks 在 Unity 中,选择一种网络代码,并使用以下项构建: Tanks > Build Windows client,或在以下项上按 Play: Assets/Tanks/Scenes/Boot.unity.

☑️ 在第一个游戏中,按下 托管:屏幕上会显示房间代码。在第二个游戏中,输入该代码并按下 加入房间.

✅ 现在你可以继续下一步。

2. 推送中继镜像

☑️ 开始之前,你需要 在 Edgegap 注册一个免费账户。无需信用卡。

☑️ 找到你的 容器镜像仓库 项目名称和凭据。

☑️ 使用你的注册表项目名称、用户名和令牌,通过 Docker 登录 Edgegap 的容器注册表:

☑️ 为中继镜像打标签并推送,每次构建使用一个新标签:

✅ 现在你可以继续下一步。

3. 创建应用版本

☑️ 创建一个应用 名为 lightnet-relay,并创建一个具有以下内容的版本:

  • 镜像 registry.edgegap.com/<project>/lightnet-relay 以及你的标签,

  • 你的容器镜像仓库用户名和令牌,以便 Edgegap 可以拉取你的镜像,

  • 资源为 0.25 vCPU 和 512 MB 内存,

  • 一个 端口 7777,命名为 中继,协议为 TCP/UDP,

  • 可选,用于 加密连接:第二个端口 7778,命名为 relay-ws,协议为 WS,并启用 TLS 升级 开启,

  • 最长持续时间 测试时为 30 分钟。

可选的中继设置,作为 应用版本上的环境变量:

变量
默认值
作用

RELAY_TCP_PORT

7777

可靠消息的端口

RELAY_UDP_PORT

7777

不可靠消息的端口

RELAY_MAX_PEERS

256

所有房间的最大并发连接数

RELAY_IDLE_EXIT_SECONDS

600

在没有房间持续这么长时间后停止中继, 0 = 永不(由匹配器启动的中继会在最后一个房间结束时停止)

RELAY_WS_PORT

7778

WebSocket 连接的端口, 0 = 关闭

RELAY_MATCH_MAX_PLAYERS

4

由匹配器启动的中继中每个房间的玩家数;回填最多填充至此数量

RELAY_MAX_ROOMS

4

由匹配器启动的每个中继的房间数

RELAY_SOLO_ROOM_SECONDS

120

关闭主机独自停留这么长时间的房间;随后游戏会再次搜索

MATCHMAKER_URL

匹配器 API URL,用于 回填

MATCHMAKER_TOKEN

匹配器认证令牌,用于回填

✅ 现在你可以继续下一步。

4. 部署并开始游戏

☑️ 部署你的新应用版本 到玩家附近。准备就绪后,记下它的主机名(<id>.pr.edgegap.net)和以下项的外部端口: 中继.

☑️ 在两个游戏中, 在连接前于屏幕上设置中继地址和端口,或从命令行启动它们(替代方式):

☑️ 在第一个游戏中托管房间,并从第二个游戏使用代码加入它。

中继日志会显示在部署启动后立即连接并离开的一个玩家:这是 Edgegap 的就绪检查,不是玩家。

您在 Edgegap 云上的部署的外部端口将随机选择,以便在潜在攻击者(黑客)造成损害之前减缓并检测到他们。

☑️ 一旦您确认可以无问题连接到您的部署并完成测试, 停止您的部署 以释放您账户中的容量用于下一次构建。

🙌 恭喜您在 Edgegap 上完成首次部署!如果您想了解更多,请继续阅读。

🎯 可选匹配

房间代码适用于朋友之间。若要匹配彼此不认识的玩家,请开启 Edgegap 匹配:玩家按下 寻找匹配,匹配器会将彼此附近的 2 至 4 名玩家分组,并在他们附近为比赛启动一个中继。中继随后选择一名玩家托管,并将房间代码提供给其他人,因此无需任何人输入代码。按下 寻找匹配 的玩家之后会加入有空位的房间;当一个中继的房间全满时,会在匹配器启动另一个中继之前创建新房间。它默认关闭,且通过代码托管和加入仍可与其并行使用。

比赛如何开始:

  1. 每位玩家的游戏会测量自己到 Edgegap 信标的延迟,并创建一张匹配票据。

  2. 匹配器将票据分组,并从你的应用版本部署一个中继。Edgegap 会向该中继提供匹配票据列表(MM_TICKET_IDS).

  3. 每个游戏使用自己的票据 ID 连接中继。第一个请求的匹配玩家托管比赛房间,其他玩家加入。未在该比赛中的票据会被拒绝。

  4. 只要房间还有空位,中继就会通过回填向匹配器请求更多玩家。一旦所有房间都满员,它会改为提供一个新房间。请参阅下面的步骤 3。

  5. 最后一个房间结束时,中继会删除其回填并停止自己的部署,因此已结束的比赛不会产生任何费用。

未使用匹配器部署的中继仍会像以前一样通过房间代码工作。

1. 创建匹配器

☑️ 打开 matchmaker-config.json 从仓库中获取,并设置 application.name 和 版本 为步骤 3 中的应用版本:

在前 10 秒内,一张票据只能加入有空位的中继(min_team_size 9999 无法满足)。10 秒后应用常规规则,2 至 4 名等待玩家将获得一个新中继。

该 信标 规则让玩家与附近的玩家匹配:如果玩家到一个信标的延迟低于 150 毫秒,该信标便会计入;匹配玩家到该信标的延迟彼此必须相差不超过 100 毫秒。游戏会在每张票据中发送其延迟(匹配器延迟信标 位于 TanksSettings.asset中,默认开启)。

☑️ 在仪表板中,打开 匹配器,点击 创建匹配器,上传文件,然后 创建并启动.

☑️ 当匹配器处于 在线时,复制其 API URL 和 认证令牌.

认证令牌可安全地随游戏发布:它允许玩家创建票据,且不会授予对你的 Edgegap 账户的任何访问权限。

☑️ 将它们作为环境变量添加到你的应用版本中 MATCHMAKER_URL 和 MATCHMAKER_TOKEN,以便中继能够填补空位(步骤 3)。

✅ 现在你可以继续下一步。

2. 寻找匹配

☑️ 在 tanks/Assets/Tanks/Resources/TanksSettings.asset中,开启 使用匹配器 并粘贴 匹配器 URL 和 匹配器令牌。配置文件(休闲)和端口名称(中继)已与上述配置匹配。

☑️ 构建游戏,启动两个副本,并在两者中按下 寻找匹配 。或者从命令行启动它们:

☑️ 两个游戏都会显示匹配状态,随后一个托管,另一个加入:两个游戏中都会出现两辆坦克。

匹配客户端位于 Assets/Tanks/Core/TanksMatchmaker.cs,构建于 Edgegap Unity SDK之上。它绝不依赖网络代码:它将中继地址放入设置中,并像 托管 和 加入房间 按钮一样以主机或玩家身份启动游戏。

✅ 现在你可以继续下一步。

3. 一个中继,多个房间

由匹配器启动的中继会在其第一场比赛开始后继续通过回填为匹配器工作。回填是由中继拥有的票据,其中携带中继自己的地址。当匹配器将玩家的票据放入其中时,该玩家会获得中继地址,并像其他玩家一样请求自己的角色,然后加入或托管房间。游戏无需任何额外操作:这与 寻找匹配 流程相同。

  • 优先处理有空位的房间。 只要一个房间中的玩家数量(包括正在加入的玩家)少于 RELAY_MATCH_MAX_PLAYERS (默认值 4)名玩家,中继就会为它保持最多 3 个开放的回填。被分配到此处的玩家会加入该房间。

  • 然后创建新房间。 一旦所有房间已满,且中继的房间少于 RELAY_MAX_ROOMS (默认值 4)个房间时,它会提供一个新房间。被分配到此处的玩家将托管它,该房间会像其他房间一样填满。

  • 仅限附近的玩家。 中继会随其回填发送房间自身玩家的票据,因此 信标 规则会根据这些票据检查新玩家。

  • 独自留下的主机 持续 RELAY_SOLO_ROOM_SECONDS (默认值 120)后会被告知房间已关闭,游戏会自行搜索另一场比赛。

  • 最后一个房间结束时,中继会停止,而不是在某个主机离开时。它会先删除回填,因此不会有玩家被发送到已消失的中继。

  • 速率限制。 每个中继最多开放 5 个回填,创建间隔至少为 0.3 秒。

☑️ 当两个游戏之间正在进行比赛时,在第三个游戏中按下 寻找匹配 :它会加入正在运行的房间,三个游戏都会看到三辆坦克。

☑️ 使用 4 个游戏填满一个房间,然后在另外两个游戏中按下 寻找匹配 :第一个会在同一中继上托管新房间,第二个会加入它。

如果应用版本上没有 MATCHMAKER_URL 和 MATCHMAKER_TOKEN ,中继会记录 backfill: off:其房间不会接收新玩家,也不会创建新房间。

中继的回填代码位于 relay-server/MatchBackfill.cs 和 relay-server/RelayServer.cs.

🔒 加密连接

默认情况下,通过中继的游戏流量 未加密:它通过普通 TCP 和 UDP 传输。保护玩家的机制是没有人能看到其他玩家的 IP 地址,并且使用匹配器时,只有匹配的玩家能获得房间代码。对匹配器的调用使用 HTTPS。

要进行加密,玩家可以改为通过 WebSocket 连接。使用 TLS 升级 在 relay-ws 端口(步骤 3)上,Edgegap 会持有证书,且连接会是 wss://:每个玩家与 Edgegap 之间的流量都已加密,且中继无需证书。

☑️ 为游戏提供一个 wss:// 中继地址,而不是主机名,并使用外部端口 relay-ws:在屏幕上,在 TanksSettings.asset,或在命令行中:

☑️ 使用匹配器时,启用 匹配器使用 WebSocket 位于 TanksSettings.asset (或 -matchmakerWebSocket):游戏连接到对战中继的 relay-ws 端口。

使用主机名(<id>.pr.edgegap.net),而不是 IP 地址:证书是针对主机名的。加密在 Edgegap 处结束:中继和主机的游戏仍然能看到它们转发的内容,就像任何中继一样。

🧪 自动化测试

在 Windows 构建版本和正在运行的中继(本地或在 Edgegap 上)下, e2e.sh 会在每种网络代码上启动一个主机和一个客户端:

客户端负责驾驶和射击。当两个游戏都看到两辆坦克、都在可靠和不可靠通道上收到数据、都看到一个投射物生成,并且主机看到客户端的坦克移动时,该网络代码测试即通过。

使用匹配器时, e2e-matchmaker.sh 会通过它运行相同的测试:在每种网络代码上,两个游戏按下 寻找匹配 并在匹配器启动的中继上进行比赛。使用 BACKFILL=1时,第三个游戏按下 寻找匹配 ,在比赛开始后并且必须通过补位加入。使用 MULTIROOM=1时,四个游戏填满一个房间,然后第五个必须在同一个中继上主持一个新房间,第六个必须加入它。使用 MM_WEBSOCKET=1时,游戏通过 wss://.

💡 你需要知道

  • 中继如何转发数据 - 主机的消息只发送给一名玩家,而每个玩家的消息也只发送给主机。玩家之间从不直接通信。可靠消息通过 TCP 传输,不可靠消息通过 UDP 传输,或者两者都通过同一个 WebSocket 传输。

  • 消息大小 - 每条不可靠消息最多 1,177 字节,每条可靠消息最多 16 KB。传输层会将这些限制报告给其网络代码。

  • 当主机离开时 - 房间关闭,中继断开其玩家的连接。此示例中的网络代码不会迁移主机。

  • 一个中继还是多个中继 - 当玩家使用房间代码时,一个部署可服务多个房间。使用 匹配器时,每个中继最多承载 RELAY_MAX_ROOMS 个靠近其玩家的房间,只有在附近的中继都满了时才会启动新的中继。

  • 对 LightNet 的更改 - 此示例的 LightNet 可在 NAT 和端口映射后工作:中继会在每个玩家流量的来源地址上响应其 UDP 流量。完整列表请参阅仓库的 README。

最后更新于

这有帮助吗?