> For the complete documentation index, see [llms.txt](https://docs.edgegap.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.edgegap.com/zh/docs/sample-projects/unity-netcodes/fishnet-on-edgegap-webgl.md).

# Fishnet WebGL

使用 FishNet 的 Bayou WebSocket 传输，在 Edgegap 游戏服务器上运行一个 Unity WebGL 多人游戏。

本指南将帮助你使用 [FishNet](https://github.com/FirstGearGames/FishNet)的 Websocket 传输， [Bayou](https://fish-networking.gitbook.io/docs/manual/components/transports/bayou)，并在 Edgegap 上为 Unity 项目创建无头服务器。

你可以在 [最终示例项目](https://github.com/edgegap/netcode-game-sample-unity-fishnet-hashgrid) 在 GitHub 上，位于 `Fishnet_v4.1.6R_WebGL_Matchmaker` 文件夹中。本指南应适用于任何版本的 FishNet，只要你为其使用相应版本的 Bayou。

该 `开始游戏` 按钮在示例中有两种模式，可在 `MatchmakingSystem` 场景中的 gameObject 上选择 `MainMenu` 场景：

* **直接连接（默认）** - 客户端连接到你设置的服务器地址和端口。先对本地服务器进行测试，然后再对你从 Edgegap 仪表板启动的部署进行测试。不需要匹配器。
* **Edgegap 匹配器（可选，默认禁用）** -  [Edgegap Matchmaker](https://docs.edgegap.com/zh/learn/pi-pei-xi-tong.md) 将玩家分组，Edgegap 会在他们附近启动一个专用服务器，所有客户端都会自动连接到它。

{% hint style="info" %}
在这两种模式下， **游戏客户端从不持有 Edgegap API 令牌**。匹配器模式只使用匹配器的 `认证令牌`，可安全随游戏客户端一起发布。一旦对局为空，服务器就会停止其自身的部署。
{% endhint %}

### Unity 要求

本项目已在 Unity 版本 `2021.3.45f2`，搭配 FishNet `4.1.6R`、Bayou 传输和 Edgegap Unity SDK 上测试。你需要安装以下模块：

* WebGL 构建支持；
* Linux 专用服务器构建支持；
* Linux 构建支持（Mono）。

你还需要 [Docker](https://docs.docker.com/get-docker/) 将服务器容器化。

{% hint style="warning" %}
该示例需要 Edgegap Unity SDK `3.5.6` 或更高版本。在 Unity 2022.3 之前，SDK `3.5.5` 及更早版本会对 POST 请求的 JSON 正文进行表单编码，而匹配器会以 HTTP 400 响应每个工单请求。示例的 `Packages/manifest.json` 跟踪 SDK 的 `main` 分支。如果你改为固定某个标签，请使用 `#3.5.6` 或更新版本。
{% endhint %}

### 切换传输

示例已在端口上使用 Bayou `7770`。若要在你自己的项目中这样做，请下载 [Bayou Unity 包](https://github.com/FirstGearGames/Bayou/releases) ，从其 GitHub 发布页下载。通过以下工具栏在游戏项目中导入该包： `Asset/Import Package/Custom Package...`.

打开 `MainMenu` 位于以下位置的场景 `Assets/SpaceEdge/Scenes`。在 `NetworkManager` gameObject 中，移除 `Tugboat` 传输组件。将其替换为 `Bayou` 传输，位于 `Assets/FishNet/Plugins/Bayou`。记下已设置的端口值，在本例中是 `7770`.

你不需要 FishNet 的 `Start On Headless` 选项，而示例将其保持关闭。在服务器构建中， `EdgegapServerLifecycle` 组件（位于 `Assets/Edgegap`）会在 `0.0.0.0:7770`上启动 FishNet 服务器，因此同一个场景可用于客户端和服务器构建。在 Edgegap 上，如果 120 秒内无人加入，或最后一名玩家离开后 30 秒，它也会停止部署。

### 构建游戏服务器并进行容器化

使用 `Tools/Edgegap/Build Linux Dedicated Server` 工具栏菜单构建服务器。输出会到 `Builds/EdgegapServer/`，示例的 `Dockerfile` 会将其复制到镜像中。

要在本地测试，请在 Docker 中运行：

{% code collapsedlinecount="10" %}

```bash
docker build --platform linux/amd64 -t fishnet-server:local .
docker run -p 7770:7770 fishnet-server:local
```

{% endcode %}

日志显示 `Edgegap Server | Starting server on 0.0.0.0:7770.` 以及 `未在 Edgegap 上运行，已禁用自动停止。`

### 测试客户端

#### 在编辑器中或本地

创建一个 WebGL 客户端构建（请参见 [在 Itch.io 上](#on-itch.io) 了解构建设置），或者通过命令行构建：

{% code collapsedlinecount="10" %}

```bash
Unity -batchmode -quit -projectPath . -executeMethod EdgegapServerBuild.BuildClient -edgegapClientTarget webgl
```

{% endcode %}

提供 `Builds/Client/webgl` （例如使用 `python -m http.server 8080`），打开 `http://localhost:8080` 在两个标签页中，然后点击 `开始游戏`。 `MatchmakingSystem` 默认值（`直接地址` 设置为 `localhost`, `直接端口` 设置为 `7770`, `直接使用 Wss` 关闭）会连接到本地服务器。桌面构建（`-edgegapClientTarget win64`）也可以，因为 Bayou 支持原生客户端。

#### 在 Edgegap 服务器上

将镜像推送到你的 [容器仓库](https://docs.edgegap.com/zh/learn/advanced-features/edgegap-container-registry.md#getting-your-credentials)。你的 registry 项目、用户名和令牌位于仪表板的 `容器仓库` 页面中的用户名和令牌。

{% tabs %}
{% tab title="Bash（Linux）" %}

```bash
project='<REGISTRY_PROJECT>';
username='robot$<REGISTRY_ORGANIZATION_ID>+client-push';
token='<REGISTRY_TOKEN>';

echo "$token" | docker login registry.edgegap.com -u "$username" --password-stdin 2>&1
```

{% endtab %}

{% tab title="PowerShell（Windows）" %}

```powershell
$project = '<REGISTRY_PROJECT>'
$username = 'robot$<REGISTRY_ORGANIZATION_ID>+client-push'
$token = '<REGISTRY_TOKEN>'

echo "$token" | docker login registry.edgegap.com -u "$username" --password-stdin 2>&1
```

{% endtab %}
{% endtabs %}

然后构建并推送镜像：

{% code collapsedlinecount="10" %}

```bash
docker build --platform linux/amd64 -t registry.edgegap.com/<project>/fishnet-server:v1 .
docker push registry.edgegap.com/<project>/fishnet-server:v1
```

{% endcode %}

{% hint style="danger" %}
:x: **不要覆盖现有标签，也不要使用 `latest`  标签** ——这会部署过时的缓存。\
:white\_check\_mark: **应该始终递增版本标签** 并部署新的构建版本。
{% endhint %}

在 [Edgegap 仪表板](https://app.edgegap.com/application-management/applications/list)，为该镜像创建一个应用和一个版本：

* [端口](https://docs.edgegap.com/zh/learn/bian-pai/application-and-versions.md#port-mapping)：名称 `gameport`，端口 `7770`，协议 `WS`，并启用 `TLS 升级` 已启用。Edgegap 终止 TLS，因此浏览器使用 `wss://` 连接，而服务器使用普通的 `ws` （参见 [WebSocket（WS）和安全 WebSocket（WSS）](https://docs.edgegap.com/zh/learn/bian-pai/deployments.md#websockets-ws-and-secure-websockets-wss)).
* 容器注册表用户名和令牌：请设置它们，否则部署将无法拉取镜像。

从仪表板部署该版本。在 `MatchmakingSystem` gameObject 中，将 `直接地址` 设置为部署主机（`<id>.pr.edgegap.net`), `直接端口` 设置为其外部端口，并启用 `直接使用 Wss`。重新构建客户端并点击 `开始游戏`.

#### 使用 Edgegap 匹配器（可选）

在直接连接正常后，开启匹配器：

1. 在示例的 `matchmaker-config.json`中，将 `application.name` 以及 `版本` 设置为你的应用和版本，并在其中列出提供 WebGL 构建的每个来源 [`allowed_cors_origins`](https://docs.edgegap.com/zh/learn/pi-pei-xi-tong/matchmaker-in-depth.md#cross-origin-resource-sharing-cors).
2. 在仪表板中，打开 [匹配器](https://app.edgegap.com/matchmaker-management-v2/matchmakers/list)，点击 `创建匹配器`，上传文件，然后点击 `创建并启动`.
3. 在 `MainMenu` 场景，复制匹配器的 `API URL` 以及 `认证令牌` 到 `Base Url` 以及 `认证令牌` 字段中，位于 `Edgegap Matchmaking Client` 组件，在 `Edgegap` gameObject 上。然后启用 `使用 Edgegap 匹配器` 在 `MatchmakingSystem` gameObject。
4. 重新构建客户端，并从以下列出的来源提供它 `allowed_cors_origins` （例如 `http://localhost:8080`），打开两个标签页并点击 `开始游戏` 在两个客户端中都按下。

客户端会创建一个工单，等待分配服务器，然后使用 `wss://`。 `休闲` 配置文件匹配 2 到 4 名玩家。它还会在 30 秒后将最少人数降低为 1 人，但单独玩家可能只有在工单接近 5 分钟过期时才会分配到服务器，因此请用两个客户端测试。

要发布新的服务器构建：构建服务器，推送新标签，创建新的应用版本，然后在匹配器中点击 `停止`，编辑 `application.version` 并点击 `启动` （参见 [滚动更新](https://docs.edgegap.com/zh/learn/pi-pei-xi-tong/matchmaker-in-depth.md#rolling-updates-and-ab-tests)).

{% hint style="info" %}
WebGL 客户端无法 ping [延迟信标](https://docs.edgegap.com/zh/learn/bian-pai/ping-beacons.md)，因此示例的匹配器配置文件没有 `延迟` 规则，Edgegap 会根据玩家的 IP 地址放置服务器。参见 [匹配系统](https://docs.edgegap.com/zh/learn/pi-pei-xi-tong.md) 以了解更多。
{% endhint %}

#### 在 Itch.io 上

一旦你确认游戏客户端在本地正常工作，它也应该能在 Itch.io 上工作。要将游戏上传到那里，你需要在 `构建` 界面，在 Unity 编辑器的 `File -> Build Settings`中制作一个客户端构建。请选择以下选项：

* 将 `平台` 变为 `WebGL`;
* 打开 `玩家设置`。在 `Player -> Publishing Settings`中，将 `压缩格式` 变为 `Gzip` 并确保 `Decompression Fallback` 选项已选中。保存这些设置，并关闭窗口。

<figure><img src="https://3334189208-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsR0dHSFv9ymoC0DO5G8J%2Fuploads%2Fgit-blob-d31291cf36a863193c24a856718a791db0c61577%2Fbuild-settings.png?alt=media" alt=""><figcaption></figcaption></figure>

然后点击构建，并选择一个名为 `构建` 作为文件目标。将此 `构建` 文件夹中的文件压缩为 zip 包，并确保它们位于根目录。然后将 zip 包上传到你的 Itch 项目，并确保选择在浏览器中运行文件的选项。这样游戏应与本地运行方式相同。在匹配器模式下，将你的 Itch.io 页面来源添加到 `allowed_cors_origins` 中，先添加。
