JMBeresford / retrom

A centralized game library/collection management service with a focus on emulation
GNU General Public License v3.0
563 stars 5 forks source link

Server: Add ability to ignore files and/or directories #123

Open jshackles opened 2 weeks ago

jshackles commented 2 weeks ago

It would be nice if there were an option in the server configuration that could ignore certain directories or files. I have one of my libraries stored on a Synology NAS, which has OS functions that create files called @eaDir when files are accessed - thus creating an "@eaDir" game entry in Retrom. Additionally, because I have the "Recycle Bin" functionality turned on, it creates a "#recycle" folder on this share, which gets picked up in Retrom as a game system. Lots of other systems and various software can create things like temp files, which users may want to flag the server to ignore.

I propose new (optional) parameters in the "content_directories" section of the config file. Something like

"content_directories": [ { "path": "/games", "storage_type": "MultiFileGame", "ignore": [ "@eaDir", "#recycle" ] } ],

would work great. There could also be fuzzy matching or regex matching if you needed it to be more flexible.

Thanks for your consideration.

JMBeresford commented 2 weeks ago

Yes I can see this being useful w/ glob patterns etc.

Note that if you delete a game entry via the client it will blacklist that path from subsequent scans. I understand that this needs to be done on a per-folder basis, but the best workaround for the time being.