> 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/unity/developer-tools.md).

# 开发者工具

面向 Unity 的 Edgegap 开发者工具，专为多人游戏服务器的快速迭代和频繁部署而打造。

我们为您打造这些工具，秉持一个简单的信条：“成功团队的关键在于快速迭代和频繁测试”。如果您发现任何可改进之处，请在我们的 [社区 Discord](https://discord.gg/NgCnkHbsGp)。我们希望您能享受流畅的体验。🚀

{% hint style="info" %}
[查找真实世界的示例](https://docs.edgegap.com/zh/docs/sample-projects/unity-netcodes.md) 您可以将其用作项目起点，并进一步修改。
{% endhint %}

#### 语义化版本控制

我们的开发者工具和托管服务使用官方 [语义化版本控制](https://semver.org/)，用于指明哪些更新是✅安全的（次要版本、补丁），哪些可能包含⚠️破坏性更改（主版本）。

**一旦某个版本发布，它将永远不会被修改/更改**.

{% hint style="warning" %}
**要升级服务版本 - 停止、编辑、重启。** 快速重启不会应用版本更改。
{% endhint %}

## ⚡ 专用服务器快速入门插件

直接从您的 Unity 编辑器构建并将您的专用游戏服务器部署到云端！

* [Unity 专用服务器插件——交钥匙解决方案、源代码和完整发布说明。](https://github.com/edgegap/buildtool-unity-plugin)

{% hint style="success" %}
本插件在免费套餐条款和条件下完全免费提供。
{% endhint %}

2021.3+ 之后的所有 Unity3D 长期支持（LTS）版本均受官方支持。

本插件包含旨在帮助您的功能：

* 为 Linux 构建并容器化您的专用服务器，
* 在本地测试您的服务器 Docker 镜像，
* 将您的服务器上传并部署到 Edgegap。

{% hint style="info" %}
本插件不会修改任何游戏行为，它只是一个用于 Edgegap 任务的便捷开发工具。该插件不会包含在您的构建中，因为它仅在服务器构建准备期间使用。
{% endhint %}

#### 安装

请参阅 [官方插件仓库](https://github.com/edgegap/buildtool-unity-plugin) 以获取详细的安装说明。

此插件已通过测试，并支持 Unity 2021.2 及以上版本，包括所有 LTS 版本、Unity 2023 和 Unity 6。

{% embed url="<https://youtu.be/3a5veDyxpoE>" %}

<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>

{% hint style="success" %}
请参见 [Unity](https://docs.edgegap.com/zh/unity.md) 以开始使用并查看插件使用的详细说明。
{% endhint %}

<details>

<summary>故障排查与常见问题</summary>

Unity 错误： `[包管理器窗口] 添加包时出错：https://github.com/edgegap/buildtool-unity-plugin.git`

* 要通过 git URL 添加我们的插件，您需要安装 git 客户端（[#installation](#installation "mention")).

***

Unity 错误： `缺少 Linux 构建支持`

* 请参见 [#usage-requirements](#usage-requirements "mention")，您很可能缺少 Linux 构建支持模块，您可以通过 Unity Hub 安装它们。请确保选择与项目相同的 Unity 版本。

</details>

{% hint style="info" %}
如果你需要帮助， [请通过 Discord 联系我们](https://discord.gg/MmJf8fWjnt)。关于实时游戏支持，请查看我们的 [工单系统](https://edgegap.atlassian.net/servicedesk/customer/portal/3).
{% endhint %}

{% hint style="info" %}
**致插件开发者** - 如果您希望在用户的编辑器中检测此插件的存在，可以使用编译指令实现 `#if EDGEGAP_PLUGIN_SERVERS {您的代码} #endif` .
{% endhint %}

## ⭐ 软件开发工具包

Unity SDK 包含用于部署、匹配和服务器浏览器的可选集成工具。此插件官方支持 Unity 2021.3.0f1 及更高版本。

{% hint style="info" %}
**Unity SDK 的最新版本是 `3.5.6`**。本文档中的所有示例均为最新版本。
{% endhint %}

{% hint style="success" %}
此插件完全免费提供，适用免费套餐的条款与条件。
{% endhint %}

#### 要求

<details>

<summary>安装 Git 客户端（例如 <a href="https://git-scm.com/">git-scm</a>)</summary>

Unity 需要使用 Git 客户端自动下载并安装我们的 Unity 软件包。安装完成后，您无需直接使用 Git。

</details>

#### 安装

1. 打开您的 Unity 项目，
2. 选择 `Window > Package Management > Package Manager` ,
3. 点击 :heavy\_plus\_sign: 图标并选择 `Add package from git URL...` ,
4. 出现提示时，输入 SDK 的 URL：

{% code title="" collapsedlinecount="10" %}

```
https://github.com/edgegap/sdk-unity-sessions-matchmaker-server-browser.git
```

{% endcode %}

5. 点击 `Add`  并等待安装完成。

#### 导入示例

此软件包包含多个示例，旨在单独使用（请勿组合使用这些示例）。

#### 已验证的来源

这是此 SDK 唯一的官方分发渠道，请勿信任未经验证的来源！

#### 更新软件包

在 Unity Package Manager 中找到 Edgegap SDK，然后点击 `Update` .

{% hint style="warning" %}
**导入的示例不会自动更新！** 备份所有自定义属性值，删除当前场景中使用的示例脚本，然后重新导入示例。
{% endhint %}

{% hint style="info" %}
某些版本可能包含重大变更。这类版本会以新的 MAJOR 版本号标示。
{% endhint %}

#### 更新到 v3

此次更新包含许多新的 [服务器浏览器](https://docs.edgegap.com/zh/unity/server-browser.md) 工具和示例，改进了匹配错误处理等。请参阅 [发行说明](https://docs.edgegap.com/zh/docs/release-notes.md) 查看完整列表。

{% hint style="warning" %}
Unity SDK v3 更新包含一些重大变更。请仔细重新测试您的集成。
{% endhint %}

<details>

<summary>Unity SDK v3 重大变更——范围、影响和解决方法</summary>

在命名空间 `Edgegap.Matchmaking`:

* 合并的方法 `Client._Abandon -> Client.StopMatchmaking` .
  * 影响较小——主要涉及自定义客户端处理程序的实现。
  * 解决方法——将 `_Abandon` 调用替换为 `StopMatchmaking` 方法。
* 合并的事件侦听器 `onTicketUpdate -> onAssignmentUpdate`.
  * 影响较小——大多数实现都无需使用此侦听器。
  * 解决方法——查找并替换为 [新事件](https://docs.edgegap.com/unity/matchmaking#client-events) 在……之下 `onAssignmentUpdate` 监听器。
* 已解耦 `Ping` , `SafeHttpRequest` ，以及 `Observable` 。已移至命名空间 `Edgegap` .
  * 影响较低 - 功能保持不变，只是移至另一个命名空间。
  * 解决方案 - 根据需要更新导入语句或命名空间引用。
* 由于与控制台的兼容性较差且增加了引导使用的阻力，已移除缓存功能。
  * 影响较低 - 崩溃的玩家可能会创建重复工单，而不是从缓存恢复。
  * 解决方案 - 使用以下内容实现自定义缓存： `onAssignmentUpdate` 事件监听器。
* 已重命名程序集 `com.edgegap.unity-matchmaking-sdk -> com.edgegap.unity-sdk` .
  * 影响较低 - 仅影响引用此 SDK 的高度定制化构建流水线。
  * 解决方案 - 在自定义工具中更新 SDK 程序集名称引用。

</details>

<details>

<summary>故障排查与常见问题</summary>

Unity： `[包管理器窗口] 添加包时出错：https://github.com/edgegap/sdk-unity-sessions-matchmaker-server-browser.git`

* 要通过 git URL 添加我们的插件，您需要安装 git 客户端。

***

Visual Studio： `找不到类型或命名空间名称` 在 Edgegap 命名空间中。

1. 在 Unity 编辑器中，导航到 **编辑 / 首选项 / 外部工具 / 生成 .csproj 文件**.
2. 请确保您已启用 **Git 包**.
3. 点击 **重新生成项目文件**.

</details>

{% hint style="info" %}
如果你需要帮助， [请通过 Discord 联系我们](https://discord.gg/MmJf8fWjnt)。关于实时游戏支持，请查看我们的 [工单系统](https://edgegap.atlassian.net/servicedesk/customer/portal/3).
{% endhint %}

## 📫 分布式中继传输库

为您的 netcode 库寻找一个自定义 Transport，以便在点对点游戏中使用分布式中继。

[查看文档](https://docs.edgegap.com/zh/learn/distributed-relay/relay-transport-samples.md):

* 下载 Edgegap Relay 示例：
  * [Mirror 示例](https://github.com/edgegap/relay-sample-unity-mirror-),
  * [FishNet 示例](https://github.com/edgegap/relay-sample-unity-fishnet-),
  * [Unity NGO 示例](https://github.com/edgegap/relay-sample-unity-ngo-helloworld).
* [Edgegap Relay Transport Library - 支持的 netcode 的源代码和发布说明。](https://github.com/edgegap/relay-transport-template-model)
