Comment intégrer le matchmaking à votre jeu multijoueur JcE

-> Cet article est basé sur la documentation du Matchmaking. Si vous rencontrez des problèmes ou des divergences, veillez à vous référer au guide d'origine, car il est mis à jour plus régulièrement.

L'exemple suivant vous aidera à tester le flux de joueurs principal du matchmaking , à savoir :

• Créer l'instance de matchmaker sur le Cluster d'hébergement partagé,

• Définir les règles et les paramètres dans la Configuration de votre matchmaker,

• Et enfin, tester le flux de joueurs et gérer les Tickets de joueurs avec notre API.

Il y a cinq étapes pour implémenter notre matchmaker dans votre jeu :

1. La première étape consiste à créer un compte et à utiliser notre exemple de jeu JcE. Voilà, vous avez (techniquement) fait la moitié du chemin ! Il ne vous reste plus qu'à intégrer le matchmaker dans votre jeu (voir étape 5).

2. Maintenant, vous ne devriez jamais suivre aveuglément un exemple JSON trouvé sur Internet, il est donc fortement recommandé d'adapter les règles ci-dessus à votre jeu au tour par tour. L'étape 2 (« Explorer la configuration ») est notre « guide de lecture » qui détaille le fonctionnement de chacune des règles de matchmaking (« Explorer la configuration »).

3. L'étape 3 (« Examiner les détails de l'instance ») couvre votre matchmaker personnel et spécifique afin de vous assurer qu'il est déployé et fonctionne avec la conception de votre jeu.

4. L'étape 4, comme son nom l'indique (« 4. Tester l'API de tickets »), consiste à vérifier que les demandes de matchmaking de vos joueurs, appelées tickets, sont bien reçues par le matchmaker.

5. L'étape 5 (« Intégrer le Matchmaking dans votre jeu ») explique comment intégrer le matchmaker dans le projet de votre moteur.

Si vous rencontrez des difficultés de dépannage, notre Centre d'apprentissage approfondi propose des conseils de dépannage supplémentaires.

1. Configuration de l'offre gratuite (Free Tier)

Créez votre compte Edgegap gratuit et accédez à la page du tableau de bord du Matchmaker.

À partir de là, cliquez d'abord sur Create Matchmaker , puis saisissez :

• Un nom pour votre matchmaker – qui sert uniquement de référence personnelle, par ex. quickstart-dev,

• Ensuite, téléversez l'exemple simple suivant sous forme de configuration JSON ci-dessous pour votre jeu JcE :

{
  "version": "2.1.0",
  "inspect": true,
  "max_deployment_retry_count": 3,
  "ticket_expiration_period": "5m",
  "ticket_removal_period": "1m",
  "profiles": {
    "cooperative-example": {
      "application": {
        "name": "my-game-server=>CHANG-THIS-HERE",
        "version": "2024.01.30-16.23.00-UTC=>CHANG-THIS-HERE"
      },
      "rules": {
        "initial": {
          "match_size": {
            "type": "player_count",
            "attributes": {
              "team_count": 1,
              "team_size": 4
            }
          },
          "beacons": {
            "type": "latencies",
            "attributes": {
              "difference": 60,
              "max_latency": 60
            }
          },
          "selected_map": {
            "type": "intersection",
            "attributes": {
              "overlap": 1
            }
          },
          "selected_difficulty": {
            "type": "string_equality"
          },
          "player_level": {
            "type": "number_difference",
            "attributes": {
              "max_difference": 10
            }
          }
        },
        "expansions": {
          "5": {
            "beacons": {
              "difference": 80,
              "max_latency": 80
            }
          },
          "10": {
            "player_level": {
              "max_difference": 20
            }
          },
          "20": {
            "match_size": {
              "team_count": 1,
              "team_size": 3
            },
            "beacons": {
              "difference": 100,
              "max_latency": 100
            }
          },
          "30": {
            "match_size": {
              "team_count": 1,
              "team_size": 2
            },
            "beacons": {
              "max_latency": 200
            }
          },
          "60": {
            "match_size": {
              "team_count": 1,
              "team_size": 1
            }
          }
        }
      }
    }
  }
}

(rappel amical : veuillez vous assurer de modifier le name et la version de l'application pour qu'ils correspondent à vos Applications et Versions !)

Si aucune erreur de validation n'apparaît, cliquez sur Create and Start et attendez que le processus se termine. Cela entraînera le démarrage d'un nouveau cluster gratuit avec votre matchmaker Simple Example.

Vous pouvez maintenant passer à l'étape suivante.

2. Explorer la configuration​

Règles uniques pour jeu multijoueur JcE

Spécifiquement pour les jeux JcE, vous pouvez définir plusieurs Profils de Matchmaking pour les règles et paramètres spécifiques aux modes de jeu :

• permettre aux joueurs d'indiquer leurs préférences de cartes et de choisir une carte qui convient à tout le monde,

• permettre aux joueurs de choisir une difficulté de jeu particulière adaptée au niveau de compétence de chacun,

• restreindre la différence de niveau des joueurs afin de regrouper des joueurs ayant un degré similaire de progression dans le jeu,

• Rejoindre en groupe pour les salons prédéfinis ou pour compléter les équipes sans dépasser la taille des équipes,

• autoriser une latence plus élevée afin de privilégier des parties plus rapides avec des préférences de joueurs mieux affinées,

• allouer plus de CPU ou de mémoire en utilisant différentes 🏷️ Versions d'application lorsque davantage de joueurs sont autorisés.

Commencez par les conditions idéales, puis élargissez les restrictions pour garantir des parties rapides :

• assouplissez les restrictions de latence au fil du temps pour trouver plus de joueurs,

• réduisez progressivement la taille de l'équipe pour nécessiter moins de joueurs et démarrer la partie plus tôt,

  • facultativement, vous pouvez demander au serveur de remplir les emplacements vides avec des coéquipiers IA,

• augmentez progressivement la différence de niveau autorisée entre les joueurs pour trouver plus de joueurs,

• si aucun coéquipier n'est trouvé, lancez la partie en solo et utilisez le Remplissage (Backfill) pour ajouter des joueurs ultérieurement.

Gestion sémantique de version (Semantic Versioning)

Au fur et à mesure que nous publions des mises à jour pour Matchmaker, chaque nouvelle version utilise le Semantic Versioning pour communiquer clairement l'impact des changements en interprétant le format major.minor.patch :

• les versions major incluent des modifications majeures incompatibles (breaking changes) et nécessitent une révision de l'intégration,

• les versions minor incluent des améliorations substantielles rétrocompatibles,

• les versions patch incluent des corrections de bugs et des améliorations mineures.

Certains déploiements peuvent entraîner des erreurs. Nous tentons de résoudre ce problème en réessayant le déploiement jusqu'à max_deployment_retry_count fois automatiquement (sans confirmation du client).

Pour éviter que les plantages inattendus du client ou les tickets abandonnés ne persistent et n'occupent les ressources de votre matchmaker, les tickets seront annulés après ticket_expiration_period, ce qui fera passer leur statut à CANCELLED, puis seront définitivement supprimés après ticket_removal_period.

Le cœur de notre logique de matchmaking est configuré dans les Profils de Matchmaking. Chaque profil est une file d'attente de matchmaking totalement isolée, pointant vers des Versions d'application avec une quantité prédéfinie de ressources CPU et mémoire (RAM) requises.

Les Règles de Matchmaking du jeu de règles initial doivent être respectées pour que les joueurs soient regroupés, chacune étant définie par trois propriétés :

• un nom de votre choix, par ex. - match size,

• un type de règle, également appelé opérateur, par ex. - player_count,

• et enfin les attributs de l'opérateur, par ex. team_count ou team_size.

Règle du nombre de joueurs (Player Count Rule)

Il s'agit d'une règle spéciale définissant le nombre de joueurs nécessaires pour déclencher l'attribution :

• team_count fait référence au nombre d'équipes, 1 équipe pouvant être utilisée pour les modes coopératifs ou chacun pour soi,

• team_size fait référence au nombre de joueurs par équipe.

Notre exemple simple illustre un jeu coopératif à 2 joueurs.

Veuillez noter que la règle « Player Count » est requise et ne peut être définie qu'une seule fois dans vos règles de configuration initiales.

Règle de latences (Latencies Rule)

Utilisez cette règle pour fournir le ping le plus bas possible à tous les joueurs. Une fois que les clients mesurent et transmettent leur temps de trajet aller-retour (ping) par rapport à toutes les balises disponibles, Gen2 ne prendra en compte que les correspondances situées dans une plage de difference spécifique des valeurs de ping, mesurées par rapport aux Balises de ping. Cela offre une solution « douce » pour éviter de diviser votre base de joueurs, en permettant les correspondances avec les régions voisines, ce qui améliore notamment la vitesse de mise en relation pour les régions moins peuplées. Utilisez max_latency pour empêcher la mise en relation avec des joueurs situés trop loin.

Vous pouvez maintenant passer à l'étape suivante.

Notre exemple de règle beacons ci-dessus avec initialement "difference": 50, "max_latency": 200 :

• Alice et Bob seront mis en correspondance, car Pékin est écarté (>200) et le reste respecte | A-B | < 50 :

  • Alice {Montréal : 12.3, Newark : 45.6, Dallas : 59.9, Pékin : 264.4} ; et

  • Bob {Montréal : 27.3, Newark : 32.4, Dallas : 23.1, Pékin : 252.2}.

• Charlie et Dave ne seront pas mis en correspondance, car | C-D | > 50 pour la balise de Dallas :

  • Alice {Montréal : 5.7, Newark : 44.2, Dallas : 59.5, Pékin : 263.2} ; et

  • Bob {Montréal : 57.8, Newark : 32.0, Dallas : 24.2, Pékin : 272.3}.

Veuillez noter que les « Règles de latences » ne peuvent être définies qu'une seule fois dans vos règles de configuration initiales.

3. Examiner les détails de l'instance​

Examinez les détails de votre nouveau matchmaker dans notre tableau de bord une fois qu'il est initialisé :

Status indique l'état du service, qui peut être ONLINE, OFFLINE ou ERROR.

• Identifier aide l'équipe d'Edgegap à trouver rapidement votre matchmaker si vous avez besoin d'aide pour le dépannage.

• Started at peut être utile pour suivre l'heure de la dernière mise à jour.

• Size correspond à l'un de nos Niveaux de tarification.

• API URL sera utilisé par les clients de jeu et les serveurs de jeu pour communiquer avec Gen2.

• Swagger URL est une interface graphique pratique de spécification openAPI que nous fournissons pour explorer le schéma de l'API.

• Auth Token est un jeton secret unique utilisé par les clients de jeu et le serveur de jeu pour l'authentification.

Pour tester votre nouveau matchmaker à l'aide de l'API, vous aurez besoin de l'URL Swagger, de l'URL de l'API et du jeton d'authentification (Auth Token).

Vous pouvez maintenant passer à l'étape suivante.

4. Tester l'API Tickets

Tout d'abord, ouvrez votre URL Swagger pour inspecter votre schéma openAPI dans l'interface utilisateur de Swagger

Cliquez sur l'URL /...swagger.json sous le titre « Matchmaker » pour ouvrir le schéma JSON brut :

Enregistrez cette page sous forme de fichier sur votre disque (CTRL/CMD+S).

Ouvrez votre application Postman et connectez-vous à votre compte gratuit.

Importez votre fichier swagger.json de l'étape précédente :

• laissez Postman Collection sélectionné,

• sélectionnez View Import Settings et changez le paramètre Parameter generation pour Example.

Confirmez l'importation ; cela fera apparaître une nouvelle collection dans la liste des collections sur la gauche, intitulée Matchmaker.

View more actions, ouvrez l'onglet Authorization et choisissez :

• Auth Type - API Key,

• Key - « Authorization »

• Value - insérez votre valeur AuthToken ici,

• Add to - Header.

Appuyez sur (CTRL/CMD+S) ou sur l'icône Enregistrer pour enregistrer les modifications. Le point orange dans votre onglet Postman devrait disparaître.

Dans votre collection Matchmaker, sélectionnez tickets puis Create a matchmaking ticket, ce qui ouvrira un nouvel onglet.

Sélectionnez l'onglet Body pour prévisualiser votre demande de ticket de joueur :

remarquez que player_ip est défini sur null - cela entraînera l'utilisation de l'adresse IP automatiquement ajoutée à votre demande (voir Intégration de serveur à serveur pour les alternatives),

• profile fait référence à vos Profils de Matchmaking,

• attributes comprend des valeurs pour les règles de votre matchmaker, dans ce cas pour la règle latencies,

  • la règle player_count est la seule règle qui ne requiert aucun attribut dans les tickets de joueur.

REMARQUE : veillez à vous référer à la configuration d'importation Swagger de l'échantillon. 

Cliquez sur Send et examinez la réponse à votre demande de ticket de joueur :

• id est votre ID de ticket de matchmaking unique, conservez-le précieusement pour vérifier votre ticket ultérieurement,

• profile confirme le choix des Profils de Matchmaking,

• group_id est un ID de groupe unique attribué à chaque ticket, un joueur solo étant représenté comme un groupe de 1,

  • voir Rejoindre en groupe pour le matchmaking avec vos amis ou salons,

• player_ip est l'adresse IP publique résolue du joueur, quelle que soit la méthode d'identification utilisée,

• assignment est défini sur null pour indiquer que le ticket n'a pas encore été mis en correspondance ni assigné à un serveur,

• created_at fournit des informations sur le moment où le ticket de joueur a été créé pour l'interface utilisateur du jeu,

• status indique le statut actuel du ticket, tous les tickets commençant par SEARCHING (voir Processus de Matchmaking pour plus de détails).

Créez un deuxième ticket en cliquant à nouveau sur Send, afin que nos deux joueurs soient mis en correspondance et qu'un serveur soit démarré.

Dans votre collection Matchmaker, sélectionnez {ticketId} puis Read a matchmaking ticket.

Saisissez l'ID du ticket issu de la réponse de l'étape précédente et cliquez sur Send.

Examinez l'attribution mise à jour pour votre ticket de joueur :

• le statut passe d'abord à MATCH_FOUND, tout en conservant assignment défini sur null pour indiquer que les joueurs ont été mis en correspondance et qu'un serveur est en cours d'attribution,

Cliquez à nouveau sur Send pour vérifier votre ticket et examiner l'attribution mise à jour pour votre ticket de joueur :

• le statut est passé à HOST_ASSIGNED avec assignment contenant les détails du serveur attribué.

 Inspectez votre nouveau déploiement dans notre tableau de bord :

• remarquez que chaque déploiement est étiqueté avec tous les ID de ticket et le profil pour une meilleure traçabilité.

Essayez de vous connecter depuis votre client de jeu au serveur attribué.

Une fois que vous avez vérifié que vous pouvez vous connecter à votre déploiement sans problème et que vous avez terminé les tests, arrêtez votre déploiement pour libérer de la capacité sur votre compte pour le prochain build.

Vous pouvez maintenant passer à l'étape suivante.

5. Intégrer le Matchmaker dans votre jeu​

Le matchmaking d'Edgegap s'intègre :

• avec le Client de jeu, pour gérer les Tickets de joueurs,

• avec le Serveur de jeu, pour :

  • traiter les préférences des joueurs transmises par leurs tickets,

  • prendre en charge éventuellement le Remplissage (Backfill) pour ajouter ou remplacer des joueurs après le démarrage.

Côté Client de jeu, nous vous recommandons de fournir aux joueurs des mises à jour sur le statut du ticket tout au long du Processus de Matchmaking via l'interface utilisateur en jeu pour une expérience optimale. Voir :

• Edgegap - SDK Unity Gen2 Matchmaking,

  • importer l'exemple simple et le personnaliser selon vos besoins,

• Betide Studio - Kit d'intégration Edgegap pour Unreal Engine,

  • télécharger l'exemple de projet et le personnaliser selon vos besoins.

Dans le Client de jeu, assurez-vous de gérer les erreurs non réessayables :

• HTTP 404 Not Found - le ticket a été supprimé,

• HTTP 500 Internal Server Error - panne temporaire du service.

Dans le Serveur de jeu, traitez les préférences des joueurs et le contexte initial du serveur. Aucune intégration d'API n'est requise :

1. Lisez les variables d'environnement injectées (Gen2) pour récupérer les données initiales de matchmaking des joueurs.

2. Lisez les Variables d'environnement injectées (App Versions) pour les paramètres spécifiques à la version, les réglages (capacité de joueurs) et les secrets.

3. Lisez les Variables d'environnement injectées (Deployment) pour les informations de déploiement, telles que l'adresse IP, l'emplacement, etc.

Une fois les joueurs connectés, le Serveur de jeu et les Clients de jeu lancent une scène de chargement pour effectuer les étapes de synchronisation (par exemple, sélectionner et charger une carte/scène/niveau). Nous recommandons une scène 3D complète, une interface sociale de type salon ou un écran de chargement avec une barre de progression pour indiquer que l'initialisation est en cours.

Une fois les Clients de jeu complètement chargés, les joueurs chargent/basculent vers la scène de jeu principale.

Facultativement, le Serveur de jeu peut créer et gérer le Remplissage (Backfill) et la capacité des joueurs (ajouter ou remplacer les joueurs qui partent).

Assurez-vous que votre déploiement sera correctement arrêté à l'aide de DELETE_URL injectée, si :

• aucun joueur ne rejoint la partie,

• tous les joueurs ont quitté la partie,

• la partie se termine correctement.

Félicitations, vous avez terminé l'intégration d'Edgegap Matchmaker ! Si vous souhaitez en savoir plus, découvrez tout à ce sujet dans notre Centre d'apprentissage.