Romsearch

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

Features
--------

- Added DATMapper, that can map ROM name changes between dat files
- Added ability to handle multi-disc files, using m3u files
- Added ROMBrowser, for easier searching and parsing of ROMs
- Added ROMCompressor, which can compress files into a different format

Fixes
-----

ROMChooser
~~~~~~~~~~

- Add option to exclude modern releases (off by default)

ROMCleaner
~~~~~~~~~~

- Significant cleanup to take account of new cache structure

ROMMover
~~~~~~~~

- Refactored to loop over entire platform
- Updated cache to include output directory and all files

General
~~~~~~~

- Bump to 0.2.0
- Added new "download names", that can map a ROM to a different name
- Fix crash when version formatted like 'v.21', and added test
- Updated regex to move Kickstarter, The Retro Room to modern versions
- Added "Red Art Games" and "Metal Gear Solid Collection" to modern versions in regex

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

Features
--------

- Added Mega Drive/Genesis
- Added Pokemon Mini
- Support for supersets
- Added N64

Fixes
-----

GameFinder
~~~~~~~~~~

- GameFinder can now pick up superset filters

ROMCleaner
~~~~~~~~~~

- Significant cleanup to be more robust

ROMParser
~~~~~~~~~

- ROMParser can now handle multi-group regex tags
- Handle English-friendly tags
- Significant cleanup in handling RetroAchievement hashes
- Ensure MD5 hash is lowercase from RetroAchievements

General
~~~~~~~

- Bump to 0.1.2
- Add logo and version in GUI
- Clean up potential errors if directory name ends with period
- regex cleanup
- Move clonelist from unexpectedpanda to Daeymon
- Updated RA name extensions
- Add ROMPatch method to (most) other consoles
- Updated regex
- Add more tests

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

Features
--------

- GameFinder has been significantly overhauled
- Normalise games with disc names in them
- Initial support for ``retool`` filters
- Includes initial support for ``retool`` compilations
- Added Game Boy Advance
- ROMPatcher now supports RomPatcher.js

Fixes
-----

DupeParser
~~~~~~~~~~

- Removed dat parsing, as this can cause issues. Now rely on ``retool`` filters

RAHasher
~~~~~~~~

- Increase sleep time to 0.5s to avoid API errors

ROMChooser
~~~~~~~~~~

- Fixed bug where versions weren't parsed correctly

ROMCleaner
~~~~~~~~~~

- Include cleaned cache in the Discord outputs
- Ensure we clear patched files out of cache

ROMParser
~~~~~~~~~

- ROMParser will now filter out RetroAchievements subsets, since they're hacks
- When checking for RAPatch matches, if the check is a list will simply check there's something in the list subset

ROMPatcher
~~~~~~~~~~

- Unquote patch URL before downloading

General
~~~~~~~

- Bump to 0.1.1
- Added known issue for long filenames
- RAPatch checks now includes modern/improved/demoted versions
- Language parsing can now handle languages formatted like "En+De" (and test updated)
- Updated regex
- Updated dev scripts

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

Features
--------

- Added ROMPatcher, which patches ROMs if necessary for RetroAchievements
- Added ROMCleaner, which will clean out deleted ROMs within the ROM directory

Fixes
-----

DupeParser
~~~~~~~~~~

- Return the actual retool dupes, so we can get categories out later
- Don't overwrite retool priority from parsing dat

ROMCleaner
~~~~~~~~~~

- Significantly overhauled to account for various edge cases

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

- Tidy logging for removed files

ROMMover
~~~~~~~~

- Check final final exists before moving

ROMParser
~~~~~~~~~

- Fixed bug where languages could be parsed wrongly
- Tidied up parsing RA hashes, and will now give up when multiple patch files are found

General
~~~~~~~

- Bump to 0.1.0
- Point GH Actions at main, rather than master
- Move to exact version pins for requirements
- Sort cache by name
- Ensure things are kept as strings throughout
- Included more regex
- Include explicit package versions
- Enable dependabot

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

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