Materials of the author «Heizer» 1

TestRunner checks the mod and displays various errors. It provides the test result as HTML and XML documents. Tests are structured into several modules/groups. The tool is also used by our QA for internal purposes (with an extended set of features).

Goals:

- Speed up the mod testing process by helping the modder identify and fix issues (before submitting to ModHub);
- Detect various errors and provide hints on how to fix them;
- Ensure compliance with ModHub rules;
- Improve performance and minimize the overall mod file size and memory usage.

Features:

- Checks if descVersion matches the current patch level;
- Checks for XML parsing errors;
- Warns about incorrectly exported DDS textures;
- Warns about missing or outdated files;
- Shows duplicate files (in the mod and in the base game);
- Provides information about shader issues that need to be fixed for console release;
- And much more.

All detected issues will be provided as an HTML document and an XML file. Example of HTML result:

Tool usage requirements
Farming Simulator 19 (min. version 1.7)
GIANTS Editor (min. version 8.2.2)
=> the editor must be correctly pointed to the game installation path
latest version of TestRunner (0.6.2)

Disclaimer

The tool is still in beta testing; some tests may show errors that do not exist (so-called "false positives"), especially "unused files" reported by the "ObsoleteFiles" module. Please report any cases where you believe the tool produces false positives. When submitting a bug report, include the testrunner log, result files (XML and HTML), and if possible, the mod itself (or its ModHub ID) so we can reproduce the issue.

After running the .bat file, a console window will open showing the current progress. If something goes wrong, an error message with a detailed description of the problem will be displayed. All results are also saved in "TestRunner.log". If requirements are met, the tool will start analyzing the mod. The command line will display some information about the current progress. If there is no "critical" message, it can be ignored.

GIANTS Editor will automatically open and close during the process. Note: depending on the mod size and hard drive speed, the process may take several minutes. When the testing process is complete, the command line will display the message "execution finished." XML and HTML files will be created in the same directory as TestRunner. Files are named after the tested mod's directory and contain the test result. The HTML file contains only all found errors (for each module), the XML contains all errors and more detailed (meta) information.

The generated HTML file will automatically open in your browser, where you can check if any errors were found in your mod. Errors are highlighted in red. Explanations are italicized. Instructions for fixing errors are colored green.