> 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/fr/docs/sample-projects/unity-netcodes/megacity-metro.md).

# Unity ECS Megacity Metro

Hébergez Megacity Metro de Unity, un jeu de tir Netcode for Entities pour jusqu’à 150 joueurs, sur Edgegap avec des serveurs dédiés, le matchmaking et le backfill.

Découvrez comment héberger des projets Unity DOTS sur Edgegap en utilisant des techniques issues du [Megacity Metro Sample](https://github.com/Unity-Technologies/megacity-metro), un shooter mobile et desktop construit sur Netcode for Entities, avec jusqu’à 150 joueurs par serveur.

Les joueurs appuient sur **Trouver une partie**, le [Matchmaker Edgegap](https://docs.edgegap.com/fr/learn/matchmaking.md) lance un serveur dédié près d’eux, et les joueurs qui cherchent plus tard rejoignent des serveurs en cours d’exécution avec [backfill](https://docs.edgegap.com/fr/learn/matchmaking/matchmaker-in-depth.md#backfill-match). Le serveur arrête son propre déploiement lorsqu’il n’y a plus personne en jeu.

Cet exemple montre :

* **Unity 6000.1.0f1** projet sur **Netcode for Entities** (DOTS), compilé en tant que serveur dédié Linux,
* **connexion directe** depuis un client desktop vers un déploiement, pour tester sans matchmaker,
* **Matchmaker Edgegap** intégration avec [Edgegap Unity SDK](https://github.com/edgegap/sdk-unity-sessions-matchmaker-server-browser) - le client met en file d’attente un ticket et se connecte au serveur assigné,
* **backfill** - les serveurs en cours d’exécution conservent des places ouvertes dans le matchmaker, afin que les nouveaux joueurs les rejoignent au lieu de lancer de nouveaux serveurs, jusqu’à 150 joueurs,
* **arrêt automatique du serveur** - le serveur arrête son propre déploiement lorsqu’aucun joueur ne rejoint, ou après le départ de tout le monde.

Le netcode du jeu est inchangé. Sans URL de matchmaker, en dehors d’un déploiement Edgegap et sans cible de connexion directe, le jeu se comporte comme en amont.

{% hint style="info" %}
Vérifié sur Edgegap avec des clients desktop Windows : déploiement de serveur, connexion directe et matchmaking avec backfill (3 joueurs sur un serveur). Les builds de version mobile masquent l’option Connect, donc les téléphones utilisent **Trouver une partie**.
{% endhint %}

{% hint style="success" %}
Voir [EDGEGAP.md](https://github.com/edgegap/netcode-game-sample-unity-dots-ecs-mobile-megacity-metro/blob/master/EDGEGAP.md) dans le dépôt d’exemple pour la liste complète des fichiers Edgegap et des paramètres du serveur.
{% endhint %}

## ✔️ Préparation

Avant de commencer, vous aurez besoin :

* [Unity `6000.1.0f1`](https://unity.com/releases/unity-6) - téléchargez via Unity Hub, avec les modules ci-dessous et le module de votre plateforme cliente (Windows Build Support (IL2CPP) pour le client testé),
* [projet Megacity Metro Sample](https://github.com/edgegap/netcode-game-sample-unity-dots-ecs-mobile-megacity-metro) (modifié pour Edgegap), cloné avec [Git LFS](https://git-lfs.com/) (environ 415 Mo de contenu LFS).

<details>

<summary>Installer les modules de prise en charge de compilation Linux pour Unity</summary>

* Utilisez Unity Hub pour sélectionner l'onglet **Installe**, accéder à **Paramètres** et **Ajouter des modules** pour chaque version d'Unity que vous avez l'intention d'utiliser avec la plateforme Edgegap :

<figure><img src="https://3008966946-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsR0dHSFv9ymoC0DO5G8J%2Fuploads%2FylRG4r8orenZrw5ijjpJ%2Fimage.png?alt=media&amp;token=fb981825-8a15-4c07-9180-0f79a6a77a91" alt=""><figcaption></figcaption></figure>

* Faites défiler vers le bas pour sélectionner et installer les modules Unity suivants :
  * **Prise en charge de compilation Linux (IL2CPP),**
    * **Prise en charge de compilation Linux (Mono),**
    * **Prise en charge de compilation pour serveur dédié Linux**

<figure><img src="https://3008966946-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsR0dHSFv9ymoC0DO5G8J%2Fuploads%2FuXtyqoLhBOk8CZJ4WdzA%2Fimage.png?alt=media&amp;token=19e956ed-a731-420d-b911-130c334794fc" alt=""><figcaption></figcaption></figure>

</details>

<details>

<summary><a href="https://www.docker.com/products/docker-desktop/">Installez Docker Desktop (ou Docker CLI)</a></summary>

* [Installez Docker Desktop à partir de la source officielle](https://www.docker.com/products/docker-desktop/) (aucun compte requis).
* Redémarrez votre ordinateur après avoir terminé l'installation.

</details>

## ⚡ Déployer et se connecter

### 1. Compiler et pousser

☑️ Pour commencer, vous devrez [créer un compte gratuit sur Edgegap](https://app.edgegap.com/auth/register). Aucune carte de crédit requise.

☑️ Compilez dans le plugin de l’éditeur dans  ou via la CLI :

{% tabs %}
{% tab title="Unity Servers Quickstart Plugin (recommandé)" %}
☑️ Sélectionnez Tools / Edgegap / Build Linux Dedicated Server.

☑️ Terminez l’étape Containerize and Upload du plugin Edgegap.
{% endtab %}

{% tab title="Interface en ligne de commande (pour les agents)" %}
☑️ Fermez votre projet dans Unity Editor, puis compilez le serveur dédié Linux depuis la racine du projet :

{% code collapsedlinecount="10" %}

```bash
Unity -batchmode -quit -buildTarget Linux64 -standaloneBuildSubtarget Server -projectPath . -executeMethod EdgegapServerBuild.Build -logFile build.log
```

{% endcode %}

{% hint style="warning" %}
Conservez `-buildTarget Linux64 -standaloneBuildSubtarget Server`, sinon la compilation du contenu Entities échoue avec `Impossible de compiler avec la configuration actuelle`.
{% endhint %}

☑️ Trouvez votre [Container Registry](https://docs.edgegap.com/fr/learn/advanced-features/edgegap-container-registry.md#getting-your-credentials) nom de projet et vos identifiants, puis connectez-vous avec Docker :

{% 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 %}

☑️ Compilez et poussez votre image :

{% code collapsedlinecount="10" %}

```bash
docker build --platform linux/amd64 -t registry.edgegap.com/<project>/megacity-metro:<tag> .
docker push registry.edgegap.com/<project>/megacity-metro:<tag>
```

{% endcode %}
{% endtab %}
{% endtabs %}

Votre build est enregistrée dans `Builds/EdgegapServer/` (environ 3,4 Go, principalement des informations de débogage Burst et le dossier de sauvegarde IL2CPP). Le `.dockerignore` exclut `*_BurstDebugInformation_DoNotShip` et `*_BackUpThisFolder_ButDontShipItWithYourGame`, donc votre image fait environ 537 Mo.

{% hint style="danger" %}
:x: **À ÉVITER — écraser les tags existants ou utiliser `latest`  tag** — cela déploiera un cache obsolète.\
:white\_check\_mark: **À FAIRE — toujours incrémenter votre tag de version** et déployer la nouvelle version.
{% endhint %}

Votre serveur écoute sur `0.0.0.0:7979` via UDP. Passez des arguments serveur supplémentaires dans `UNITY_COMMANDLINE_ARGS` variable d’environnement de votre version d’application.

✅ Vous pouvez maintenant passer à l’étape suivante.

### 2. Créer une version d’application

☑️ [Créez une application](https://app.edgegap.com/application-management/applications/list) et une version avec :

* votre `registry.edgegap.com/<project>/megacity-metro:<tag>` image,
* votre nom d’utilisateur et votre jeton du Container Registry, sinon les déploiements ne parviennent pas à extraire l’image,
* ressources 1 vCPU et 2 Go de mémoire (testé, un serveur inactif utilisait environ 18 % de CPU et 323 Mo),
* [port](https://docs.edgegap.com/fr/learn/orchestration/application-and-versions.md#port-mapping) `7979`, nommé `gameport`, protocole **UDP**.

✅ Vous pouvez maintenant passer à l’étape suivante.

### 3. Connexion directe

Vérifions que votre serveur fonctionne avant d’ajouter un matchmaker.

☑️ [Déployez votre version d’application](https://app.edgegap.com/deployment-management/deployments/list) depuis le plugin ou le tableau de bord. Le journal de votre serveur affiche `Running on Edgegap ... skipping UGS sessions`.

☑️ [Ouvrez les détails de votre nouveau déploiement](https://app.edgegap.com/deployment-management/deployments/list) et trouvez vos informations de connexion uniques à usage unique :

* **URL de l’hôte** au format `780aa4260e83.pr.edgegap.net` (ou IP),
* **Port externe** de `gameport` au format `30854` (5 chiffres, pas `7979`).

☑️ Démarrez un client de bureau avec ces détails :

{% code collapsedlinecount="10" %}

```bash
<client executable> -edgegapConnect <host>:<external port>
```

{% endcode %}

Vous pouvez aussi définir `EDGEGAP_CONNECT=<host>:<external port>` avant de lancer votre client. Avec une cible de connexion directe, votre client ignore la connexion à Unity Gaming Services (UGS), donc aucun projet UGS n’est nécessaire. **Trouver une partie** se connecte à cette cible.

☑️ Trouver `[Edgegap] Joueurs connectés : 1` dans le journal de votre serveur une fois que votre client a rejoint.

✅ Vous pouvez maintenant passer à l’étape suivante.

### 4. Créer un matchmaker

☑️ Définissez `application.name` et `application.version` sur votre application et votre version dans le `matchmaker-config.json`.

La configuration contient un seul `metro` profil avec une seule équipe de 2 à 150 joueurs. Deux joueurs qui cherchent ensemble obtiennent un serveur environ 10 secondes après la mise en file d’attente, et un joueur seul en obtient un après 30 secondes. Cela convient pour les tests ; augmentez le minimum pour les vraies parties.

☑️ Ouvrez la page [Matchmaker](https://app.edgegap.com/matchmaker-management-v2/matchmakers/list) , cliquez sur **Créer un Matchmaker**, téléchargez `matchmaker-config.json`, puis cliquez sur **Créer et démarrer**.

☑️ Copiez l’ **URL API** et **jeton d’authentification** une fois qu’il affiche **EN LIGNE**.

* **Cluster gratuit (partagé)** pour tester toutes les fonctionnalités et explorer les synergies avec votre conception,
  * s'éteint automatiquement après 3 heures, nécessitant un redémarrage pour continuer les tests.
* **Cluster privé** **(dé dédié)** pour garantir un environnement stable pour vos besoins de production,
  * choisissez votre région et obtenez un support 24/7 pour les jeux en direct afin de publier en toute confiance.

Redémarrer votre matchmaker depuis le tableau de bord conserve son URL API et son jeton d’authentification.

✅ Vous pouvez maintenant passer à l’étape suivante.

### 5. Trouver une partie

☑️ Collez votre URL API et votre jeton d’authentification dans `Assets/Resources/EdgegapMatchmakerSettings.asset`.

{% hint style="danger" %}
**N’intégrez pas les points de terminaison de l’API Edgegap dans le client du jeu, car votre jeton API donne un accès illimité à votre compte. Voir** [Intégration](https://docs.edgegap.com/fr/docs/api/integration.md) **pour des points de terminaison et des fonctions d’API sécurisés destinés aux clients.**
{% endhint %}

{% hint style="info" %}
Le jeton d’authentification du matchmaking est limité à votre matchmaker uniquement, donc vous pouvez l’intégrer sans risque dans les clients du jeu.
{% endhint %}

☑️ Recompilez votre serveur et vos clients - les clients lisent cet asset pour trouver des parties, les serveurs le lisent pour créer des backfills. Poussez votre nouvelle image de serveur et pointez votre version d’application et `matchmaker-config.json` vers celle-ci.

Remplacez l’asset au lancement avec `-edgegapMatchmakerUrl`, `-edgegapMatchmakerToken` et `-edgegapMatchmakerProfile` (ou `EDGEGAP_MM_URL`, `EDGEGAP_MM_TOKEN`, `EDGEGAP_MM_PROFILE`).

☑️ Démarrez deux clients et cliquez sur **Trouver une partie** dans les deux. Le statut passe de `Recherche...` à `Partie trouvée, démarrage du serveur...`, puis votre client se connecte.

☑️ Démarrez un troisième client et cliquez sur **Trouver une partie** pendant que la partie est en cours. Il rejoint le même serveur via un backfill.

🙌 Félicitations pour votre premier déploiement avec matchmaking sur Edgegap !

## 🔄 Cycle de vie de la partie

1. Le client met en file d’attente un ticket solo avec `metro` le profil. Son `backfill_group_size` attribut est `["new", "1"]` - une nouvelle partie, ou une place sur un serveur en cours d’exécution.
2. Le matchmaker lance un déploiement près des joueurs, ou associe le ticket à un backfill provenant d’un serveur en cours d’exécution.
3. Le client se connecte à l’IP et au port externe du serveur, puis envoie son ID de ticket au serveur.
4. Sur les déploiements du matchmaker, le serveur lit la partie depuis [`MM_*` variables](https://docs.edgegap.com/fr/learn/matchmaking/matchmaker-in-depth.md#injected-variables) et donne à chaque joueur apparié 60 secondes pour se connecter. Il maintient jusqu’à 3 backfills ouverts tant qu’il reste des places libres, et libère une place lorsque son joueur part ou n’arrive jamais.
5. Le serveur ferme ses backfills et arrête son déploiement avec `ARBITRIUM_DELETE_URL` - 300 secondes après le démarrage si aucun joueur ne s’est jamais connecté, ou 60 secondes après le départ du dernier joueur.

Modifiez ces limites avec des variables d’environnement sur votre version d’application :

* `EDGEGAP_MAX_PLAYERS` - places par serveur (par défaut `150`),
* `EDGEGAP_MAX_OPEN_BACKFILLS` - backfills ouverts simultanément (par défaut `3`),
* `EDGEGAP_FIRST_PLAYER_TIMEOUT_S` - secondes avant qu’un serveur que personne n’a rejoint ne s’arrête de lui-même (par défaut `300`),
* `EDGEGAP_EMPTY_TIMEOUT_S` - secondes après le départ du dernier joueur avant que le serveur ne s’arrête de lui-même (par défaut `60`).

{% hint style="warning" %}
Si un déploiement est arrêté de l’extérieur (tableau de bord, API ou durée maximale), le serveur se ferme sans clôturer ses backfills. **Jusqu’à leur expiration** (`ticket_expiration_period`, 30 secondes), **ils peuvent envoyer un joueur vers le serveur arrêté.** La connexion de ce joueur expire, et son prochain **Trouver une partie** fonctionne.
{% endhint %}

Voir [Matchmaking](https://docs.edgegap.com/fr/learn/matchmaking.md), [Analyse approfondie](https://docs.edgegap.com/fr/learn/matchmaking/matchmaker-in-depth.md) et [Déploiements](https://docs.edgegap.com/fr/learn/orchestration/deployments.md) pour en savoir plus.

## ⚠️ Problèmes connus

* Les clients Android et iOS ne sont pas encore testés, pas plus qu’un test de jeu fenêtré sur desktop.
* Le serveur journalise les connexions avec des ID de ticket inconnus, mais les autorise quand même (pas encore de validation des tickets).
* Vivox et la connexion UGS ne sont pas modifiés. Les chemins Edgegap Matchmaker et de connexion directe ne les utilisent pas.
