Metadata-Version: 2.1
Name: libretrofuzz
Version: 2.9.4
Summary: Fuzzy Retroarch thumbnail downloader
Home-page: https://github.com/i30817/libretrofuzz
License: MIT
Author: i30817
Author-email: i30817@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: beautifulsoup4 (>=4.10.0,<5.0.0)
Requires-Dist: colorama (>=0.4.6,<0.5.0)
Requires-Dist: httpx (>=0.23.0,<0.24.0)
Requires-Dist: pillow (>=9.2.0,<10.0.0)
Requires-Dist: prompt_toolkit (>=3.0.30,<4.0.0)
Requires-Dist: questionary (>=1.10.0,<2.0.0)
Requires-Dist: rapidfuzz (>=2.4.2,<3.0.0)
Requires-Dist: regex (>=2023.6.3,<2024.0.0)
Requires-Dist: tqdm (>=4.65.0,<5.0.0)
Requires-Dist: typer[all] (>=0.5.0,<0.6.0)
Project-URL: Bug Tracker, https://github.com/i30817/libretrofuzz/issues
Project-URL: Repository, https://github.com/i30817/libretrofuzz
Project-URL: documentation, https://github.com/i30817/libretrofuzz#readme
Project-URL: homepage, https://github.com/i30817/libretrofuzz
Description-Content-Type: text/x-rst

**Fuzzy Retroarch thumbnail downloader**
========================================

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 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 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 --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 *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.

If the thumbnail server contains games from multiple releases for the system (like ``ScummVM``), be careful using extra options since it is easy to end up with 'slightly wrong' covers.

Example:
 ``libretro-fuzz --no-meta --no-merge``
 
 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, 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 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 --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, 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.
  
                        Linux default:   ``~/.config/retroarch/retroarch.cfg``
  
                        Windows default: ``%APPDATA%/RetroArch/retroarch.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.
  --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, enter continues. No-op with ``--no-image``.
                        | [1<=x<=30]
  --delay FLOAT         | Seconds to skip thumbnails download, enter continues.
                        | [1<=x<=30]
  --filter GLOB         Restricts downloads to game labels globs - not paths - in the playlist, can be used multiple times and resets thumbnails, ``--filter '*'`` redownloads all.
  --min SCORE           | 0=any, 100=fuzzy match, 200=equal mininames,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.
  --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 N           | Show mininame, len N list (maxscore, server mininame).
                        | [x>=1]
  --install-completion  Install completion for the current shell.
  --show-completion     Show completion for the current shell, to copy it or customize the installation.
  --help                Show this message and exit.



To install the program, type on the cmd line

+----------------+---------------------------------------------------------------------------------------------+
| Latest release | ``pip install --force-reinstall libretrofuzz``                                              |
+----------------+---------------------------------------------------------------------------------------------+
| Current code   | ``pip install --force-reinstall https://github.com/i30817/libretrofuzz/archive/master.zip`` |
+----------------+---------------------------------------------------------------------------------------------+

In windows, you'll want to check the option to “Add Python to PATH” when installing python, to be able to install and execute the script from any path of the cmd line.

