> 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/godot/arena-shooter.md).

# 竞技场射击游戏

使用 Edgegap Arena Shooter 示例，在 Edgegap 上托管一款 Godot 4 多人竞技场射击游戏，配备专用服务器和匹配功能。

了解如何使用来自以下内容的技术在 Edgegap 上托管 Godot 项目 [Super Star Fighter](https://github.com/DumpsterFireLabs/SuperStarFighter) 由 Dumpster Fire Labs 开发的俯视角竞技场射击游戏。

玩家按下 **查找对局**， [Edgegap Matchmaker](https://docs.edgegap.com/zh/learn/pi-pei-xi-tong.md) 将他们分组并在他们附近启动专用服务器，比赛结束后服务器会自行停止。

此示例展示：

* **Godot 4.7.2** 使用 GDScript 的游戏，导出为无头 Linux 专用服务器，
* **服务器权威型网络代码** 通过一个 WebSocket 端口——服务器运行整个模拟，客户端则通过 `wss://`,
* **Edgegap Matchmaker** 集成——客户端创建票证，等待服务器，然后加入，
* **服务器自停** ——比赛结束后，或者没人加入时，服务器会停止自身部署，
* **NPC 补位** ——NPC 会占据空位，因此单人玩家也能获得一场对局。

{% hint style="success" %}
请参阅 [EDGEGAP.md](https://github.com/edgegap/game-sample-godot-arena-shooter/blob/main/EDGEGAP.md) 示例仓库中的完整 Edgegap 文件和服务器设置列表。
{% endhint %}

## ✔️ 准备工作

开始之前，你需要：

* [Arena Shooter 示例项目](https://github.com/edgegap/game-sample-godot-arena-shooter) （为 Edgegap 修改），
* Godot 4.7.2 —— 示例会自行下载一份（见下文），
* Python 3 —— 用于运行示例的构建脚本。

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

☑️ 将固定版本的 Godot 和导出模板下载到被忽略的 `.tools` 文件夹中，在仓库根目录的 PowerShell 中运行：

{% code collapsedlinecount="10" %}

```powershell
.\tools\bootstrap.ps1
```

{% endcode %}

不会在系统范围内安装任何内容。

## ⚡ 部署并连接

### 1. 构建服务器镜像

☑️ 开始之前，你需要 [在 Edgegap 注册一个免费账户](https://app.edgegap.com/auth/register)。无需信用卡。

☑️ 找到你的 [容器镜像仓库](https://docs.edgegap.com/zh/learn/advanced-features/edgegap-container-registry.md#getting-your-credentials) 项目名称和凭据，然后使用以下命令登录： `docker login registry.edgegap.com`.

☑️ 导出 Linux 专用服务器，然后构建并推送你的镜像：

{% code collapsedlinecount="10" %}

```bash
python tools/build.py bootstrap
python tools/build.py build server-linux-x64 --skip-gate
docker build --platform linux/amd64 -f edgegap/Dockerfile -t registry.edgegap.com/<project>/arena-shooter:<tag> builds/beta-19/server-linux-x86_64
docker push registry.edgegap.com/<project>/arena-shooter:<tag>
```

{% endcode %}

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

你的服务器监听 WebSocket 端口 `7000`。在 Edgegap 部署之外，它的行为与上游游戏完全相同。

✅ 现在可以继续下一步。

### 2. 创建应用版本

☑️ [创建一个应用](https://app.edgegap.com/application-management/applications/list) 名为 `godot-arena-shooter`，以及一个版本名为 `v1` ，内容如下：

* 你的 `registry.edgegap.com/<project>/arena-shooter:<tag>` 镜像，
* 你的容器镜像仓库用户名和令牌，以便 Edgegap 可以拉取你的镜像，
* 资源为 0.5 vCPU 和 1 GB 内存，
* [端口](https://docs.edgegap.com/zh/learn/bian-pai/application-and-versions.md#port-mapping) `7000`，命名为 `gameport`，协议为 **WS**，并启用 **TLS 升级** 。

{% hint style="warning" %}
客户端通过以下方式连接： `wss://`，因此 **必须启用 TLS 升级**，否则客户端无法连接。请参阅 [WebSocket（WS）和安全 WebSocket（WSS）](https://docs.edgegap.com/zh/learn/bian-pai/deployments.md#websockets-ws-and-secure-websockets-wss).
{% endhint %}

可选：在你的应用版本上设置环境变量：

* `EDGEGAP_NPC_FILL` ——用 NPC 将对局补满，最多补到这么多艘飞船（默认 `4`, `0` 会禁用 NPC），
* `EDGEGAP_START_GRACE` ——在第一个玩家加入后，等待所有已匹配玩家的秒数（默认 `30`),
* `EDGEGAP_JOIN_TIMEOUT` ——空服务器在自动停止前等待的秒数（默认 `120`),
* `EDGEGAP_ROUNDS_TO_WIN` ——赢得对局所需的回合数（默认 `3`).

✅ 现在可以继续下一步。

### 3. 创建匹配器

☑️ 打开 [匹配器](https://app.edgegap.com/matchmaker-management-v2/matchmakers/list) 页面，然后点击 **创建**.

☑️ 上传 `edgegap/matchmaker-config.json` 示例中的文件。若你的 `application.name` 和 `application.version` 不同，请进行更改。

该配置只有一个 `休闲` 适用于 2 到 4 名玩家的配置。等待 30 秒后，单个玩家也可以单独匹配。

☑️ 点击 **创建并启动**，然后等待你的匹配器就绪。

☑️ 复制你的匹配器的 **API URL** 和 **认证令牌**.

✅ 现在可以继续下一步。

### 4. 连接客户端

☑️ 将你的匹配器 URL 和认证令牌粘贴到 `src/client/edgegap/edgegap_settings.gd`:

{% code collapsedlinecount="10" %}

```gdscript
const MATCHMAKER_URL := "https://<your-matchmaker-url>"
const MATCHMAKER_AUTH_TOKEN := "<your-auth-token>"
```

{% endcode %}

你也可以设置 `EDGEGAP_MATCHMAKER_URL` 和 `EDGEGAP_MATCHMAKER_TOKEN` 在启动客户端时使用环境变量。

{% hint style="info" %}
认证令牌属于你的匹配器，不会授予对 Edgegap 账户的访问权限，因此可以安全地随游戏客户端一起发布。 **切勿将你的 Edgegap API 令牌放入客户端。**
{% endhint %}

☑️ 使用以下命令构建 Windows 客户端： `python tools/build.py build windows --skip-gate`，或者运行 `.\tools\start-client.ps1`.

☑️ 启动两个客户端并按下 **查找对局** 在两个客户端中都按下。

两个客户端会获得同一个服务器并加入它。对局会在所有已匹配玩家都加入后开始，或者在第一个玩家加入 30 秒后开始，空位由 NPC 填补。

祝贺你在 Edgegap 上完成了第一个匹配部署！

## 🔄 对局生命周期

1. 客户端使用以下内容创建票证： `休闲` 配置文件，然后每 2 秒检查一次，直到分配到服务器。
2. 匹配器在 `godot-arena-shooter` 玩家附近部署。服务器从 [`MM_TICKET_IDS`](https://docs.edgegap.com/zh/learn/pi-pei-xi-tong/matchmaker-in-depth.md#injected-variables).
3. 客户端加入 `wss://<host>:<external port>` 通过游戏的直接连接代码。大厅密码是该部署的请求 ID，因此只有已匹配的玩家才能进入。
4. 服务器开始对局，并用 NPC 填补空位，最多 4 艘飞船。
5. 最终结果显示 20 秒后，服务器调用 `ARBITRIUM_DELETE_URL` 以停止其部署。如果 120 秒内没人加入，或者所有人离开 30 秒，它也会停止。

每个部署只运行一场对局。对局结束后，玩家按下 **查找对局** 再次。

请参阅 [匹配系统](https://docs.edgegap.com/zh/learn/pi-pei-xi-tong.md) 和 [部署](https://docs.edgegap.com/zh/learn/bian-pai/deployments.md) 了解更多。

## 🎵 与上游的更改

上游素材许可证保留了游戏名称、音乐和工作室徽标，仅适用于未修改的构建。这个分支已重命名为 Edgegap Arena Shooter，并移除了音乐和徽标。音效仍由代码生成并会播放。
