Enhance output summary of converter run for debugging

[heinezen]

Required skills: Python

Difficulty: Easy

During a converter run, a bunch of intermediary objects are created in the processor stage, specifically AoE-like and API-like objects. These are used in the transformation from Genie Engine formats to openage formats (e.g. nyan).

The content and helper functions of the intermediary objects are used to map properties of the objects in the original game to properties in the openage API (e.g. a unit's ability). The motivation for having debug output for these objects is that this will help us detect semantic errors in the converter implementation. Because of the high number of objects in the game data, checking this during a live debug is very hard to do.

Debug output of a run contains a plaintext dump of the most relevant content and output of helper functions. We store it in a dedicated directory (assets/converted/debug) and distinguish between the runs by using timestamps for folder names. The debug output is separated by conversion stage (init, read, processor, export). A lot of stuff is already implemented (see here), but improving it can't hurt can it?

• Log the sound files that were requested for export but not found in the export stage here
• Execution time for each stage (read, conversion, export)

Further reading:

• Debug info service implementation
• Converter code
• Converter architecture
• Converter workflow

[fabiobarkoski]

Some PRs related to this issue were merged. If remain some work to do, can I try to work on this?

[heinezen]

@fabiobarkoski Totally. I've updated the issue with a few ideas.

[fabiobarkoski]

Thanks. If in some point I need help, is better ask here or on the matrix chat?

[heinezen]

@fabiobarkoski Both is fine. The chat is better for back and forth if you have technical issues but whatever you're more comfortable with usually works best :)