Comment intégrer le matchmaking à votre jeu de cartes à collectionner (TCG) multijoueur

-> Cet article est basé sur la documentation sur le Matchmaking. Si vous rencontrez des problèmes ou des divergences, veillez à vous référer au guide original, car il est mis à jour plus fréquemment.

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

• La création de l'instance de matchmaker sur le Cluster d'hébergement partagé,

• La définition des règles et des paramètres dans la Configuration de votre matchmaker,

• Et enfin, le test du flux de joueur et la gestion des Tickets de joueur 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 TCG. Et 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, et il est donc fortement recommandé d'adapter les règles ci-dessus à votre jeu. L'étape 2 (« Explorer la configuration ») est notre guide de lecture qui détaille la fonction de chaque règle de matchmaking (« Explorer la configuration »).

3. L'étape 3 (« Examiner les détails de l'instance ») couvre votre matchmaker spécifique et personnel afin de s'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 des tickets »), consiste à vérifier que vos demandes de matchmaking provenant des 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 au sein du 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)

Inscrivez-vous pour obtenir votre compte Edgegap gratuit, et accédez à la page du tableau de bord du Matchmaker.

À partir de là, cliquez d'abord sur Create Matchmaker (Créer un matchmaker), puis saisissez :

• Un nom pour votre matchmaker – uniquement pour votre propre référence, par ex. quickstart-dev,

• Ensuite, importez l'exemple simple suivant sous forme de configuration JSON ci-dessous pour votre jeu TCG :

{
  "version": "1.0.0",
  "max_deployment_retry_count": 3,
  "ticket_expiration_period": "5m",
  "ticket_removal_period": "1m",
  "profiles": {
    "casual-example": {
      "application": {
        "name": "my-game-server=>CHANGE-THIS-NAME-HERE",
        "version": "2024.01.30-16.23.00-UTC=>CHANGE-THIS-HERE "
      },
      "rules": {
        "initial": {
          "match_size": {
            "type": "player_count",
            "attributes": {
              "team_count": 2,
              "team_size": 5
            }
          },
          "beacons": {
            "type": "latencies",
            "attributes": {
              "difference": 25,
              "max_latency": 100
            }
          },
          "league_rank": {
            "type": "number_difference",
            "attributes": {
              "max_difference": 1
            }
          },
          "selected_maps": {
            "type": "intersection",
            "attributes": {
              "overlap": 1
            }
          },
          "selected_beacons": {
            "type": "intersection",
            "attributes": {
              "overlap": 1
            }
          }
        },
        "expansions": {
          "10": {
            "beacons": {
              "difference": 40,
              "max_latency": 150
            }
          },
          "30": {
            "beacons": {
              "difference": 50
            }
          },
          "60": {
            "league_rank": {
              "max_difference": 2
            }
          },
          "180": {
            "beacons": {
              "difference": 100,
              "max_latency": 500
            }
          }
        }
      }
    },
    "competitive-example": {
      "application": {
        "name": "my-game-server",
        "version": "2024.01.30-16.23.00-UTC"
      },
      "rules": {
        "initial": {
          "match_size": {
            "type": "player_count",
            "attributes": {
              "team_count": 2,
              "team_size": 5
            }
          },
          "beacons": {
            "type": "latencies",
            "attributes": {
              "difference": 25,
              "max_latency": 100
            }
          },
          "league_rank": {
            "type": "number_difference",
            "attributes": {
              "max_difference": 0
            }
          },
          "selected_maps": {
            "type": "intersection",
            "attributes": {
              "overlap": 1
            }
          },
          "selected_beacons": {
            "type": "intersection",
            "attributes": {
              "overlap": 1
            }
          }
        },
        "expansions": {
          "30": {
            "beacons": {
              "difference": 40,
              "max_latency": 150
            }
          },
          "60": {
            "beacons": {
              "difference": 50
            }
          },
          "180": {
            "beacons": {
              "max_latency": 250
            }
          }
        }
      }
    },
    "challenger-example": {
      "application": {
        "name": "my-game-server",
        "version": "2024.01.30-16.23.00-UTC"
      },
      "rules": {
        "initial": {
          "match_size": {
            "type": "player_count",
            "attributes": {
              "team_count": 2,
              "team_size": 5
            }
          },
          "beacons": {
            "type": "latencies",
            "attributes": {
              "difference": 25,
              "max_latency": 100
            }
          },
          "league_rank": {
            "type": "number_difference",
            "attributes": {
              "max_difference": 0
            }
          },
          "selected_maps": {
            "type": "intersection",
            "attributes": {
              "overlap": 1
            }
          },
          "selected_beacons": {
            "type": "intersection",
            "attributes": {
              "overlap": 1
            }
          }
        },
        "expansions": {
          "30": {
            "beacons": {
              "difference": 40,
              "max_latency": 150
            }
          },
          "180": {
            "beacons": {
              "difference": 50
            }
          },
          "240": {
            "beacons": {
              "max_latency": 250
            }
          }
        }
      }
    }
  }
}

(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 (Créer et démarrer) 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 spécifiques aux jeux TCG

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

• restreindre le rang dans une limite d'écart entre deux joueurs pour des parties plus occasionnelles,

• restreindre la différence de rang pour n'autoriser que des adversaires de même rang pour les parties classées,

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

• ajouter une Interface de sélection de hub pour limiter les adversaires aux Balises de ping spécifiées,

• restreindre la latence de matchmaking à un seuil maximal pour éviter d'associer des joueurs éloignés,

• restreindre la latence de matchmaking à une différence maximale pour optimiser l'équité du ping,

• allouer plus de processeur ou de mémoire en utilisant différentes Versions de l'application lorsque davantage de joueurs sont autorisés,

• Rejoindre en groupe pour des salons préconstitués ou pour compléter des équipes sans dépasser leur taille maximale.

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

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

• augmentez progressivement la différence de rang autorisée pour trouver plus de joueurs,

• augmentez le temps entre les élargissements de critères pour les rangs les plus élevés (challengers), car moins de joueurs sont disponibles.

Créez des tickets avec un rang plus élevé pour les matchs de promotion, afin de rencontrer des adversaires plus coriaces.

Définissez des profils distincts pour les tricheurs afin de vous assurer que les tricheurs signalés ou les joueurs faisant l'objet d'un grand nombre de signalements de modération n'aient pas d'impact négatif sur l'expérience des joueurs légitimes dans les parties classées.

Gestion sémantique de version

Chaque nouvelle version utilise le Versionnage sémantique pour communiquer clairement l'impact des modifications en interprétant le format majeure.mineure.correctif :

• les versions majeures incluent des changements cassants et nécessitent une révision de l'intégration,

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

• les versions de correctif 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 automatiquement le déploiement jusqu'à max_deployment_retry_count fois (sans confirmation du client).

Pour s'assurer que les pannes inattendues du client ou les tickets abandonnés ne s'éternisent pas et ne consomment pas les ressources de votre matchmaker, les tickets seront annulés après ticket_expiration_period, ce qui fera passer leur statut à CANCELLED, puis 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 complètement isolée, pointant vers des Versions d'application avec une quantité prédéfinie de ressources processeur et mémoire (RAM) requises.

Les Règles de Matchmaking de l'ensemble de règles initiales doivent être satisfaites 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

Il s'agit d'une règle spéciale définissant le nombre de joueurs devant correspondre pour initier 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 » (Nombre de joueurs) est obligatoire et ne peut être définie qu'une seule fois dans vos règles de configuration initiales.

Règle de latences

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 d'aller-retour (ping) par rapport à toutes les balises disponibles, Gen2 ne prendra en compte que les correspondances situées dans une limite de différence 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, permettant ainsi le matchmaking avec les régions voisines, améliorant particulièrement la rapidité des matchs pour les régions moins peuplées. Utilisez max_latency pour empêcher l'association 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 associés, car Pékin est écarté (>200) et le reste se situe dans | 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 associés, puisque | 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 la règle « Latencies Rules » (Règles de latences) ne peut être définie 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é :

L'état (Status) indique l'état de santé du service, il peut être ONLINE, OFFLINE ou ERROR.

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

• Started at (Démarré à) peut être utile pour retrouver l'heure de la dernière mise à jour.

• La taille (Size) correspond à l'un de nos Niveaux tarifaires.

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

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

• Le jeton d'authentification (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.

Vous pouvez maintenant passer à l'étape suivante.

4. Tester l'API des tickets

Tout d'abord, ouvrez votre URL Swagger pour inspecter votre schéma openAPI dans l'interface graphique 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 sur Example.

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

Affichez plus d'actions (View more actions), ouvrez l'onglet Authorization et choisissez :

• Type d'autorisation (Auth Type) - API Key,

• Clé (Key) - « Authorization »

• Valeur (Value) - insérez votre valeur d'AuthToken ici,

• Ajouter à (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 ouvre 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 permettra d'utiliser l'adresse IP automatiquement ajoutée à votre demande (voir Intégration de serveur à serveur pour d'autres options),

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

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

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

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

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

• id est l'identifiant unique de votre ticket de matchmaking, conservez-le pour vérifier votre ticket ultérieurement,

• profile confirme le choix des Profils de Matchmaking,

• group_id est un identifiant 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é associé ni attribué à un serveur,

• created_at fournit des informations sur le moment où le ticket de joueur a été créé pour l'interface 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 associés et qu'un serveur soit démarré.

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

Saisissez l'identifiant du ticket figurant dans 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 est d'abord passé à MATCH_FOUND, tout en conservant assignment défini sur null pour indiquer que les joueurs ont été associés et qu'un serveur est en cours d'attribution,

Cliquez à nouveau sur Send pour vérifier votre ticket, et examinez 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 identifiants de tickets 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é vos 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 :

• au Client de jeu, pour gérer les Tickets de joueur,

• au Serveur de jeu, pour :

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

  • prendre en charge de manière facultative le Backfill afin d'ajouter ou de remplacer des joueurs après le démarrage.

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

• Edgegap - SDK de Matchmaking Unity Gen2,

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

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

  • télécharger le projet d'exemple 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 de service temporaire.

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 de matchmaking initiales des joueurs.

2. Lisez les Variables d'environnement injectées (Versions de l'application) 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 (Déploiement) pour obtenir des informations sur le déploiement, telles que l'adresse IP, l'emplacement, etc.

Une fois que les joueurs se connectent, 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 progresse.

Une fois les Clients de jeu entièrement 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 Backfill et la capacité des joueurs (ajouter ou remplacer les joueurs qui partent).

Assurez-vous que votre déploiement sera arrêté correctement à l'aide de l'élément DELETE_URL injecté, 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 tous les détails dans notre Centre d'apprentissage.