Romsearch

==================

Features
--------

- Added Nintendo - Game Boy
- Initial support for RetroAchievements (RAHasher), to choose ROMs that match RA hashes
- Added Nintendo - Game Boy Color

Fixes
-----

DATParser
~~~~~~~~~

- Ensure we pick up the right dat file if names are similar
- Return dat dict directly from ``run``

DupeParser
~~~~~~~~~~

- Return dupe dict directly from ``run``

ROMChooser
~~~~~~~~~~

- Added in scoring if ROM has associated RA achievements
- Overhauled the ROMChoosing. Is now clearer with filters and then scores
- Fixed issue with ordering versions for scoring

ROMDownloader
~~~~~~~~~~~~~

- Fixed crash if file does not exist on remote

ROMMover
~~~~~~~~

- Include patch info in cache file

ROMParser
~~~~~~~~~

- Add parsing for RetroAchievement-supported ROMs
- Parse checksums out of dat files
- Can take dat and dupe dicts directly, to avoid file I/O

ROMSearch
~~~~~~~~~

- Return dat and dupe dicts to save file I/O

General
~~~~~~~

- Bump to 0.0.8
- Build RTDs on PRs

==================

Features
--------

Tests
~~~~~

- Added in initial unit tests for ROMParser and ROMChooser

Fixes
-----

DATParser
~~~~~~~~~

- Logging tidied up to make more readable

DupeParser
~~~~~~~~~~

- Logging tidied up to make more readable

GameFinder
~~~~~~~~~~

- Logging tidied up to make more readable

ROMChooser
~~~~~~~~~~

- Logging significantly improved to make it clear which ROMs have been excluded and why
- Fixed crash when a revision is just labelled "rev"
- Fixed bug where a version like "v.0.1" would cause a crash
- Fixed bug where letter at end of version could cause a crash
- Fixed bug where lettered version could cause a crash
- Fixed bugs with flagging and removing various editions

ROMDownloader
~~~~~~~~~~~~~

- Logging tidied up to make more readable

ROMMover
~~~~~~~~

- Logging tidied up to make more readable

ROMParser
~~~~~~~~~

- ROMParser will now correctly parse multiple regions/languages
- Logging tidied up to make more readable

ROMSearch
~~~~~~~~~

- Logging tidied up to make more readable

General
~~~~~~~

- Bump to 0.0.7
- Due to changes to the re module, ROMSearch requires python>=3.11
- Allowed specifying log level in the config file

==================

Fixes
-----

ROMChooser
~~~~~~~~~~

- Language priorities are now baked into the ROM selection. ROMs with more (and higher priority) languages
will now be preferred

ROMDownloader
~~~~~~~~~~~~~

- Added a ``use_absolute_url`` option, which if False will strip the leading slash from the directories. This is
potentially useful if using an HTTP remote
- rclone can now either sync or copy. It'll use sync if completionist mode is on, else it'll use copy which is
a little cleaner
- If there are errors in the rclone command, ROMDownloader will now retry a few times
- Improved how rclone runs, to be less verbose and hopefully more reliable

ROMParser
~~~~~~~~~

- If no language is given in the ROM data, will attempt to pull this out from the region

General
~~~~~~~

- Updated dev tools for the new config directory structure
- Renamed `ftp_dir` to `dir` ion platform config files for clarity
- Fixed error message in GUI in includes/excludes existed for an unchecked platform

==================

Features
--------

- ROMSearch now has a GUI! This currently is just used for a more friendly way to set the config file, but will
be built out in the future
- ROMSearch now has two modes: the first is `filter_then_download` (default), which will use the dat file to filter,
then only download relevant files. The second is `download_then_filter`, which will download everything and then
filter. For data hoarders!

Fixes
-----

GameFinder
~~~~~~~~~~

- Ensure includes/excludes works the same as it does for ROMDownloader
- Includes/excludes will now search dupes as well, for consistency

ROMDownloader
~~~~~~~~~~~~~

- Ensure output directory exists before downloading files

General
~~~~~~~

- Updates to .github workflows and templates
- `bool_filters` in the config file is now `dat_filters` for clarity
- Overhauled directory handling in the config file
- ROMSearch now has more clearly defined options
- Exposed log directory and cache directory
- Overhauled logging system to avoid unnecessary file bloat and I/O. Speed ups of about a factor 3
- Overhauled how config files are read in to avoid unneccesary I/O. Speed ups of about a factor 2

==================

Features
--------

- Added Sony - PlayStation Portable

Fixes
-----

ROMChooser
~~~~~~~~~~

- Added regex terms for PSP
- Fixed a bug with version scoring

Util
~~~~

- Added feature to flag up tags but not remove them from the short name (e.g. "Demo" should be included in the name,
but should be used to flag up demo ROMs)

==================

Features
--------

- Added Sony - PlayStation 2

Fixes
-----

Configs
~~~~~~~

- Included dash between disc and number/letter for disc matching
- Added specific regex options for PS2