FAQ recommends Godot import plugin that is currently broken

[vibrant-reindeer]

Hi everyone! The FAQ currently says:

However, if you are interested in direct Pixelorama support from Godot, you can use this amazing Godot Pixelorama importer plugin which can be used to make Godot import pxo files.

However, the godot_pixelorama_importer plugin has not been working since the 1.0 release of Pixelorama where the file format was changed to ZIP. Even before that it had a bug where files were not included in the export. While there is a pending pull request to address both problems, the plugin's author has stated they are no longer in game development and that "it may take me a while to get to this".

The only other plugin with Pixelorama import I found is Importality but it seems it can't handle the new ZIP format either (nklbdev/godot-4-importality#34). Which is a shame since Importality has a lot of very nice features.

Maybe the FAQ should instead refer to the Command Line Interface page for semi-automated export to Godot, at least for now?

[vibrant-reindeer]

Update, short version: The current development version of Importality (https://github.com/nklbdev/godot-4-importality) works, although it requires "Include blended images" to be enabled if layers are used. So maybe this is the plugin the FAQ should mention?

Longer version:

I just tried the main branch of Importality, as opposed to the last release (0.3.0) which is over a year old by now. The main branch supports pxo_version=3 and thus the zip format. It also loads pxo_version=4 with the appropriate warning This project uses version 4 of the pxo file format, which is not currently supported by Importality. I'm not sure if there is a difference between v3 and v4 apart from blend modes but see the next paragraph for those.

Importality does not properly support blend modes (and thus layers), which is also acknowledged with a warning: The Pixelorama project [...] does not contain blended/precomposited frame images. Not all Pixelorama compositing features are supported by Importality, so frames may not look the way you expect unless you enable "Include blended images" in Pixelorama. If "Include blended images" is enabled for the project then the import seems to work.

[OverloadedOrama]

Thanks for opening the issue! The FAQ now recommends the Importality plugin, and I put a note about the "Include blended images" option. Feel free to re-open the issue if you have any more clarifications in mind for this.