> 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/photon-bolt-on-arbitrium.md).

# Photon Bolt

为一个使用 Photon Bolt 作为联网方案的项目，在 Edgegap 上创建一个无头 Unity 游戏服务器。

本指南将帮助你为 Unity 项目在 Edgegap 上创建一台无头服务器，使用 Photon Bolt 作为其联网解决方案。

在本指南中，我们将使用一个自定义演示项目作为示例。

### 准备 Unity 项目

### 克隆 Unity 项目

第一步是从 git 克隆 Edgegap 演示游戏项目。你可以在命令提示符中使用以下命令：

该命令会创建一个包含 Unity 源项目的文件夹，名为 `demo-game`.

过程完成后，你可以打开 Unity Hub，并点击 `添加` 按钮，在“项目”选项卡中，然后在你的电脑上找到项目文件夹：

要打开该项目，你需要安装正确版本的 Unity。在我们的例子中，我们将使用 Unity `2020.3.3`。你可以访问 Unity 的下载归档找到它：<https://unity3d.com/get-unity/download/archive。>

安装完成后，你现在可以通过 Unity Hub 中项目名称旁边的下拉菜单选择新的 Unity 版本：

现在你可以打开 Unity 项目，继续下一步。

### 设置游戏

### 设置 Photon Bolt

#### 添加 Photon App ID 并编译 Bolt

为了让游戏与 Photon 的服务通信，你需要在 Photon 仪表板中添加一个应用。如果你还没有 [Photon 账户](https://id.photonengine.com/Account/) ，你可以很容易地创建一个。

登录后，你可以创建一个应用并为其命名。每个应用都有其唯一的 `App ID`。你需要将这个 ID 复制并粘贴到 Unity 项目中的 `Bolt 设置` 窗口里：

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

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

输入 ID 后，你可以关闭 Bolt 设置窗口。在同一个 `Bolt` 菜单中，与之前一样，你需要执行两个操作： `更新预制体数据库` 以及 `编译程序集`，分别执行。

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

此时，你应该可以启动游戏的 `StartScene` 场景，而不会在调试控制台中出现任何错误或警告。不过，你还不能直接在服务器上开始游玩。

至此，为使你的 Photon Bolt 正常工作所需的通用更改就完成了。这些更改对你的游戏客户端和服务器都适用。

### 准备无头服务器

为了让你的应用高效地与容器配合工作，你需要对游戏做一些改动，以创建一个“无头服务器”构建。对于大多数项目来说，这只需要几个简单的步骤。

#### Unity 项目的要求

首先，需要注意的是，Photon Bolt 的无头服务器模式要求加载一个包含名为 `HeadlessServerManager`.

的脚本的场景。相关的通用、未修改脚本（取自 Bolt 文档）如下：

{% code collapsedlinecount="10" %}

```cs
using System;
using Bolt.Matchmaking;
using Bolt.Photon;
using UnityEngine;
using UnityEngine.SceneManagement;

namespace Bolt.Samples.HeadlessServer
{
    public class HeadlessServerManager : Bolt.GlobalEventListener
    {
        public string Map = "";
        public string GameType = "";
        public string RoomID = "";

        public override void BoltStartBegin(" alt=""><figcaption></figcaption></figure>
        {
            // 注册你正在使用的任何协议令牌
            BoltNetwork.RegisterTokenClass<PhotonRoomProperties>();
        }

        public override void BoltStartDone()
        {
            if (BoltNetwork.IsServer)
            {
                // 创建一些房间自定义属性
                PhotonRoomProperties roomProperties = new PhotonRoomProperties();

                roomProperties.AddRoomProperty("t", GameType); // 例如：游戏类型
                roomProperties.AddRoomProperty("m", Map); // 例如：地图 ID

                roomProperties.IsOpen = true;
                roomProperties.IsVisible = true;

                // 如果未设置 RoomID，则创建一个随机值
                if (RoomID.Length == 0)
                {
                    RoomID = Guid.NewGuid().ToString();
                }

                // 创建 Photon 房间
                BoltMatchmaking.CreateSession(
                    sessionID: RoomID,
                    token: roomProperties,
                    sceneToLoad: Map
                );
            }
        }

        // 用于初始化
        void Start()
        {
            // 从命令行获取自定义参数
            Map = GetArg("-m", "-map") ?? Map;
            GameType = GetArg("-t", "-gameType") ?? GameType; // 例如：从命令行获取游戏类型
            RoomID = GetArg("-r", "-room") ?? RoomID;

            // 验证请求的关卡
            var validMap = false;

            foreach (string value in BoltScenes.AllScenes)
            {
                if (SceneManager.GetActiveScene().name != value)
                {
                    if (Map == value)
                    {
                        validMap = true;
                        break;
                    }
                }
            }

            if (!validMap)
            {
                BoltLog.Error("无效配置：请检查关卡名称");
                Application.Quit();
            }

            // 启动服务器
            BoltLauncher.StartServer();
            DontDestroyOnLoad(this);
        }

        /// <summary>
        /// 用于检测游戏实例是否以无头模式启动的实用函数。
        /// </summary>
        /// <returns><c>true</c>，如果使用了无头模式；否则为 <c>false</c>。</returns>
        public static bool IsHeadlessMode()
        {
            return Environment.CommandLine.Contains("-batchmode") && Environment.CommandLine.Contains("-nographics");
        }

        static string GetArg(params string[] names)
        {
            var args = Environment.GetCommandLineArgs();
            for (int i = 0; i < args.Length; i++)
            {
                foreach (var name in names)
                {
                    if (args[i] == name && args.Length > i + 1)
                    {
                        return args[i + 1];
                    }
                }
            }

            return null;
        }
    }
}
```

{% endcode %}

通常，它由一个空场景中的空 GameObject 承载（该场景仅用于无头服务器构建）。

为了适配项目结构，这个演示中的脚本做了一些轻微修改，目前它放在位于以下位置的场景中的一个空 GameObject 上： `Assets/Scenes/BoltHeadlessServer`.

#### 为你的游戏添加无头服务器检查

上面的脚本包含一个名为 `IsHeadlessMode`的静态实用方法，用于检查正在运行的游戏是否为无头模式。如果你正在更新现有项目，你可能需要添加此检查，以便为无头服务器移除或添加功能，例如阻止实例化玩家角色。

#### 构建设置

在项目的 `构建设置` 中，将 `BoltHeadlessServer` 场景放在最顶部，使其成为服务器首先加载的场景。

接下来，选择 `Linux` 作为目标平台，并勾选 `服务器构建`.

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

现在你可以使用以上设置在 Linux 下构建游戏。

对于 **客户端构建**，别忘了取消勾选 `BoltHeadlessServer` 场景和 `IsServer` 选项，这样你的游戏才能正常运行。

关于为 Photon Bolt 制作无头服务器的每个步骤，更多详情可参阅 [Photon Bolt 无头服务器文档](https://doc.photonengine.com/en-us/bolt/current/demos-and-tutorials/headless-server).

### 为服务器创建容器

如果你不熟悉 Docker 或容器，可以通过查看 [什么是 Docker？](https://docs.edgegap.com/zh/docs/tools-and-integrations/docker.md)

来了解更多。要从 Unity 项目创建容器，请参考 [Docker 上的 Unity](broken://pages/0c42ece8adc18305e213a10ec872fe29dae5e3e9).

### 将你的应用添加到 Edgegap

现在你可以将容器添加到 Edgegap，这样它就能托管在玩家所在的任何地方。

如果你不知道如何将应用添加到 Edgegap，请参阅 [应用和版本](https://docs.edgegap.com/zh/learn/bian-pai/application-and-versions.md).

不过，你需要确保你的应用名称是 `demo-game` ，并且它有一个名为 `v1`的版本。否则，你需要更新位于 `Assets/Scripts/StaginController.cs`.

另外，在 `Assets/Scripts/StaginController.cs` 脚本中，你会找到一个名为 `API_TOKEN`的常量变量。你需要从你的 Edgegap 账户创建一个令牌，并将其作为字符串粘贴到这个变量中。该令牌将用于授权发送给 Edgegap 的 API 请求。

以下是相关脚本，其中 Edgegap 的令牌用蓝色标示，应用参数用红色标示：

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

## 游玩演示游戏

最后，你可以启动一个演示游戏客户端构建来进行游玩。你可以构建游戏的客户端版本并启动，或者直接从 Unity 界面运行。只需确保在 `StartScene` 场景中启动它。

启动后，界面会显示出来。它包含顶部的一个文本框、两个大按钮，以及屏幕左下角一个显示 Bolt 当前状态的标签。

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

你可以将 Edgegap 中的 API Token 复制到顶部的文本框中。粘贴令牌后，你现在可以按下 `请求服务器` 按钮，向 Edgegap 发送 API 调用以启动服务器。

几秒钟后，你应该会看到界面底部的标签显示可用服务器数量。现在你可以按下 `连接到随机服务器` 按钮加入游戏并开始游玩。
