> 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/fishnet-on-edgegap-webgl.md).

# Fishnet WebGL

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

Это руководство поможет вам использовать [FishNet](https://github.com/FirstGearGames/FishNet)Websocket Transport, [Bayou](https://fish-networking.gitbook.io/docs/manual/components/transports/bayou), и создать сервер без графического интерфейса на Edgegap для проекта Unity.

Вы можете найти [итоговый пример проекта](https://github.com/edgegap/netcode-game-sample-unity-fishnet-hashgrid) на GitHub, в `Fishnet_v4.1.6R_WebGL_Matchmaker` папке. Это руководство должно работать с любой версией Fishnet, если вы используете подходящую версию Bayou для неё.

Правило `Запустить игру` кнопка в примере имеет два режима, выбираемые на `MatchmakingSystem` gameObject в `MainMenu` сцене:

* **Прямое подключение (по умолчанию)** - клиент подключается к адресу и порту сервера, которые вы задаёте. Сначала протестируйте с локальным сервером, затем — с развертыванием, которое вы запускаете из панели управления Edgegap. Матчмейкер не нужен.
* **Edgegap Matchmaker (необязательно, по умолчанию отключён)** -  [Edgegap Matchmaker](https://docs.edgegap.com/ru/learn/matchmeiking.md) группирует игроков, Edgegap запускает выделенный сервер рядом с ними, и каждый клиент подключается к нему автоматически.

{% hint style="info" %}
В обоих режимах, **игровой клиент никогда не хранит токен API Edgegap**. Режим матчмейкера использует только `Auth Token`, который безопасно включать в игровые клиенты. Сервер останавливает своё развертывание, когда матч пуст.
{% endhint %}

### Требования к Unity

Этот проект протестирован на версии Unity `2021.3.45f2`, с FishNet `4.1.6R`, транспортом Bayou и SDK Edgegap для Unity. Вам потребуется установить вместе с ним следующие модули:

* Поддержка сборки WebGL;
* Поддержка сборки выделенного сервера Linux;
* Поддержка сборки Linux (Mono).

Вам также понадобится [Docker](https://docs.docker.com/get-docker/) чтобы контейнеризовать сервер.

{% hint style="warning" %}
Для примера требуется Edgegap Unity SDK `3.5.6` или новее. До Unity 2022.3 SDK `3.5.5` Файл примера `Packages/manifest.json` отслеживает `main` ветку. Если вместо этого вы закрепляете тег, используйте `#3.5.6` или новее.
{% endhint %}

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

В примере уже используется Bayou на порту `7770`. Чтобы сделать то же самое в своём проекте, скачайте [пакет Bayou для Unity](https://github.com/FirstGearGames/Bayou/releases) из его релизов на GitHub. Импортируйте пакет в игровой проект через панель инструментов в разделе `Asset/Import Package/Custom Package...`.

Откройте `MainMenu` сцену, расположенную в `Assets/SpaceEdge/Scenes`. В `NetworkManager` gameObject удалите `Tugboat` компонент транспорта. Замените его на `Bayou` транспорт, расположенный в `Assets/FishNet/Plugins/Bayou`. Обратите внимание на заданное значение порта, в данном случае `7770`.

Вам не нужен `Start On Headless` опция, и в примере она выключена. В серверных сборках `EdgegapServerLifecycle` компонент (в `Assets/Edgegap`) запускает сервер FishNet на `0.0.0.0:7770`, так что одна и та же сцена подходит для клиентских и серверных сборок. На Edgegap она также останавливает развертывание, если никто не подключается в течение 120 секунд, или через 30 секунд после того, как последний игрок покинет игру.

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

Соберите сервер с помощью `Tools/Edgegap/Build Linux Dedicated Server` пункта меню панели инструментов. Вывод помещается в `Builds/EdgegapServer/`, который в примере `Dockerfile` копируется в образ.

Чтобы протестировать локально, запустите его в Docker:

{% code collapsedlinecount="10" %}

```bash
docker build --platform linux/amd64 -t fishnet-server:local .
docker run -p 7770:7770 fishnet-server:local
```

{% endcode %}

В журнале отображается `Edgegap Server | Запуск сервера на 0.0.0.0:7770.` и `Не работает на Edgegap, самовыключение отключено.`

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

#### В редакторе или локально

Соберите клиентскую сборку WebGL (см. [На Itch.io](#on-itch.io) параметры сборки), или соберите её из командной строки:

{% code collapsedlinecount="10" %}

```bash
Unity -batchmode -quit -projectPath . -executeMethod EdgegapServerBuild.BuildClient -edgegapClientTarget webgl
```

{% endcode %}

Раздайте `Builds/Client/webgl` (например, с помощью `python -m http.server 8080`), откройте `http://localhost:8080` в двух вкладках, затем нажмите на `Запустить игру`. `MatchmakingSystem` значения по умолчанию (`Прямой адрес` установлена на `localhost`, `Прямой порт` установлена на `7770`, `Использовать WSS напрямую` выкл.) подключаются к локальному серверу. Настольные сборки (`-edgegapClientTarget win64`) тоже работают, поскольку Bayou поддерживает нативные клиенты.

#### На сервере Edgegap

Отправьте образ в ваш [Container Registry](https://docs.edgegap.com/ru/learn/advanced-features/edgegap-container-registry.md#getting-your-credentials). Ваш проект реестра, имя пользователя и токен находятся в `Container Registry` страницы.

{% tabs %}
{% tab title="Bash (Linux)" %}

```bash
project='<REGISTRY_PROJECT>';
username='robot$<REGISTRY_ORGANIZATION_ID>+client-push';
token='<REGISTRY_TOKEN>';

echo "$token" | docker login registry.edgegap.com -u "$username" --password-stdin 2>&1
```

{% endtab %}

{% tab title="PowerShell (Windows)" %}

```powershell
$project = '<REGISTRY_PROJECT>'
$username = 'robot$<REGISTRY_ORGANIZATION_ID>+client-push'
$token = '<REGISTRY_TOKEN>'

echo "$token" | docker login registry.edgegap.com -u "$username" --password-stdin 2>&1
```

{% endtab %}
{% endtabs %}

Затем соберите и отправьте образ:

{% code collapsedlinecount="10" %}

```bash
docker build --platform linux/amd64 -t registry.edgegap.com/<project>/fishnet-server:v1 .
docker push registry.edgegap.com/<project>/fishnet-server:v1
```

{% endcode %}

{% hint style="danger" %}
:x: **НЕ ДЕЛАЙТЕ — не перезаписывайте существующие теги и не используйте `latest`  тег** — это приведёт к развёртыванию устаревшего кэша.\
:white\_check\_mark: **ДЕЛАЙТЕ — всегда увеличивайте номер версии в теге** и развёртывайте новую сборку.
{% endhint %}

Во вкладке [панели управления Edgegap](https://app.edgegap.com/application-management/applications/list), создайте приложение и версию для этого образа:

* [Порт](https://docs.edgegap.com/ru/learn/orkestraciya/application-and-versions.md#port-mapping): имя `gameport`, порт `7770`, протокол `WS`, с `включённым TLS Upgrade` включено. Edgegap завершает TLS, поэтому браузеры подключаются по `wss://` в то время как сервер использует обычный `ws` (см. [Websockets (WS) и Secure Websockets (WSS)](https://docs.edgegap.com/ru/learn/orkestraciya/deployments.md#websockets-ws-and-secure-websockets-wss)).
* Имя пользователя и токен реестра контейнеров: задайте их, иначе развёртывания не смогут загрузить образ.

Разверните версию из панели управления. На `MatchmakingSystem` gameObject задайте `Прямой адрес` хост развертывания (`<id>.pr.edgegap.net`), `Прямой порт` на его внешний порт и включите `Использовать WSS напрямую`. Пересоберите клиент и нажмите на `Запустить игру`.

#### С Edgegap Matchmaker (необязательно)

Включите матчмейкер, как только прямая связь заработает:

1. В примере `matchmaker-config.json`, задайте `application.name` и `version` ваше приложение и версию, а также перечислите каждый origin, с которого обслуживается сборка WebGL, в [`allowed_cors_origins`](https://docs.edgegap.com/ru/learn/matchmeiking/matchmaker-in-depth.md#cross-origin-resource-sharing-cors).
2. В панели управления откройте [Matchmaker](https://app.edgegap.com/matchmaker-management-v2/matchmakers/list), нажмите `Создать матчмейкер`, загрузите файл, затем нажмите `Создать и запустить`.
3. Во вкладке `MainMenu` сцене, скопируйте `API URL` и `Auth Token` в `базовый URL` и `Auth Token` поля `Edgegap Matchmaking Client` компонента на `Edgegap` gameObject. Затем включите `Use Edgegap Matchmaker` включённом на `MatchmakingSystem` gameObject.
4. Пересоберите клиент, раздайте его с origin, указанного в `allowed_cors_origins` (например, `http://localhost:8080`), откройте две вкладки и нажмите на `Запустить игру` в обоих.

Клиент создаёт тикет, ждёт назначения сервера, а затем подключается с помощью `wss://`. `casual` профиль подходит для 2–4 игроков. Он также снижает минимум до 1 игрока через 30 секунд, но одинокий игрок может получить сервер только тогда, когда срок действия тикета близится к истечению через 5 минут, так что тестируйте с двумя клиентами.

Чтобы выпустить новую серверную сборку: соберите сервер, отправьте новый тег, создайте новую версию приложения, затем в матчмейкере нажмите `Остановить`, отредактируйте `application.version` и нажмите `Старт` (см. [Rolling Updates](https://docs.edgegap.com/ru/learn/matchmeiking/matchmaker-in-depth.md#rolling-updates-and-ab-tests)).

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

#### На Itch.io

После того как вы подтвердите, что игровой клиент работает локально, он также должен работать в Itch.io. Чтобы загрузить туда свою игру, вам нужно будет сделать клиентскую сборку в `Соберите` в редакторе Unity, в разделе `File -> Build Settings`. Выберите следующие параметры:

* Установите `Platform` на `WebGL`;
* Откройте `Player Settings`. В `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-d31291cf36a863193c24a856718a791db0c61577%2Fbuild-settings.png?alt=media" alt=""><figcaption></figcaption></figure>

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