​

Déploiement local et débogage de l’exemple de projet ThirdPersonMP

​

Objectifs

• Tester les options de déploiement local du projet ThirdPersonMP+GSDK.
• Vérifier que votre serveur s’exécute correctement lorsqu’il est lancé à l’aide de LocalMultiplayerAgent
• Vérifier que vous pouvez attacher un débogueur à votre instance de serveur

​

Exigences

• Téléchargez Visual Studio. La version Community est gratuite.
  • Charges de travail requises : Développement .NET Desktop et Développement Desktop en C++
• Téléchargez le code source d’Unreal Engine. Pour obtenir des instructions, consultez Downloading Unreal Engine Source code (externe).
• Un projet Unreal finalisé dans lequel le GSDK Unreal PlayFab est installé et configuré
• La configuration “Development Server” de votre projet, générée depuis Visual Studio
• [Facultatif] Téléchargez LocalMultiplayerAgent
  • [Facultatif] Vous pouvez également télécharger le code source de LocalMultiplayerAgent.
• La configuration “Debug” ou “Release” de LocalMultiplayerAgent, générée à partir de ce référentiel avec Visual Studio
  • Dans Visual Studio, ouvrez MpsAgent.sln, sélectionnez la configuration Debug ou Release, puis générez LocalMultiplayerAgent.
• [Facultatif] Installez Docker pour Windows

​

Notation

• {depot}/ThirdPersonMP
• {depot}/MpsAgent
• [Facultatif] {depot}/gsdk [contient le plug-in PlayFab Unreal GSDK précédemment installé dans ThirdPersonMP]
• [Facultatif] {depot}/UnrealMarketplacePlugin [contient le plug-in PlayFab de la Marketplace Unreal, qui n’est pas requis pour ce guide, mais qui l’est pour la plupart des fonctionnalités de PlayFab]

​

Instructions

​

Exécution locale, sans conteneurs

{
  "RunContainer": false,
  "OutputFolder": "<Local absolute path that will be used to store the required output artifacts>",
  ...
  "AssetDetails": [
    {
      "MountPath": "C:\\Assets",
      "LocalFilePath": "{PATH-TO-ZIP}"
    }
  ],
  ...
  "PortMappingsList": [
    [
      {
        "NodePort": 30000,
        "GamePort": {
          "Name": "gameport",
          "Number": 8888,
          "Protocol": "UDP"
        }
      }
    ]
  ],
  "ProcessStartParameters": {
    "StartGameCommand": "{PATH-TO-EXE} -log"
  },
  "ContainerStartParameters": {
    "StartGameCommand": "C:\\Assets\\ThirdPersonMPServer.exe -log",
    ...
  }
}

• RunContainer : pour ce guide, cette valeur est toujours false. La définir sur true nécessite Docker.
  • Lorsque cette valeur est true, ProcessStartParameters/StartGameCommand est ignoré et ContainerStartParameters/StartGameCommand est utilisé à la place
  • Lorsque cette valeur est true, tout est généré et exécuté dans un conteneur Docker plutôt que dans le contexte de la machine locale
  • Ce guide couvre le scénario où RunContainer est false, afin de pouvoir déboguer plus facilement le processus du serveur
  • La définition de cette valeur sur true nécessite une build Shipping Server, ainsi que Docker pour Windows
• OutputFolder : "<Local absolute path that will be used to store the required output artifacts>"
  • Cet emplacement doit être entièrement défini, et un répertoire valide doit exister à cet emplacement.
• AssetDetails/LocalFilePath : {PATH-TO-ZIP}
  • Cet emplacement doit être entièrement défini, et un fichier zip valide doit exister à cet emplacement
  • Ce fichier zip doit contenir une build “Shipping Server” entièrement construite
• PortMappingsList :
  • Il s’agit de l’équivalent, dans LocalMultiplayerAgent, de la définition du port dans Game Manager
  • Le plug-in GSDK est codé en dur pour rechercher un port nommé : gameport
  • La méthode SetDefaultServerHostPort du plug-in GSDK remplace en interne le port d’hébergement du serveur Unreal pour qu’il corresponde à ce port
  • Le plug-in GSDK n’utilise que le port nommé gameport, configuré dans PortMappingsList lors de l’utilisation de LocalMultiplayerAgent.
  • Ce json vous permet de tester localement le pilotage de ce numéro de port par MPS et garantit que votre plug-in GSDK le recevra correctement
• ContainerStartParameters/StartGameCommand : tant que RunContainer est false, ce champ n’est pas utilisé.
  • Lorsque RunContainer==true, il remplace ProcessStartParameters/StartGameCommand
  • Ce chemin est le chemin interne au conteneur Docker ; il correspond à AssetDetails/MountPath, suivi du chemin interne de l’exe dans votre fichier zip défini par AssetDetails/LocalFilePath
  • Pour cet exemple, il pourrait s’agir de : C:\\Assets\\ThirdPersonMPServer.exe -log
• ProcessStartParameters/StartGameCommand : cette commande correspond en pratique au chemin de votre exe, suivi des éventuels paramètres de ligne de commande utilisés pour démarrer votre serveur de jeu
  • -log est une commande Unreal qui demande au serveur de jeu d’enregistrer un journal d’exécution
  • {PATH-TO-EXE} peut prendre l’une des deux formes suivantes :
    • Un chemin absolu vers un exe de votre serveur de jeu (même un serveur de jeu de développement), suivi des éventuels paramètres de ligne de commande de votre serveur
      • Ce choix ignore le contenu du fichier zip et exécute à la place n’importe quel exe, à n’importe quel emplacement
      • Il s’agit d’une option de débogage local qui ne fonctionne que sur votre machine locale pour déboguer les builds de développement : elle ne vous aide pas à vérifier que votre fichier zip est prêt à être chargé sur MPS
      • Ce choix doit être utilisé pour tester un serveur de développement, adapté à l’attachement d’un débogueur VS
      • Pour cet exemple, il pourrait s’agir de : {depot}\\ThirdPersonMP\\Binaries\\Win64\\ThirdPersonMPServer.exe -log
      • Pour l’auteur, il s’agit de : M:\\depot\\GSDK\\ThirdPersonMPGSDK\\Binaries\\Win64\\ThirdPersonMPServer.exe -log
    • Un chemin relatif, qui doit indiquer le chemin relatif dans votre fichier zip permettant d’exécuter votre serveur
      • Il s’agit du flux de travail standard, qui reproduit le fonctionnement sur une instance cloud MPS
      • Ce choix doit être utilisé pour tester un serveur de distribution ; il permet de vérifier que votre zip est prêt à être chargé sur MPS
      • Pour cet exemple, il pourrait s’agir de : ThirdPersonMPServer.exe -log

​

Déboguer votre serveur

​

Résolution des problèmes

​

Nombreuses instances de ThirdPersonMPServer dans le Gestionnaire des tâches

​

LocalMultiplayerAgent lance deux instances de ThirdPersonMPServer

​

Étapes suivantes