> 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/tools-and-integrations/eos-voice-chat.md).

# Голосовой чат EOS

Добавьте голосовой чат Epic Online Services для сопоставленных игроков в игре на Unreal Engine, используя выделенный сервер Edgegap как доверенный голосовой сервер.

Это руководство показывает, как наш [демонстрационный проект Unreal Engine](https://github.com/edgegap/game-sample-unreal-engine-topdown) добавляет голосовой чат в игре с помощью [EOS Voice](https://dev.epicgames.com/docs/epic-online-services/multiplayer/voice-and-rtc-interface/voice-interface/voice-overview) от Epic Online Services. Игроки, подобранные [Edgegap Matchmaker](https://docs.edgegap.com/ru/learn/matchmeiking.md) могут общаться со своими товарищами по команде в голосовой комнате, а ваш выделенный сервер на Edgegap решает, кто к какой комнате подключается.

Голосовой чат **по умолчанию отключен** в примере. Пока вы его не включите, игра работает так, как описано в [Пример Top-Down](https://docs.edgegap.com/ru/docs/sample-projects/unreal-engine/top-down-sample.md).

{% hint style="success" %}
**Мы рекомендуем начать с** [Unreal Engine](https://docs.edgegap.com/ru/unreal-engine.md) **руководства по созданию игровых серверов, прежде чем продолжить.**
{% endhint %}

## 🎙️ Как это работает

Ваш выделенный сервер — это доверенный сервер EOS [доверенный сервер](https://dev.epicgames.com/docs/epic-online-services/multiplayer/voice-and-rtc-interface/voice-interface/voice-overview#voice-with-a-trusted-server-application). Игровые клиенты никогда не хранят учетные данные, которые могут создавать голосовые комнаты.

### 1. Игроки входят в EOS

Игровой клиент выполняет вход игрока в EOS с помощью идентификатора устройства, поэтому игрокам не нужен аккаунт Epic. Затем он отправляет серверу его Product User ID вместе с ID-токеном EOS.

### 2. Сервер проверяет игрока

Сервер проверяет ID-токен по открытым ключам Epic, поэтому игрок не может выдать себя за другого. Он также проверяет, что токен был выдан для вашего развертывания EOS.

### 3. Сервер выбирает комнату

Имена комнат берутся из матча:

* базовая комната называется по ID матча матчмейкера (`MM_MATCH_ID`), или по ID развертывания для сервера, который вы развернули вручную,
* с включенными командными комнатами (по умолчанию,  `bTeamRooms=True`), каждая команда получает свою собственную комнату, названную по матчу и команде.

Сервер определяет команду каждого игрока по [тикетам матчмейкера, подставленным как переменные окружения](https://docs.edgegap.com/ru/learn/matchmeiking/matchmaker-in-depth.md#injected-variables) — он сопоставляет IP, с которого подключается игрок, с IP в каждом тикете и читает команду из тикета. **Он никогда не доверяет команде, отправленной клиентом.** Игроки без соответствующего тикета (например, игроки, подключившиеся по IP) остаются в комнате матча. Установите `bTeamRooms=False` чтобы весь матч был в одной комнате.

### 4. Сервер выдает токен комнаты

Сервер запрашивает [EOS Voice Web API](https://dev.epicgames.com/docs/web-api-ref/voice-web-api) токен комнаты для этого игрока, передавая IP игрока, чтобы EOS использовал голосовой сервер рядом с ним. Он отправляет токен только этому игроку, а клиент присоединяется к комнате с помощью плагина EOSVoiceChat движка.

### 5. Сервер удаляет вышедших игроков

Когда игрок покидает сервер, сервер удаляет его из голосовой комнаты, что также отзывает его токен. Игровой код также может заглушить игрока для всех с помощью `UEdgegapVoiceServerSubsystem::SetHardMuted`.

{% hint style="info" %}
Ваши игровой режим и контроллер игрока не меняются. Когда игрок входит в систему (`PostLogin`), сервер добавляет небольшой реплицируемый компонент, `UEdgegapVoiceComponent`, к его контроллеру игрока. Он реплицируется только своему владельцу-клиенту и содержит `ServerRegisterVoice` и `ClientJoinVoiceRoom` RPC.
{% endhint %}

Сервер вызывает EOS Web API по HTTPS, а не EOS SDK, потому что EOS SDK не поддерживает голос на Linux. Клиентская часть собирается для Windows и Mac, где существует плагин EOSVoiceChat.

| Файл                          | Что он делает                                                                               |
| ----------------------------- | ------------------------------------------------------------------------------------------- |
| `EdgegapVoiceSettings.h`      | Переключатель и параметры из `DefaultGame.ini`                                              |
| `EdgegapVoiceClientSubsystem` | вход по ID устройства EOS, ID-токен, присоединение к комнатам и выход из них                |
| `EdgegapVoiceComponent`       | Добавляется сервером к каждому игроку, содержит голосовые RPC                               |
| `EdgegapVoiceServerSubsystem` | Проверка ID-токена, выбор комнаты, вызовы EOS Voice Web API, удаление при выходе из системы |

## ⚙️ Настройка

### 1. Создайте клиентов EOS

☑️ Откройте свой продукт в [Epic Developer Portal](https://dev.epicgames.com/portal), затем **Product Settings**.

☑️ Запишите свой Product ID, Sandbox ID и Deployment ID на вкладке **SDK Download & Credentials**.

☑️ Добавьте две политики на вкладке **Clients**, в разделе **Client policies**:

* **Игровой клиент** - тип `GameClient`, **Пользователь обязателен** отмечено, разрешение Voice не требуется,
* **Доверенный сервер** - **Создать пользовательскую политику**, **Пользователь обязателен** не отмечено, с действиями Voice `createRoomToken`, `kick` и `mute`.

☑️ Добавьте по одному клиенту для каждой политики и запишите каждый Client ID и Client Secret.

{% hint style="danger" %}
Клиент вашего доверенного сервера может создавать токен для любой комнаты в вашем развертывании. **Никогда не помещайте его в сборку игры.**
{% endhint %}

✅ Теперь можно перейти к следующему шагу.

### 2. Настройте игровой клиент

☑️ Заполните `[EOSVoiceChat]` в `MultiplayerGame/Config/UserEngine.ini` значениями вашего продукта, sandbox и deployment ID, а также **клиента игры** его ID и секретом. Этот файл игнорируется Git и переопределяет `DefaultEngine.ini`, поэтому ваши учетные данные не попадут в систему контроля версий.

☑️ Включите голос в `MultiplayerGame/Config/UserGame.ini` (тоже игнорируется Git):

{% code collapsedlinecount="10" %}

```ini
[/Script/MultiplayerGame.EdgegapVoiceSettings]
bEnabled=True
```

{% endcode %}

✅ Теперь можно перейти к следующему шагу.

### 3. Настройте сервер

☑️ Добавьте эти переменные окружения в ваш [, subject to Edgegap review.](https://app.edgegap.com/application-management/applications/list)и пометьте секрет как скрытый:

| Переменная                 | Значение                                                                                                             |
| -------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `EOS_VOICE_CLIENT_ID`      | Client ID доверенного сервера                                                                                        |
| `EOS_VOICE_CLIENT_SECRET`  | Client Secret доверенного сервера                                                                                    |
| `EOS_VOICE_DEPLOYMENT_ID`  | Deployment ID EOS (необязательно, если он уже есть в `DefaultEngine.ini`)                                            |
| `EOS_VOICE_GAME_CLIENT_ID` | Client ID игрового клиента, необязательно: тогда сервер принимает только ID-токены, выданные вашему игровому клиенту |

Голос будет включен на вашем сервере, как только они будут установлены, так что вам не нужно пересобирать образ сервера. Для сервера, работающего локально, поместите `ServerClientId` и `ServerClientSecret` в `EdgegapVoiceSettings` раздел `UserGame.ini` вместо этого.

✅ Теперь можно перейти к следующему шагу.

### 4. Играйте

☑️ Снова упакуйте свой сервер и клиент, разверните и играйте. При включенном матчмейкере товарищи по команде делят одну комнату.

☑️ Введите `VoiceMute` в консоли, чтобы включить или отключить микрофон.

🙌 Поздравляем, теперь ваши игроки могут разговаривать со своими товарищами по команде!

## 🧪 Тестирование с двумя клиентами на одном ПК

Идентификатор устройства принадлежит пользователю Windows, поэтому два клиента на одном ПК будут входить как один и тот же игрок EOS. Добавьте `-EOSVoiceNewDeviceId` в командную строку второго клиента, чтобы дать ему новую идентичность.

{% hint style="warning" %}
`-EOSVoiceNewDeviceId` создает нового пользователя EOS при каждом запуске, **используйте это только для тестирования**. Запускайте второй клиент только после того, как первый войдет `Voice: вошел в EOS` — если заменить идентификатор устройства, пока первый клиент еще входит, оба клиента получат одну и ту же идентичность.
{% endhint %}

Чтобы проверить, что звук идет без разговора в микрофон, запустите клиент с `-ExecCmds="EOSVoiceChat.FakeAudioInputEnabled 1"` (сборки Development). Он отправляет тестовый сигнал, а другой клиент пишет `Voice: <id> начал говорить в комнате <room>`.

С матчмейкером оба клиента должны попасть в очередь с разницей не более 10 секунд, иначе `casual` профиль начнет одиночный матч. Клиенты запускаются с разной скоростью, поэтому запускайте оба с одним и тем же `-FindMatchAt=<unix time>` (например, на две минуты вперед) вместо `-FindMatch` — каждый ставится в очередь в этот момент.

{% hint style="info" %}
Строки журнала, которые нужно искать (`LogEdgegapVoice`):

* сервер - `Voice: доверенный голосовой сервер готов`, затем `Voice: <id> получает комнату <room>` для каждого игрока, и `Voice: удален <id>` когда игрок уходит,
* клиент - `Voice: вошел в EOS как <id>`, `Voice: вошел в комнату <room>`, и `Voice: <id> начал говорить`.
  {% endhint %}
