> 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/playfab-spaceedge.md).

# PlayFab SpaceEdge

一款 Unity 太空射击游戏，由 PlayFab Matchmaking 为玩家配对，并通过两个 Azure Functions 为每场比赛在玩家附近启动一台 Edgegap 专用服务器。

了解如何将 **PlayFab 匹配** 保持独立，并让每场比赛都在自己的 **Edgegap** 专用服务器上运行，使用 [SpaceEdge PlayFab 示例](https://github.com/edgegap/backend-game-sample-unity-playfab-matchmaker-fishnet-spaceedge)——一款基于 FishNet 的小型 Unity 太空射击游戏。

玩家登录 PlayFab 并点击 **开始游戏**。PlayFab 为玩家匹配后，Azure Function 会在离他们较近的位置启动 Edgegap 服务器，另一个 Azure Function 会将地址和加入令牌发送给每位玩家。服务器只允许已匹配的玩家加入，并会在玩家离开后自行停止。

此示例展示了：

* **Unity 2021.3.45f2** 项目使用 **FishNet 3.11.14** （Tugboat，UDP 7770），并使用 [Edgegap Unity 插件](https://github.com/edgegap/buildtool-unity-plugin),
* **PlayFab 匹配** 关闭服务器分配功能：由 PlayFab 组建比赛，由 Edgegap 承载，
* **两个 Azure Function** （Node.js 22，无 SDK）：其中一个在 `match_found`时部署服务器；另一个接收 Edgegap 的就绪 Webhook，并将地址写入每位玩家的只读数据中，
* **加入令牌**：服务器只允许 PlayFab 匹配的玩家加入，不保存任何 PlayFab 密钥，
* **服务器自动停止**：无人加入时，或所有玩家离开后，服务器会停止自己的部署。

{% hint style="info" %}
已于 2026 年 10 月 21 日在 Edgegap 上完成端到端验证，使用 Windows 客户端和人数为 2 的 PlayFab 队列：函数调用后约 8 秒，地址便发送给了两位玩家。加入令牌和插件构建版本是在之后添加的，并通过单元测试和本地服务器容器进行了测试。
{% endhint %}

{% hint style="success" %}
[从 PlayFab 部署](https://docs.edgegap.com/zh/docs/tools-and-integrations/playfab-bridge.md) 详细说明了各个部分，帮助你将 Edgegap 集成到自己的 PlayFab 游戏中。
{% endhint %}

## ✔️ 准备工作

{% hint style="info" %}
此示例使用 Unity `2021.3.45f2` 开发和测试，请使用相同版本。
{% endhint %}

开始之前，请务必 [在 Edgegap 创建一个免费账户](https://app.edgegap.com/auth/register) （无需信用卡）。你可以 [之后邀请你的团队成员](https://app.edgegap.com/user-settings?tab=organizations)，即使他们还没有 Edgegap 账户。

**在你的开发机器上配置一些基本内容：**

<details>

<summary>安装 Unity Linux 构建支持模块</summary>

* 使用 Unity Hub 选择 选项卡 **安装**，访问 **设置** 和 **添加模块** 对于您打算与 Edgegap 平台一起使用的每个 Unity 版本：

<figure><img src="https://3334189208-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsR0dHSFv9ymoC0DO5G8J%2Fuploads%2FylRG4r8orenZrw5ijjpJ%2Fimage.png?alt=media&amp;token=fb981825-8a15-4c07-9180-0f79a6a77a91" alt=""><figcaption></figcaption></figure>

* 向下滚动以选择并安装以下 Unity 模块：
  * **Linux 构建支持（IL2CPP），**
    * **Linux 构建支持（Mono），**
    * **Linux 专用服务器构建支持**

<figure><img src="https://3334189208-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsR0dHSFv9ymoC0DO5G8J%2Fuploads%2FuXtyqoLhBOk8CZJ4WdzA%2Fimage.png?alt=media&amp;token=19e956ed-a731-420d-b911-130c334794fc" alt=""><figcaption></figcaption></figure>

</details>

<details>

<summary><a href="https://www.docker.com/products/docker-desktop/">安装 Docker Desktop（或 Docker CLI）</a></summary>

* [从官方来源安装 Docker Desktop](https://www.docker.com/products/docker-desktop/) （无需账户）。
* 完成安装后重启计算机。

</details>

* 一个 [PlayFab](https://developer.playfab.com) 标题、其 Title ID 和一个密钥，
* 一个 Azure 订阅以及 [Azure CLI](https://learn.microsoft.com/cli/azure/install-azure-cli),
* 一个 Edgegap API 令牌，可在 [Dashboard → User Settings → Tokens](https://app.edgegap.com/user-settings?tab=tokens)获取。该令牌只应放在 Function App 的设置中，绝不能放入游戏中。

## ⚡ 运行示例

### 1. 游戏服务器

{% hint style="info" %}
此步骤的详细指南请参阅 [Unity](https://docs.edgegap.com/zh/unity.md) 入门指南。
{% endhint %}

在 Unity 中打开 `SpaceEdge_project` ，然后选择 **工具 → Edgegap 服务器托管**:

1. **使用 Edgegap 登录**，然后 **构建服务器**.
2. **使用 Docker 容器化**：映像名称 `playfab-fishnet`，映像标签留空（插件会使用当前 UTC 时间）。
3. **上传到 Edgegap**：应用程序 `playfab-fishnet`，然后 **上传映像并创建应用程序版本**。在打开的版本表单中，设置一个名为 `gameport`的端口，配置为 7770、UDP，以及 0.5 个 vCPU / 1 GB。保留建议的版本名称：Azure Functions 需要用到它。

{% hint style="info" %}
服务器无需环境变量或密钥；Functions 会传递部署匹配详情。
{% endhint %}

### 2. PlayFab 标题

1. 创建匹配队列 `edgegap-fishnet`，匹配人数设为 2-2，并将 **启用服务器分配** 设为关闭。
2. 在 **标题设置 → API 功能**中，取消勾选 **禁用通过 Client/LoginWithCustomId 创建玩家**.
3. 在 **标题设置 → 密钥**.

### 中创建一个密钥。

3\. Azure Functions `将示例中的` 文件夹部署到运行 Node.js 22 的 Flex Consumption Function App，并按照 [从 PlayFab 部署](https://docs.edgegap.com/zh/docs/tools-and-integrations/playfab-bridge.md)中的说明设置其应用设置。使用你的应用程序 `playfab-fishnet` 以及步骤 1 中的版本名称。然后在 PlayFab 中注册 `StartEdgegapDeployment` ，并在 `playfab.matchmaking.match_found`.

### 上添加规则。

1. 4\. 进行一场对局 `打开场景`，并在 `对象上设置你的` 。 **标题 ID**。队列名称已设为 `edgegap-fishnet`.
2. 构建 Windows 测试客户端（Mono，无需 Windows IL2CPP 模块），然后运行两次，分别作为两个 PlayFab 玩家：

```bash
"<Unity>" -batchmode -projectPath SpaceEdge_project -executeMethod EdgegapPluginBuild.BuildClient -logFile build-client.log
SpaceEdge_project/Builds/Client/win64/Game.exe -playfabCustomId player-a
SpaceEdge_project/Builds/Client/win64/Game.exe -playfabCustomId player-b
```

3. 按下 **开始游戏** 两端都执行此操作。PlayFab 匹配成功后，Edgegap 仪表板中会出现一个部署，其标签以匹配 ID 的开头部分命名 [Edgegap 仪表板](https://app.edgegap.com/deployment-management/deployments/list)，几秒后两个客户端都会连接。
4. 退出两个客户端：服务器会在一分钟内自动停止。

{% hint style="info" %}
免费套餐一次只能运行一个部署：测试前请先停止其他部署。
{% endhint %}

## 🔧 已知限制

* **每场比赛限 2 名玩家。** 仅测试了 2 人队列。若要进行人数更多的比赛，请提高队列的比赛人数上限并重新测试。
* **仅测试了 Windows 客户端。** 客户端代码仅使用 `UnityWebRequest` 和 `JsonUtility`，因此理论上可以在 WebGL 中运行，但 Web 版本还需要 WebSocket 传输和端口。
