> 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/ru/docs/sample-projects/unity-netcodes/mirror-on-edgegap-websocket.md).

# Mirror WebGL

Используйте WebSocket-транспорт Mirror, чтобы запускать многопользовательскую игру Unity WebGL на игровых серверах Edgegap.

Это руководство поможет вам использовать [Mirror](https://mirror-networking.com/)'s WebSocket Transport и создать headless-сервер на Edgegap для проекта Unity.

В этом руководстве будет использоваться пример проекта с открытым исходным кодом `Tanks`, доступный в примере Mirror в `Assets/Mirror/Examples/Tanks`.

Вы можете найти [финальную версию этого примера](https://github.com/edgegap/netcode-game-sample-webgl-mirror-tanks) на GitHub.

### Пример Billiards

Если вы предпочитаете следовать пошаговому видеоуроку по примеру Billiard, смотрите здесь:

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

{% hint style="success" %}
В этом видео представлен обновлённый процесс сборки с использованием последних [Unity](https://docs.edgegap.com/ru/unity.md) инструментов сборки.
{% endhint %}

### Переключите транспорт

Сначала нам нужно внести несколько изменений в базовую сцену, прежде чем мы будем готовы собирать игровой сервер.

* Откройте `MirrorTanks.unity` находящуюся в `Assets/Mirror/Examples/Tanks/Scenes`;
* Во вкладке `NetworkManager` gameObject, удалите `KcpTransport` скрипт и замените его на `SimpleWebTransport` находящуюся в `Assets/Mirror/Transports/SimpleWeb`, обязательно также обновите поле Transport компонента `NetworkManager` скрипта, указав этот новый транспорт. Убедитесь, что `Auto Start Server Build` также выбран.
* В зависимости от вашей версии Mirror, вам может потребоваться изменить/обновить `NetworkManagerHUD` чтобы он работал с транспортами, отличными от KCP, а также чтобы вы могли ввести значение порта в HUD перед подключением к серверу.

Обратите внимание на порт, используемый для сетевого обмена, обозначаемый как `[GAME PORT]`. В данном случае используемый порт — `7778`.

### Сборка игрового сервера и контейнеризация

{% hint style="info" %}
Чтобы упростить процесс контейнеризации и развёртывания, можно использовать последнюю версию [плагина Edgegap Unity](https://github.com/edgegap/buildtool-unity-plugin) для автоматизации процесса. Подробнее о том, как использовать этот плагин, см. [Unity - Getting Started](https://docs.edgegap.com/ru/unity.md).

Если хотите, вы также можете следовать этим пошаговым инструкциям.
{% endhint %}

Как только ваша игра будет готова, перейдите на `Соберите` в редакторе Unity, в разделе `File -> Build Settings` в верхнем меню. Убедитесь, что выбрали правильные пресеты в зависимости от версии Unity.

* До версии 2021.2:
  * Установите `Target Platform` на `Linux`;
  * Установите `Architecture` на `x86_64`;
  * Отметьте `Server Build` опцию.
* В противном случае:
  * Установите `Platform` на `Dedicated Server`;
  * Установите `Target Platform` на `Linux`.

Затем нажмите build и выберите новую пустую папку с именем `linux_server` в качестве места назначения файла. Перенесите `linux_server` папку во вторую пустую папку, которая будет называться `[SERVER BUILD]` папку в этом документе. Добавьте следующий `Dockerfile` и `boot.sh` файл в `[SERVER BUILD]` папку:

#### Dockerfile

{% code collapsedlinecount="10" %}

```
FROM ubuntu:bionic
MAINTAINER <author_detail>

ARG DEBIAN_FRONTEND=noninteractive
ARG docker_version=17.06.0-ce

RUN
    apt-get update && \\
    apt-get install -y libglu1 xvfb libxcursor1 ca-certificates && \\
    update-ca-certificates && \\
    apt-get clean

EXPOSE 7778/TCP

COPY linux_server/  /root/linux_server/
COPY boot.sh        /boot.sh

WORKDIR /root/
ENTRYPOINT ["/bin/bash", "/boot.sh"]
```

{% endcode %}

#### boot.sh

{% code collapsedlinecount="10" %}

```
xvfb-run --auto-servernum --server-args='-screen 0 640x480x24:32' /root/linux_server/[YOUR GAME].x86_64 -batchmode -nographics
```

{% endcode %}

Обязательно замените `[YOUR GAME]` заполнители на имя сгенерированного файла

Затем откройте командную строку в `[SERVER BUILD]` папке; выполните следующие Docker-команды, чтобы создать образ вашей сборки и отправить его в частный реестр:

{% hint style="warning" %}
Для пользователей с ARM CPU (Mac M1, M2 и т. д.) добавьте `--platform linux/amd64` опцию в команду сборки.
{% endhint %}

#### Использование Linux

{% code collapsedlinecount="10" %}

```bash
# build the image
docker build . -t <IMAGE_NAME>:<IMAGE_TAG>

# login, prompt попросит пароль
docker login -u '<REGISTRY_USERNAME>' <REGISTRY_URL>

# добавить ещё один тег к вашему образу, соответствующий реестру
docker image tag <IMAGE_NAME>:<IMAGE_TAG> <REGISTRY_URL>/<PROJECT_NAME>/<IMAGE_NAME>:<IMAGE_TAG>

#push the image
docker push <REGISTRY_URL>/<PROJECT_NAME>/<IMAGE_NAME>:<IMAGE_TAG>
```

{% endcode %}

#### Использование cmd

{% code collapsedlinecount="10" %}

```bash
# build the image
docker build . -t <IMAGE_NAME>:<IMAGE_TAG>

# login, prompt попросит пароль
docker login -u <REGISTRY_USERNAME> <REGISTRY_URL>

# добавить ещё один тег к вашему образу, соответствующий реестру
docker image tag <IMAGE_NAME>:<IMAGE_TAG> <REGISTRY_URL>/<PROJECT_NAME>/<IMAGE_NAME>:<IMAGE_TAG>

#push the image
docker push <REGISTRY_URL>/<PROJECT_NAME>/<IMAGE_NAME>:<IMAGE_TAG>
```

{% endcode %}

#### Использование Powershell

{% code collapsedlinecount="10" %}

```bash
# build the image
docker build . -t <IMAGE_NAME>:<IMAGE_TAG>

# login, prompt попросит пароль
docker login -u '<REGISTRY_USERNAME>' <REGISTRY_URL>

# добавить ещё один тег к вашему образу, соответствующий реестру
docker image tag <IMAGE_NAME>:<IMAGE_TAG> <REGISTRY_URL>/<PROJECT_NAME>/<IMAGE_NAME>:<IMAGE_TAG>

#push the image
docker push <REGISTRY_URL>/<PROJECT_NAME>/<IMAGE_NAME>:<IMAGE_TAG>
```

{% endcode %}

### Развёртывание сервера на Edgegap

После входа в Dashboard Edgegap перейдите на `Applications & Games` страницу. Нажмите на `Create New` в правом верхнем углу, чтобы открыть форму создания приложения. Ниже приведены поля и способы их правильного заполнения:

* Application name : Может быть любым заметным названием, которое вы хотите использовать, чтобы легко отличать ваше приложение от других.
* Image : Может быть любым конкретным образом, который вы хотите использовать, чтобы легко отличать ваше приложение от других.
* Version name : Вы можете использовать имя версии, чтобы описать область версии, которую вы развёртываете. Примеры: “demo”, “production”, “v1”, “v2”
* Container :
  * Registry : “\[URL]”, где \[URL] — это значение из учётных данных, которые можно отобразить на странице Container Repository.
  * Image repository : “\[PROJECT]/\[YOUR GAME]”, где \[PROJECT] и \[YOUR GAME] — это значения, которые вы использовали ранее при загрузке docker-образа.
  * Tag : “\[TAG]”, где \[TAG] — это значение, которое вы использовали ранее при загрузке docker-образа.
  * Поставьте галочку “Using a private repository”
  * Private registry username : “\[USERNAME]”, где \[USERNAME] — это значение из ваших учётных данных.
  * Private registry token : “\[TOKEN]”, где \[TOKEN] — это значение из ваших учётных данных.
  * Requirements : Оставьте как есть.
  * Ports : Нажмите `+ Add port` ссылку, чтобы добавить новый порт, и добавьте следующие записи:
    * `7778` - WS - enable TLS Upgrade (Beta)

{% hint style="warning" %}
Если вы используете опцию WSS, важно включить `включённым TLS Upgrade` опцию. В противном случае вы столкнётесь с ошибками, подобными этой, в журналах контейнера на панели Edgegap.

{% code collapsedlinecount="10" %}

```cmd
Первые байты от клиента не были 'GET' для рукопожатия, вместо этого были 16-03-01
```

{% endcode %}
{% endhint %}

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

После того как ваше приложение создано, вы можете нажать кнопку `Deploy` кнопку, чтобы приступить к развёртыванию игрового сервера. Когда последний статус вашего развёртывания будет установлен на `Готов`, вы сможете подключиться к серверу с клиентской версией игры. Обратите внимание на `Хост` url и, на вкладке Port Mapping вашего развёртывания, на `внешний порт` , который доступен публично.

### Тестирование клиента

#### В редакторе

Вернувшись в редактор Unity в сцене танков, выберите `NetworkManager` gameObject и измените следующие настройки:

* Во вкладке `Network Manager` компонента:
  * Установите `Network Address` к url развёртывания сервера; `Хост` url;
  * Снимите флажок `Auto Start Server Build` опцию.
* Во вкладке `Simple Web Transport` компонента:
  * Установите `Порт` значение для url развёртывания Edgegap `внешний порт` например: `32821`;
  * Убедитесь, что `Client Use WSS` включена.

<figure><img src="https://3845012722-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsR0dHSFv9ymoC0DO5G8J%2Fuploads%2Fgit-blob-8fe3a5d63fc65f33f18d8e0c39a5d2d5a5b97e6c%2Fnetwork-manager-client-settings-1.png?alt=media" alt=""><figcaption></figcaption></figure>

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

После этого нажмите `Play` в редакторе, затем нажмите `Client` кнопку; через некоторое время вы подключитесь к серверу и сможете играть.

#### На Itch.io

Чтобы разместить клиент вашей игры на Itch, вам нужно будет собрать клиентскую версию; Для этого вам нужно установить `модуль WebGL Build Support` для вашей версии Unity. Как только это будет сделано, вернитесь к `Соберите` в редакторе Unity, в разделе `File -> Build Settings`, и выберите следующие параметры:

* Установите `Platform` на `WebGL`;
* Откройте `настройки Player`. В `Player -> Publishing Settings`, установите `формат сжатия` на `Gzip` и убедитесь, что `опция Decompression Fallback` выбрана. Сохраните эти настройки и закройте окно.

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

Затем нажмите build и выберите новую пустую папку с именем `build` в качестве места назначения файла. Перенесите `build` папку во вторую пустую папку, которая будет называться `[СБОРКА КЛИЕНТА]` папка в этом документе.

После завершения сборки игры сожмите файлы этой `build` папки в zip-архив, убедившись, что они находятся в его корне. Затем вам просто нужно загрузить zip-архив в ваш проект Itch и убедиться, что выбрана опция запуска файла в браузере. После запуска игры вам нужно лишь убедиться, что значения сетевого адреса и порта правильно заданы в HUD, затем нажать `Client` кнопку, чтобы играть.

#### Хостинг клиента на Edgegap

Вы даже можете разместить клиент вашей игры на Edgegap! Для этого добавьте следующий `Dockerfile` и `nginx.conf` файл в `[СБОРКА КЛИЕНТА]` папку:

**Dockerfile**

{% code collapsedlinecount="10" %}

```
FROM nginx:alpine
MAINTAINER <author_detail>

COPY build/ /usr/share/nginx/html
copy nginx.conf /etc/nginx/
```

{% endcode %}

**nginx.conf**

{% code collapsedlinecount="10" %}

```
user  nginx;
worker_processes  auto;

error_log  /var/log/nginx/error.log notice;
pid        /var/run/nginx.pid;


events {
worker_connections  1024;
}


http {
include       /etc/nginx/mime.types;
default_type  application/octet-stream;

log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
'$status $body_bytes_sent "$http_referer" '
'"$http_user_agent" "$http_x_forwarded_for"';

access_log  /var/log/nginx/access.log  main;

sendfile        on;
#tcp_nopush     on;

keepalive_timeout  65;

#gzip  on;

include /etc/nginx/conf.d/*.conf;

server {
# Добавьте следующую конфигурацию в конфигурацию HTTP-сервера
# ...

    # Предварительно сжатые на диске файлы данных Brotli следует обслуживать с включённым сжатием:
    location ~ .+\.(data|symbols\.json)\.br$ {
        # Поскольку этот файл уже предварительно сжат на диске, отключите для него сжатие по требованию.
        # Иначе nginx попытается выполнить двойное сжатие.
        gzip off;
        add_header Content-Encoding br;
        default_type application/octet-stream;
    }

    # Предварительно сжатые на диске файлы JavaScript-кода Brotli:
    location ~ .+\.js\.br$ {
        gzip off; # Не пытайтесь применять динамическое gzip-сжатие к уже сжатому файлу
        add_header Content-Encoding br;
        default_type application/javascript;
    }

    # Предварительно сжатые на диске файлы WebAssembly Brotli:
    location ~ .+\.wasm\.br$ {
        gzip off; # Не пытайтесь применять динамическое gzip-сжатие к уже сжатому файлу
        add_header Content-Encoding br;
        # Включите потоковую компиляцию WebAssembly, указав правильный MIME-тип для
        # файлов Wasm.
        default_type application/wasm;
    }

    # Предварительно сжатые на диске файлы данных gzip следует обслуживать с включённым сжатием:
    location ~ .+\.(data|symbols\.json)\.gz$ {
        gzip off; # Не пытайтесь применять динамическое gzip-сжатие к уже сжатому файлу
        add_header Content-Encoding gzip;
        default_type application/octet-stream;
    }

    # Предварительно сжатые на диске файлы JavaScript-кода gzip:
    location ~ .+\.js\.gz$ {
        gzip off; # Не пытайтесь применять динамическое gzip-сжатие к уже сжатому файлу
        add_header Content-Encoding gzip;
        default_type application/javascript;
    }

    # Предварительно сжатые на диске файлы WebAssembly gzip:
    location ~ .+\.wasm\.gz$ {
        gzip off; # Не пытайтесь применять динамическое gzip-сжатие к уже сжатому файлу
        add_header Content-Encoding gzip;
        # Включите потоковую компиляцию WebAssembly, указав правильный MIME-тип для
        # файлов Wasm.
        default_type application/wasm;
    }
}
}
```

{% endcode %}

Продолжите с [теми же Docker-командами, что и раньше](#bootsh) для сборки и отправки образа вашего клиентского приложения в частный репозиторий, но из окна командной строки, открытого в `[СБОРКА КЛИЕНТА]` папке. Убедитесь, что используете другое имя образа, чем для вашего сервера.

Затем создайте новое приложение для вашего клиента на панели Edgegap со следующими настройками:

* Application name : Может быть любым заметным названием, которое вы хотите использовать, чтобы легко отличать ваше приложение от других.
* Image : Может быть любым конкретным образом, который вы хотите использовать, чтобы легко отличать ваше приложение от других.
* Version name : Вы можете использовать имя версии, чтобы описать область версии, которую вы развёртываете. Примеры: “demo”, “production”, “v1”, “v2”
* Container :
  * Registry : “\[URL]”, где \[URL] — это значение из учётных данных, которые можно отобразить на странице Container Repository.
  * Image repository : “\[PROJECT]/\[YOUR GAME]”, где \[PROJECT] и \[YOUR GAME] — это значения, которые вы использовали ранее при загрузке docker-образа.
  * Tag : “\[TAG]”, где \[TAG] — это значение, которое вы использовали ранее при загрузке docker-образа.
  * Поставьте галочку “Using a private repository”
  * Private registry username : “\[USERNAME]”, где \[USERNAME] — это значение из ваших учётных данных.
  * Private registry token : “\[TOKEN]”, где \[TOKEN] — это значение из ваших учётных данных.
  * Requirements : Оставьте как есть.
  * Ports : Нажмите `+ Add port` ссылку, чтобы добавить новый порт, и добавьте следующие записи:
    * `80` - HTTPS

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

После того как ваше приложение создано, вы можете нажать кнопку `Deploy` кнопку, чтобы приступить к развёртыванию вашего клиентского приложения. Когда оба развёртывания, сервера и клиента, будут установлены на `Готов`, откройте `Хост` url клиентского приложения в указанном `внешний порт` в браузере, и вы сможете играть после того, как зададите правильные значения в HUD игры!

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

### Edgegap Matchmaker (опционально)

Пример также может подбирать игроков с помощью [Edgegap Matchmaker](https://docs.edgegap.com/ru/learn/matchmeiking.md). По умолчанию он отключён, и вышеприведённые шаги работают без него. Из коробки пакет Edgegap SDK не установлен, скрипты подбора матчей компилируются в пустые заглушки, а `EdgegapMatchmaking` объект в `MirrorTanks` сцене неактивен.

После включения игроки нажимают `Найти матч` вместо ввода адреса сервера. Матчмейкер объединяет их, Edgegap запускает развёртывание рядом с ними, и каждый клиент автоматически подключается к нему.

Скрипты подбора матчей находятся в `Assets/EdgegapMatchmaking`:

* `TanksMatchmakingClient` - создаёт тикет и опрашивает его, пока не будет назначен сервер, затем подключает Mirror к `wss://{fqdn}:{external port}`, повторяя попытки, пока сервер загружается, и отображает небольшой `Найти матч` / `Отмена` панель,
* `TanksMatchmakingServer` - работает только на выделенном сервере и останавливает собственное развёртывание, если никто не присоединится в течение 2 минут или через 30 секунд после ухода последнего игрока,
* `Edgegap.Tanks.Matchmaking.asmdef` - использует `versionDefines` для определения `EDGEGAP_SDK` только когда `com.edgegap.unity-sdk` `3.5.5` или новее установлена (`3.5.5` — первая версия SDK, которая компилируется для WebGL),
* `matchmaker-config.json` - пример конфигурации матчмейкера в корне репозитория.

Чтобы включить его:

1. Установите [Edgegap Unity SDK](https://docs.edgegap.com/ru/unity/matchmaking.md). В Package Manager выберите `Add package from git URL` и введите `https://github.com/edgegap/sdk-unity-sessions-matchmaker-server-browser.git`.
2. Откройте `MirrorTanks` сцену, выберите `EdgegapMatchmaking` gameObject и установите флажок рядом с его именем.
3. Соберите и загрузите сервер, как указано выше, с `7778` портом, протоколом `WS` и `включённым TLS Upgrade` включёнными. Соберите его после шага 2, чтобы сервер включал `TanksMatchmakingServer` и останавливал своё развёртывание, когда матч завершится.
4. Создайте матчмейкер в [панели управления](https://app.edgegap.com/matchmaker-management-v2/matchmakers/list) из `matchmaker-config.json`. Установите `application.name` и `application.version` в вашу версию приложения и задайте `allowed_cors_origins` origin, обслуживающим вашу WebGL-сборку. Браузер обращается к матчмейкеру напрямую, поэтому [запросы с любого другого origin блокируются](https://docs.edgegap.com/ru/learn/matchmeiking/matchmaker-in-depth.md#cross-origin-resource-sharing-cors).
5. Вставьте `API URL` в `Base URL` на `TanksMatchmakingClient`, и его `Auth Token` в `Auth Token`.
6. Соберите WebGL, разместите его на разрешённом origin, откройте его в двух окнах браузера и нажмите `Найти матч` в каждом.

{% hint style="info" %}
Auth Token принадлежит вашему матчмейкеру и включается в вашу клиентскую сборку, но не даёт доступа к вашей учётной записи Edgegap. **Никогда не помещайте свой токен API Edgegap в клиент.**
{% endhint %}

В примере профиля вместе подбираются от 2 до 4 игроков. Через 30 секунд в очереди одному игроку выделяется сервер отдельно.

{% hint style="info" %}
Браузеры не могут пинговать [маяки задержки](https://docs.edgegap.com/ru/learn/orkestraciya/ping-beacons.md), поэтому в примере профиля нет `latencies` правила, и матчмейкер размещает сервер на основе публичных IP-адресов игроков.
{% endhint %}

Чтобы снова отключить матчмейкер, деактивируйте `EdgegapMatchmaking`. Чтобы удалить его полностью, также удалите пакет SDK.

{% hint style="info" %}
Если вам нужна дополнительная информация об интеграции Mirror и websocket, обратитесь к [документации Mirror по WebSockets Transport](https://mirror-networking.gitbook.io/docs/manual/transports/websockets-transport).
{% endhint %}
