Wie bereits für LS19 freuen wir uns, die für den LS22 angepasste Version unseres Mod-Testing Tools bereitzustellen.
TestRunner_public.exe
- überprüft Mods und zeigt verschiedene Fehler und Verletzungen der ModHub-Richtlinien auf
- liefert das Testergebnis als html- und XML-Dokument
- Tests sind in mehrere Module/Gruppen aufgeteilt
- das Werkzeug wird auch intern von unserer QA verwendet
Ziele
- das Testen von Mods zu beschleunigen, indem dem Modder geholfen wird, Probleme zu erkennen und zu beheben (bevor er seinen Mod ins ModHub einsendet)
- verschiedene Fehler erkennen und Hinweise zu deren Behebung geben
- sicherstellen, dass die ModHub-Richtlinien eingehalten werden
- Verbesserung der Performance und des Speicherverbrauchs im Spiel, sowie die Minimierung der Gesamtgröße des Mods
Hauptfunktionen / Was macht das Tool (ausgewählte Beispiele)
- prüfen, ob die descVersion dem aktuellen Patch-Level entspricht
- Prüfung auf XML-Parsing-Fehler
- warnen vor falsch exportierten dds-Texturen
- warnen vor fehlenden oder ungenutzten Dateien
- zeigt doppelte Dateien (innerhalb des Mods und im Basisspiel)
- liefern Informationen über Shader-Probleme, die für eine Konsolenversion behoben werden müssen
- und vieles mehr, für detaillierte Erklärungen siehe Abschnitt "Testfälle".
- alle gefundenen Probleme werden in Form eines HTML-Dokuments und einer XML-Datei zur Verfügung gestellt
Beispiel Ergebnis HTML
Voraussetzungen für die Verwendung des Tools
- Farming Simulator 22 (min. Version 1.8)
- GIANTS Editor (min. Version 9.0.3)
=> der Pfad zur Spielinstallation muss im Editor korrekt eingestellt sein - neuste Version des Farming Simulator 22 TestRunner (0.8.8)
Warnung: Beta-Status
- das Werkzeug befindet sich noch im Beta-Status, einige Tests könnten Fehler zeigen, die keine sind (so genannte "falsch positive")
insbesondere "unused files", die vom Modul "ObsoleteFiles" gemeldet werden - Bitte meldet alle Fälle, in denen das Tool Fehler ausgibt, die falsch positiv sind
Bei Fehlerberichten bitte das Testrunner-Protokoll, die Ergebnisdateien (XML und html) und wenn möglich den Mod selbst (oder dessen ID im ModHub) beilegen, damit wir das Problem reproduzieren können
Verwendet idealerweise das "TestRunner"-Projekt im public Bugtracker um Bugs zu melden
HowTo / Gebrauchsanweisung
- das Verzeichnis eines entpackten Mods auf TestRunner_public.exe ziehen (Drag and Drop)
- Anmerkung: der Ordner des Mods muss sich nicht im selben Verzeichnis wie der TestRunner befinden
- ein Befehlszeilenfenster öffnet sich, das den aktuellen Fortschritt anzeigt
- wenn etwas schief gelaufen ist, wird eine Fehlermeldung mit Einzelheiten zu dem Problem angezeigt
alle Ausgaben werden auch im "TestRunner.log" gespeichert
- Wenn die Anforderungen erfüllt sind (Spielinstallation, Editor, etc.), beginnt das Tool mit der Analyse des Mods
- die Befehlszeile zeigt einige Informationen über den aktuellen Fortschritt
wenn es keine "critical" Nachricht gibt, können die Informationen ignoriert werden - Der GIANTS-Editor wird während des Prozesses automatisch geöffnet und geschlossen
- Anmerkung: je nach Größe des Mods und der Geschwindigkeit der Festplatte kann der Vorgang mehrere Minuten dauern
- die Befehlszeile zeigt einige Informationen über den aktuellen Fortschritt
- Wenn der Testprozess beendet ist, wird die Meldung "Finished execution" in der Befehlszeile angezeigt.
- eine XML- und html-Datei wird im gleichen Verzeichnis wie der TestRunner erzeugt
- Dateien sind nach dem Verzeichnisnamen des getesteten Mods benannt und enthalten das Ergebnis des Tests
- html-Datei enthält ausschließlich gefundene Fehler (pro Modul)
- die XML-Datei enthält alle Fehler und weitere detailliertere (Meta-)Informationen
- die generierte html-Datei wird automatisch im Browser geöffnet, wo man überprüfen kann, ob Fehler im Mod gefunden wurden
- Fehler sind rot umrandet
- Erläuterungen sind in Kursivschrift dargestellt
- Anweisungen, wie Fehler korrigiert werden können, sind grün gefärbt
Testfälle und Erläuterungen
Im Folgenden werden die einzelnen Module und deren Testfälle im Detail erläutert
 | | |
| | |
| | |
Fehlerbehebung
- Problem: Spielinstallation kann nicht gefunden werden
- Grund: Das Tool überprüft den Standard-Installationspfad und liest den Pfad aus der Registry, stellt sicher, dass das Spiel nach der Installation nicht verschoben wurde
- Lösung: Cmd (siehe Anweisungen unten) mit dem Argument -g <pfadZurSpielinstallation> ausführen, um den Pfad manuell festzulegen
- Problem: Editor-Installation kann nicht gefunden werden
- Tool sucht nach installierten Giants-Editoren in giantsPackageRegistry XML, die sich in appdata/local befindet
- Lösung: Ausführen in Kommandozeile (siehe Anweisungen unten) mit dem Argument -p $FS22_EDITOR$ <pathToEditorExe>
- Problem: Programm schließt sich von selbst/stürzt ab
- TestRunner.log hier oder im Bugtracker posten, wenn möglich den getesteten Mod in einer privaten Nachricht an mich senden
- wenn möglich, das Tool in der Kommandozeile ausführen und --verbose als Argument hinzufügen und die TestRunner.log schicken
Auf diese Weise werden mehr Informationen in die Log-Datei aufgenommen und helfen uns beim Debugging-Prozess
Anweisungen zur Verwendung mit der Befehlszeile (cmd)
Um zusätzliche Einstellungen vorzunehmen (z.B. falls die Installation des Spiels kann nicht automatisch gefunden werden), kann das Tool mithilfe der Kommandozeile gestartet werden
- HowTo: ein Befehlszeilen- oder Power-Shell-Fenster starten
- Option A: Klicke auf die Adressleiste des Windows-Explorer-Fensters, gib "cmd" ein, drücke die Eingabetaste
Dies öffnet eine Kommandozeile im aktuellen Verzeichnis des Explorers (idealerweise im Verzeichnis der TestRunner_public.exe) - Option B: Halte die Umschalttaste gedrückt und klicke mit der rechten Maustaste auf den Hintergrund des Explorer-Fensters, wähle "Kommandozeilenfenster hier öffnen" oder "PowerShell-Fenster hier öffnen".
Dadurch wird eine Befehlszeile/Powershell im aktuellen Verzeichnis des Explorers geöffnet - Option C: Drücke "Win" + "R", gib "cmd" in den Dialog ein, drücke die Eingabetaste
Dadurch wird eine Befehlszeile im Benutzerprofil geöffnet
=> Navigiere zum Speicherort der Datei TestRunner_public.exe
- Option A: Klicke auf die Adressleiste des Windows-Explorer-Fensters, gib "cmd" ein, drücke die Eingabetaste
- Gebe "TestRunner_public.exe" ein ("./TestRunner_public.exe" bei PowerShell)
- Drücke die Leertaste und gib den Pfad zum entpackten Mod ein, z.B. "D:\mods\FS22_caseIHMagnum724Pro"
- Optional: zusätzliche Argumente hinzufügen, falls erforderlich/gewünscht
- Drücke die Eingabetaste, um den TestRunner zu starten
Wenn ihr Fehler findet am besten im public Bugtracker melden, da diese dort am Besten verwaltet werden können.
Wir freuen uns über euer Feedback und hoffen, dass euch das Tool dabei unterstützt Mods zu entwickeln und im ModHub zu veröffentlichen.
