> 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/godot/nakama-fish-game.md).

# Nakama Fish Game

Hébergez Fish Game de Heroic Labs pour Godot 4 sur des serveurs dédiés Edgegap, lancé par le système de matchmaking Nakama via le plugin nakama-edgegap.

Découvrez comment héberger des projets Godot sur Edgegap avec [Nakama](https://heroiclabs.com) le matchmaking, en utilisant des techniques tirées de [Fish Game](https://github.com/heroiclabs/fishgame-godot) un exemple pour 2 à 4 joueurs par Heroic Labs, porté sur Godot 4.

En amont, chaque partie s'exécutait sur la machine d'un joueur, relayée via Nakama. Dans [notre fork](https://github.com/edgegap/backend-game-sample-godot-nakama-fishgame) pas d'hôte joueur — Nakama gère les comptes, le matchmaking et le classement, et lance un serveur Godot sans interface graphique à proximité des joueurs appariés via [Edgegap Fleet Manager pour Nakama](https://github.com/edgegap/backend-nakama-edgegap-plugin).

Cet exemple montre :

* **Godot 4.7** jeu en GDScript, exécuté en tant que serveur dédié sans interface graphique via ENet sur le port UDP `7777`,
* **Nakama 3.39** avec un module Go — le hook du matchmaking lance un déploiement par match et envoie à chaque joueur l'adresse du serveur une fois que le serveur signale `PRÊT`,
* **règles de match autoritaires côté serveur** - le serveur décide des coups portés, des morts, des ramassages, des apparitions, des manches et du gagnant,
* **vérifications des joueurs** - le serveur n'admet que les joueurs disposant d'une session Nakama valide et qui lui ont été appariés,
* **classement serveur à serveur** - le serveur enregistre la victoire dans un classement Nakama faisant autorité, dans lequel les joueurs ne peuvent pas écrire,
* **arrêt automatique du serveur** - le serveur demande à Nakama d'arrêter son déploiement lorsque le match est terminé.

{% hint style="success" %}
Voir [Déployer depuis Nakama](https://docs.edgegap.com/fr/docs/tools-and-integrations/deployer-depuis-nakama.md) pour un aperçu de l'intégration de Nakama, et [EDGEGAP.md](https://github.com/edgegap/backend-game-sample-godot-nakama-fishgame/blob/main/EDGEGAP.md) dans le dépôt d'exemple pour la liste complète des fichiers Edgegap, des tests et des limites connues.
{% endhint %}

{% hint style="warning" %}
La plupart des graphismes et de la musique du jeu sont sous licence [CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/) par Heroic Labs (voir `assets/LICENSE.txt`). Le code est sous licence Apache 2.0.
{% endhint %}

## ✔️ Préparation

Avant de commencer, vous aurez besoin de :

* [Projet d'exemple Fish Game](https://github.com/edgegap/backend-game-sample-godot-nakama-fishgame) (modifié pour Edgegap),
* [Godot 4.7](https://godotengine.org/) (4.3 ou version ultérieure devrait fonctionner),
* jeton API Edgegap — pour Nakama uniquement,
* adresse HTTPS publique pour Nakama — les serveurs Edgegap rappellent Nakama, donc `localhost` ne fonctionnera pas (un tunnel suffit pour les tests, voir l'étape 2).

<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 connecter

### 1. Construire l’image du serveur

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

☑️ 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 login registry.edgegap.com`.

☑️ Créez et poussez l'image de votre serveur depuis la racine du dépôt. `server/Dockerfile` exporte le préréglage « Linux Server » vers un `.pck` et l'exécute avec Godot sans interface graphique :

{% code collapsedlinecount="10" %}

```bash
docker build --platform linux/amd64 -f server/Dockerfile -t registry.edgegap.com/<project>/fishgame-godot:1.0.0 .
docker push registry.edgegap.com/<project>/fishgame-godot:1.0.0
```

{% endcode %}

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

☑️ [Créez une application](https://app.edgegap.com/application-management/applications/list) nommé `fishgame-godot`, et une version nommée `1.0.0` avec :

* image `<project>/fishgame-godot`, tag `1.0.0`, avec votre nom d'utilisateur et votre jeton de registre,
* ressources 0,5 vCPU et 512 Mo de mémoire,
* [port](https://docs.edgegap.com/fr/learn/orchestration/application-and-versions.md#port-mapping) `7777`, nommé `gameport`, protocole **UDP**,
* [durée maximale](https://docs.edgegap.com/fr/learn/orchestration/application-and-versions.md#safety-guardrails) 30 minutes (le serveur s'arrête aussi de lui-même).

Votre serveur n'a besoin d'aucune variable d'environnement propre — Fleet Manager lui transmet les URL de rappel de Nakama à chaque déploiement.

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

### 2. Exécutez Nakama

☑️ Copiez `nakama/.env.example` à `nakama/.env` et renseignez :

* `EDGEGAP_API_TOKEN` - votre jeton API Edgegap, avec son `token` préfixe,
* `EDGEGAP_APPLICATION`, `INITIAL_EDGEGAP_VERSION`, `EDGEGAP_PORT_NAME` - l'application, la version et le nom du port de l'étape 1,
* `NAKAMA_ACCESS_URL` - l'adresse HTTPS publique de Nakama,
* `NAKAMA_HTTP_KEY` - une longue chaîne aléatoire ; les serveurs de jeu la reçoivent dans leurs URL de rappel.

{% hint style="danger" %}
Votre jeton API Edgegap donne accès à l'ensemble de votre organisation. Conservez-le dans `nakama/.env` et uniquement Nakama. **Ne le mettez jamais dans le client de jeu ni dans l'image du serveur.**
{% endhint %}

☑️ Pour tester sur votre machine, lancez un tunnel rapide Cloudflare pour donner une adresse publique à Nakama. Copiez l'URL affichée `https://….trycloudflare.com` dans `NAKAMA_ACCESS_URL`:

{% code collapsedlinecount="10" %}

```bash
docker run -d --name fishgame-tunnel cloudflare/cloudflared:latest tunnel --no-autoupdate --url http://host.docker.internal:7350
```

{% endcode %}

☑️ Démarrez Nakama et Postgres. `nakama/Dockerfile` intègre le module Go avec Edgegap Fleet Manager dans Nakama :

{% code collapsedlinecount="10" %}

```bash
docker compose -p fishgame -f nakama/docker-compose.yml up -d --build
```

{% endcode %}

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

### 3. Jouer

☑️ Faites pointer votre jeu vers Nakama, soit en modifiant les valeurs par défaut en haut de `autoload/Online.gd`, ou dans la ligne de commande :

{% code collapsedlinecount="10" %}

```bash
godot --path . -- --nakama-host=your-tunnel.trycloudflare.com --nakama-port=443 --nakama-scheme=https
```

{% endcode %}

{% hint style="info" %}
Les joueurs devraient également accéder à Nakama via son adresse publique. Nakama enregistre l'IP depuis laquelle chaque joueur se connecte, et Edgegap utilise ces IP pour [déployer au plus près des joueurs](https://docs.edgegap.com/fr/learn/orchestration/deployments.md#server-placement).
{% endhint %}

☑️ Démarrez deux instances du jeu, choisissez **En ligne**, créez un compte dans chacune, et appuyez sur **Appariement** dans les deux.

Après « Match found! Starting a game server... », les deux joueurs arrivent sur l'écran prêt du même serveur Edgegap. Le premier poisson à gagner 5 manches remporte le match et obtient +1 au classement.

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

## 🔄 Cycle de vie de la partie

1. Les joueurs se connectent à Nakama avec leur e-mail, puis soumettent un ticket de matchmaking.
2. Lorsque Nakama les appaire, le hook de matchmaking du module demande à Fleet Manager de créer un déploiement, avec les ID des utilisateurs appariés dans ses métadonnées.
3. Le serveur de jeu démarre, écoute sur UDP `7777`, et envoie `PRÊT` à Nakama avec sa propre IP et son port externe. Nakama notifie chaque joueur apparié avec l'adresse du serveur.
4. Les joueurs se connectent via ENet. Le serveur vérifie la session Nakama de chaque joueur avec `/v2/account` et n'accepte que les joueurs qui lui ont été appariés. Il signale à Nakama les ID des utilisateurs connectés toutes les 5 secondes lorsqu'ils changent.
5. Lorsque le match est gagné, le serveur appelle `report_match_result` l'appel RPC serveur à serveur avec la clé HTTP de Nakama, et Nakama ajoute la victoire au `fish_game_wins` classement. L'appel RPC refuse les sessions de joueur et ne compte chaque déploiement qu'une seule fois.
6. Le serveur envoie `ARRÊT`, et Nakama arrête le déploiement. Il s'arrête aussi lorsqu'il reste moins de 2 joueurs en cours de match, lorsque tout le monde quitte, lorsque personne ne rejoint dans les 60 secondes, ou après 20 minutes.

Chaque joueur reste propriétaire des déplacements de son poisson, comme en amont. Déplacer les mouvements vers le serveur avec la prédiction côté client est la prochaine étape pour un jeu compétitif.

Voir [Déployer depuis Nakama](https://docs.edgegap.com/fr/docs/tools-and-integrations/deployer-depuis-nakama.md), [Matchmaking](https://docs.edgegap.com/fr/learn/matchmaking.md) et [Déploiements](https://docs.edgegap.com/fr/learn/orchestration/deployments.md) pour en savoir plus.

## ⚠️ Problèmes connus

* L'export HTML5 ne peut pas jouer en ligne - ENet utilise UDP, que les navigateurs ne peuvent pas utiliser. Une version web nécessiterait le peer WebSocket de Godot et un [port WS avec mise à niveau TLS](https://docs.edgegap.com/fr/learn/orchestration/deployments.md#websockets-ws-and-secure-websockets-wss).
