[Feature] Automatic gamelist.xml export after a successful platform scan

[ljsimin]

Romm alreday has functionality for exporting platform metadata to a ES-DE gamelist.xml file, available currently only via API enpoint POST gamelist/export?platform_ids=. This is very useful for future proofing library scans and avoiding slow scrapers, as the file can be scanned back by Romm, but lacks a way to be triggered by the user other than an API call.

My proposal is to add an option, for example in config.yaml, to automatically trigger the export upon a successful library scan. It is very fast compared to scan itself, and would allow to keep all exports up to date, for people that want it, without cluttering the UI.

[ItzCobaltboy]

Hi I'd like to take up this issue!

Can you tell me how to get started on the repo's codebase?

[gantoine]

@ItzCobaltboy checkout Option 1 in these instructions, and post in the development channel in discord if you have questions! https://github.com/rommapp/romm/blob/master/DEVELOPER_SETUP.md

[ItzCobaltboy]

Alright!

Looking into it.

If possible can someone point me to relevant files? Config parser and Library scanner?

[ItzCobaltboy]

@gantoine @ljsimin m getting an error for launching the dev compose

Error Details:
exec /entrypoint.sh: no such file or directory

even tho entrypoint.sh exists and gets copied, what may be the cause?

I have came up with quick fix solution...

Solution

Calling the GameListExporter immidiately after scan completes in periodic task ScanLibraryTask?. With configurable settings in config.yaml, namely ScheduleGameListExport (bool) and ScheduleGameListExportPath (path string). How does that sound?

Is there any other place I can implement the call to gamelist exporter?

[ItzCobaltboy]

Update!

I modified GameListExporter to function without requests if local-export is set to true. With this, i implemented a Configuration in config.xml gamelist.auto_export_on_scan, which makes backend export all gamelists after scanning platforms in scan_platforms()

However I am still stuck on dev setup and will open a PR after testing it

[gantoine]

what command(s) are you using to launch the docker container locally, and from which folder?

[ItzCobaltboy]

The same ones in same order as mentioned in developer setup guide, ran from root folder of repository (fork to be precise)