Skip to content

Commit

Permalink
add new cmd line argument to switch download location, can work with …
Browse files Browse the repository at this point in the history 
…local files with some preperation

change --filter to also delete failed matches so --filter '*' resets everything

Update version
  • Loading branch information
@i30817
i30817 committed Jun 4, 2023
1 parent 3df6a86 commit 621b4ed
Show file tree
Hide file tree
Showing 5 changed files with 82 additions and 70 deletions.
73 changes: 30 additions & 43 deletions README.rst
View file
Original file line number Diff line number Diff line change
@@ -1,23 +1,25 @@
**Fuzzy Retroarch thumbnail downloader**
========================================

In Retroarch, when you use the manual scanner to get non-standard games or hacks in playlists, thumbnails often fail to download.
In Retroarch, when you use the manual scanner to get nonstandard games or hacks in playlists, thumbnails often fail to download.

These programs, for each game label on a playlist, download the most similar named image to display in retroarch.

There are several options to fit unusual labels and increase fuzziness, but you can just run them to get the most restrictive default (with the least fuzz).

If you use ``libretro-fuzz``, it will download for a single playlist by asking for the playlist and system if they're not provided.
If you use ``libretro-fuzzall``, it will dowload for all playlists with standard libretro names, and will skip custom playlists.
If you use ``libretro-fuzzall``, it will download for all playlists with standard libretro names, and will skip custom playlists.

Besides those differences, if no retroarch.cfg is provided, both programs try to use the default retroarch.cfg.

If `chafa <https://github.com/hpjansson/chafa>`_ is installed, the program will display new thumbnails of a game, with grey border for images already in use and with green border for new images. Chafa works better with a recent release and on a `sixel <https://en.wikipedia.org/wiki/Sixel>`_ or `kitty <https://sw.kovidgoyal.net/kitty/graphics-protocol/>`_ compatible shell.
If `chafa <https://github.com/hpjansson/chafa>`_ is installed, the program will display new thumbnails of a game, with gray border for images already in use and with green border for new images. Chafa works better with a recent release and on a `sixel <https://en.wikipedia.org/wiki/Sixel>`_ or `kitty <https://sw.kovidgoyal.net/kitty/graphics-protocol/>`_ compatible shell.

Example:
``libretro-fuzz --no-subtitle --before '_'``
| ``libretro-fuzz --system 'Commodore - Amiga' --before '_'``
| then
| ``libretro-fuzz --system 'Commodore - Amiga' --no-subtitle --before '_'``
The Retroplay WHDLoad set has labels like ``MonkeyIsland2_v1.3_0020`` after a manual scan. These labels don't have subtitles and all the metadata is not separated from the name by brackets. Select the playlist that contains those whdloads and the system name ``Commodore - Amiga`` to download from the libretro amiga thumbnails.
The Retroplay WHDLoad set has labels like ``MonkeyIsland2_v1.3_0020`` after a manual scan. These labels *often* don't have subtitles (but not always) and all the metadata is not separated from the name by brackets. Select the playlist that contains those whdloads to download from the libretro amiga thumbnails.

Note that the system name you download from doesn't have to be the same as the playlist name.

Expand All @@ -29,14 +31,14 @@ Example:
After downloading ``ScummVM`` thumbnails (and not before, to minimize false positives), we'd like to try to pickup a few covers from ``DOS`` thumbnails and skip download if there a risk of mixing thumbnails from ``DOS`` and ``ScummVM`` for a single game.
Choose the ScummVM playlist and DOS system name, and covers would be downloaded with risk of false positives: CD vs floppy covers, USA vs Japan covers, or another platform vs DOS.

Because of this increased risk of false positives with options, the default is to count everything except hack metadata as part of the match, and the default pre-selected system name to be the same as the playlist name, which is safest.
Because of this increased risk of false positives with options, the default is to count everything except hack metadata as part of the match, only select the names that match exactly (after 'safe' heuristics like removing spaces) and the default pre-selected system name to be the same as the playlist name, which is safest.

False positives will then mostly be from the thumbnail server not having a single thumbnail of the game, and the program selecting the best match it can which is still good enough to pass the similarity test. Common false positives from this are sequels or prequels, or different releases, most often regions/languages.
False positives will then be from using ``--score`` (allows inexact matches) or/and one of the commands that do not count metadata (``--before``, ``--no-meta`` and ``--no-subtitle``). A common scenario is the thumbnail server not having a single thumbnail of the game, and the program selecting the best match it can which is still good enough to pass, like a sequel, prequel, or different release, most often regions/languages. It's not recommended to use ``--score`` less than 100 without ``--filter`` to a specific game.

Example:
``libretro-fuzz --no-subtitle --before '_' --filter '[Ii]shar*'``
``libretro-fuzz --system 'Commodore - Amiga' --no-subtitle --before '_' --filter '[Ii]shar*'``

The best way to solve these issues is to upload the right cover to the respective libretro-thumbnail subproject with the correct name of the game variant. Then you can redownload just the updated thumbnails with a label, in this example, the Ishar series in the WHDLoad playlist.
The best way to solve these issues is to upload the right cover to the respective libretro-thumbnail subproject with the correct name of the game variant. Then you can redownload just the updated thumbnails with a label, in this example, because of ``--filter``, the Ishar series in the WHDLoad playlist would redownload.

libretro-fuzzall/libretro-fuzz [OPTIONS] [CFG]
:CFG: Path to the retroarch cfg file. If not default, asked from the user.
Expand All @@ -48,43 +50,28 @@ libretro-fuzzall/libretro-fuzz [OPTIONS] [CFG]
MacOS default: ``~/Library/Application Support/RetroArch/config/retroarch.cfg``

--playlist <NAME libretro-fuzz only>
Playlist name with labels used for thumbnail fuzzy
matching. If not provided, asked from the user.
Playlist name with labels used for thumbnail fuzzy matching. If not provided, asked from the user.
--system <NAME libretro-fuzz only>
Directory name in the server to download thumbnails.
If not provided, asked from the user.
--delay-after FLOAT Seconds after download to skip replacing thumbnails.
No-op with --no-image. [1<=x<=10]
--delay FLOAT Seconds to skip thumbnails download. [1<=x<=10]
--filter GLOB Restricts downloads to game labels globs - not paths -
in the playlist, can be used multiple times and
matches reset thumbnails, --filter '\*' downloads all.
--score FUZZ Download fuzz (less is more fuzz, 100 being average).
No-op with --no-fail. [default: 200; 0<=x<=200]
--no-fail Download any score. Equivalent to --score 0.
Directory name in the server to download thumbnails. If not provided, asked from the user.
--delay-after FLOAT | Seconds after download to skip replacing thumbnails. No-op with ``--no-image``.
| [1<=x<=10]
--delay FLOAT | Seconds to skip thumbnails download.
| [1<=x<=10]
--filter GLOB Restricts downloads to game labels globs - not paths - in the playlist, can be used multiple times and resets thumbnails, ``--filter '*'`` redownloads all.
--score FUZZ | Min fuzz, 0=no-fail, 100=average, 200≃equal,default. No-op with ``--no-fail``.
| [default: 200; 0<=x<=200]
--no-fail Download any score. Equivalent to ``--score 0``.
--no-image Don't show images even with chafa installed.
--no-merge Disables missing thumbnails download for a label if
there is at least one in cache to avoid mixing
thumbnails from different server directories on
repeated calls. No-op with --filter.
--no-subtitle Ignores text after last ' - ' or ': '. ':' can't occur
in server names, so if the server has 'Name\_
subtitle.png' and not 'Name - subtitle.png'
(uncommon), this option doesn't help.
--no-meta Ignores () delimited metadata and may cause false
positives. Forced with --before.
--hack Matches [] delimited metadata and may cause false
positives, Best used if the hack has thumbnails.
Ignored with --before.
--before TEXT Use only the part of the label before TEXT to match.
TEXT may not be inside of brackets of any kind, may
cause false positives but some labels do not have
traditional separators. Forces ignoring metadata.
--verbose Shows the failures, score and normalized local and
server names in output.
--no-merge Disables missing thumbnails download for a label if there is at least one in cache to avoid mixing thumbnails from different server directories on repeated calls. No-op with ``--filter``.
--no-subtitle Ignores text after last ``' - '`` or ``': '``. ``':'`` can't occur in server names, so if the server has ``'Name_subtitle.png'`` and not ``'Name - subtitle.png'`` (uncommon), this option doesn't help.
--no-meta Ignores () delimited metadata and may cause false positives. Forced with ``--before``.
--hack Matches [] delimited metadata and may cause false positives, Best used if the hack has thumbnails. Ignored with ``--before``.
--before TEXT Use only the part of the label before TEXT to match. TEXT may not be inside of brackets of any kind, may cause false positives but some labels do not have traditional separators. Forces ignoring metadata.
--address URL | URL with libretro-thumbnails server. For local files, git clone/unzip packs, run ``'python3 -m http.server'`` in parent dir, and use ``--address 'http://localhost:8000'``.
| [default: https://thumbnails.libretro.com]
--verbose Shows the failures, score and normalized local and server names in output.
--install-completion Install completion for the current shell.
--show-completion Show completion for the current shell, to copy it or
customize the installation.
--show-completion Show completion for the current shell, to copy it or customize the installation.
--help Show this message and exit.


Expand Down
2 changes: 1 addition & 1 deletion libretrofuzz/__init__.py
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = '2.8.6'
__version__ = '2.9.0'
Loading

0 comments on commit 621b4ed

Please sign in to comment.