En Vedette FS22 - Outil TestRunner pour tester les mods et maps 0.7.0

Comme avec FS19, nous sommes heureux de fournir notre outil de test de mod mis à jour pour FS22.

TestRunner_public.exe

• vérifie un mod et affiche diverses erreurs et violations des directives ModHub
• fournit le résultat du test sous forme de document html et xml
• les tests sont structurés en plusieurs modules/groupes
• L’outil est également utilisé par notre service d’assurance qualité en interne (avec un ensemble de fonctionnalités étendu)

Buts

• accélérer le processus de test des mods en aidant le moddeur à identifier et à résoudre les problèmes (avant de les soumettre à ModHub)
• détecter diverses erreurs et fournir des conseils sur la façon de les corriger
• s’assurer que les directives ModHub sont respectées
• améliorer les performances et minimiser la taille globale des fichiers mod et l’utilisation de la mémoire

Principales caractéristiques / Ce

qu’il fait (exemples sélectionnés)

• vérifier si la descVersion correspond au niveau de correctif actuel
• vérifier les erreurs d’analyse xml
• avertir des textures dds mal exportées
• avertir des fichiers manquants ou obsolètes
• afficher les fichiers en double (dans le mod et dans le jeu de base)
• fournir des informations sur les problèmes de shader, qui doivent être résolus pour une version console
• et bien plus encore, pour des explications détaillées, voir la section « Cas de test »
• tous les problèmes détectés seront fournis sous la forme d’un document HTML et d’un fichier xml
  Exemple de résultat HTML

Conditions requises

pour l’utilisation de l’outil

• Farming Simulator 22 (min. version 1.2)
• GIANTS Editor (min. Version 9.0.2)
  => le chemin d’accès à l’installation du jeu doit être correctement défini dans l’éditeur
• dernière version de l' TestRunner (0.7.0)

Démenti

• l’outil est encore en état bêta, certains tests peuvent montrer
  des erreurs qui ne sont pas (appelées « faux positifs ») en particulier « fichiers inutilisés » signalés par le module « ObsoleteFiles »
• veuillez signaler tous les cas où vous pensez
  que l’outil génère des erreurs qui sont des faux positifs lors de la création d’un rapport de bogue, veuillez inclure le journal testrunner, les fichiers de résultats (xml et html) et si possible le mod lui-même (ou son identifiant sur le ModHub), afin que nous puissions reproduire le problème idéalement utiliser le projet « TestRunner » sur notre Bugtracker public pour signaler des bogues

Instructions / Comment

utiliser

1. faites glisser et déposez le répertoire d’un mod décompressé sur TestRunner_public.exe
   • remarque: le dossier du mod n’a pas besoin d’être dans le même répertoire que le TestRunner
   • une fenêtre de ligne de commande s’ouvrira affichant la progression actuelle
   • si quelque chose s’est mal passé, un message d’erreur s’affiche donnant des détails sur le problème, toutes les sorties sont également enregistrées dans le « TestRunner.log »
2. si les exigences sont remplies, l’outil commencera à analyser le mod
   • la ligne de commande affichera certaines informations sur la progression actuelle à moins qu’il n’y ait un message « critique », cela peut être ignoré
   • GIANTS Editor sera automatiquement ouvert et fermé pendant le processus
   • remarque: en fonction de la taille du mod et de la vitesse du disque dur, le processus peut prendre plusieurs minutes
3. lorsque le processus de test est terminé, le message « Exécution terminée » s’affiche à l’intérieur de la ligne de commande
   • un fichier xml et html sera généré dans le même répertoire que le TestRunner
   • les fichiers sont nommés d’après le nom de répertoire du mod testé et contiennent le résultat du test
     • le fichier html ne contient que toutes les erreurs trouvées (par module)
     • le xml contient toutes les erreurs et des (méta)informations plus détaillées
4. le fichier html généré sera automatiquement ouvert dans votre navigateur où vous pourrez vérifier si des erreurs ont été trouvées dans votre mod
   • les erreurs sont soulignées en rouge
   • les explications sont en italique
   • les instructions sur la façon de corriger les erreurs sont colorées en vert

Cas de test

Dans ce qui suit, les différents modules et leurs cas de test sont expliqués en détail.

Travaux en cours

• xml-file bien formé (seulement requis par le jeu dans une certaine mesure, mais devrait néanmoins être rempli)
• Module DXTCheck: assurez-vous que les fichiers dds utilisent les formats DXT corrects, suggérez la conversion en DXT1 si possible
• Module MipMapCheck: assurez-vous que les textures des objets 3D ont MipMaps, avertissez si la texture a une résolution trop faible
• Module TextureCheck: assurez-vous que les textures ont une résolution de 2^n
• Module I3DCheck: vérifier l’intégrité des références, les lumières/ caméras obsolètes, l’utilisation de textureArray
• Module ModDescCheck: vérifiez un ensemble de directives ModHub (descVersion, format de numéro de version, changelog, localisation, ...)
• Module VehicleCheck : s’assurer que des éléments xml spécifiques du véhicule sont présents (par exemple , « lavables ») ou absents (par exemple, « dailyUpkeep » dans les véhicules)
• Module SlotCheck: calculer le nombre estimé d’emplacements utilisés pour chaque article du magasin comme référence pour le moddeur
• Module ObsoleteFiles : liste des fichiers sources obsolètes non chargés par le jeu, liste des textures éventuellement inutilisées, liste des fichiers en double
• Module EditorCheck: chargez tous les fichiers i3d contenus dans le mod et vérifiez les erreurs
• Module ShaderCheckEditor : avertir si des shaders personnalisés sont présents dans le mod annulant la compatibilité de la console, déclencher des erreurs si des configurations de matériaux qui ne sont pas disponibles dans le cache du shader sont utilisées

Dépannage

• problème: l’installation du jeu est introuvable
  • raison: les outils vérifient l’emplacement d’installation par défaut et lisent l’emplacement à partir du registre, assurez-vous que vous n’avez pas déplacé le jeu après l’installation
  • solution : exécuter en cmd (voir les instructions ci-dessous) avec l’argument -g <pathToGameInstallation>pour définir manuellement le chemin d’accès

• problème : l’installation de l’éditeur est introuvable
  • outils recherche les éditeurs Giants installés dans giantsPackageRegistry xml situé dans appdata/local
  • solution : exécuter en cmd (voir les instructions ci-dessous) avec l’argument -p $FS 22_EDITOR$<pathToEditorExe>
• problème: le programme se ferme tout seul / se bloque
  • post/send TestRunner.log, si possible envoyer le mod testé dans un message privé
  • si possible, exécutez l’outil à partir de la ligne de commande et ajoutez « --verbose » comme argument et envoyez-nous le journal de cette façon, plus d’informations seront incluses dans le fichier journal et nous aideront avec le processus de débogage

Instructions d’utilisation avec la ligne

si vous devez effectuer des réglages supplémentaires (par exemple, si l'installation du jeu ne peut être trouvée automatiquement), vous pouvez exécuter l'outil à partir d'une ligne de commande

1. démarrer une ligne de commande ou une fenêtre powershell
   • Option A: cliquez sur la barre d’adresse de la fenêtre de l’explorateur Windows, tapez « cmd », appuyez sur Entrée cela ouvrira une ligne de commande dans le répertoire actuel de l’explorateur
   • Option B: maintenez la touche Maj enfoncée et cliquez avec le bouton droit de la souris sur l’arrière-plan de la fenêtre de l’explorateur, sélectionnez « Ouvrir la fenêtre de ligne de commande ici » ouvrez la fenêtre PowerShell ici, cela ouvrira une ligne de commande / powershell dans le répertoire actuel de l’explorateur.
   • Option C: Appuyez sur « Win » + « R », tapez « cmd » dans la boîte de dialogue, appuyez sur Entrée cela ouvrira une ligne de commande dans votre profil utilisateur = > naviguez jusqu’à l’emplacement du TestRunner_public.exe
2. tapez « TestRunner_public.exe » (« ./TestRunner_public.exe » for PowerShell)
3. appuyez sur l’espace et entrez le chemin d’accès à votre mod décompressé, par exemple « D:\mods\FS22_caseIHMagnum724Pro »
4. Facultatif : ajoutez des arguments supplémentaires si nécessaire/souhaité
5. appuyez sur entrée pour démarrer l’outil de test

Si vous trouvez des bugs, je vous suggère de les signaler sur notre Bugtracker public, car il est plus efficace de les gérer là-bas.

Nous attendons avec impatience vos commentaires et espérons que l’outil vous aidera à créer des mods et à les soumettre à ModHub.