v2 beta 8

Author: unexpectedpanda

changelog.md

@@ -1,3 +1,39 @@
+# 2.00.0 Beta 8
+
+* You can now drag and drop DAT files into the file list.
+* Retool now understands preproduction compilations when comparing against individual
+  titles.
+* When considering compilations, individual titles are now preferred over compilations
+  except in the following scenarios:
+
+  * The compilation has a higher priority primary region than the individual title (during
+    compilation comparisons, the _World_ and _USA_ regions are considered equivalent).
+  * The compilation has a higher priority primary language than the individual title.
+  * The individual title is set as lower priority than the compilation in the related
+    clone list.
+
+  Compilations are otherwise only included if they feature unique titles. This increases
+  duplicates in the output DAT, but is much better for patches, retro achievements, and
+  actually knowing which individual titles you have.
+* Compilation selection has been dramatically sped up.
+* If you overrode global settings for system languages but didn't specify any languages,
+  Retool used to fall back to the global language order and disable the system languages
+  override. This isn't what the label says: "an empty filter list includes all languages".
+  This behavior has been changed to match the label — when you override system
+  languages and leave an empty filter list, it first uses the implied language order from
+  the system regions, and if they're not available, the implied language order from the
+  global regions. In both cases, this is makes sure all languages are included.
+* The Python version check is now done earlier, and explains to the user the minimum
+  version required.
+* The CLI progress bar no longer shows if multiprocessing is disabled, to make debugging
+  with print and input statements easier.
+* Fixed a bug where compilations specified in a clone list broke user filter includes.
+* Fixed a bug where clone list priorities could be misassigned.
+* Fixed a bug where user-supplied regexes weren't validated for some patterns.
+* Fixed a bug where regex escapes for a title trace that were set in the GUI weren't
+  interpreted properly.
+* Polished up some rough areas of code, made some minor GUI tweaks.
+
 # 2.00.0 Beta 7
 
 * System languages are now filtering correctly again.

docs/changelog.md

@@ -5,6 +5,44 @@ hide:
 
 # Changelog
 
+
+## 2.00.0 Beta 8
+
+* You can now drag and drop DAT files into the file list.
+* Retool now understands preproduction compilations when comparing against individual
+  titles.
+* When considering compilations, individual titles are now preferred over compilations
+  except in the following scenarios:
+
+  * The compilation has a higher priority primary region than the individual title (during
+    compilation comparisons, the _World_ and _USA_ regions are considered equivalent).
+  * The compilation has a higher priority primary language than the individual title.
+  * The individual title is set as lower priority than the compilation in the related
+    clone list.
+
+  Compilations are otherwise only included if they feature unique titles. This increases
+  duplicates in the output DAT, but is much better for patches, retro achievements, and
+  actually knowing which individual titles you have.
+* Compilation selection has been dramatically sped up.
+* If you overrode global settings for system languages but didn't specify any languages,
+  Retool used to fall back to the global language order and disable the system languages
+  override. This isn't what the label says: "an empty filter list includes all languages".
+  This behavior has been changed to match the label — when you override system
+  languages and leave an empty filter list, it first uses the implied language order from
+  the system regions, and if they're not available, the implied language order from the
+  global regions. In both cases, this is makes sure all languages are included.
+* The Python version check is now done earlier, and explains to the user the minimum
+  version required.
+* The CLI progress bar no longer shows if multiprocessing is disabled, to make debugging
+  with print and input statements easier.
+* Fixed a bug where compilations specified in a clone list broke user filter includes.
+* Fixed a bug where clone list priorities could be misassigned.
+* Fixed a bug where user-supplied regexes weren't validated for some patterns.
+* Fixed a bug where regex escapes for a title trace that were set in the GUI weren't
+  interpreted properly.
+* Polished up some rough areas of code, made some minor GUI tweaks.
+
+
 ## 2.00.0 Beta 7
 
 * System languages are now filtering correctly again.

docs/contribute-clone-lists.md

@@ -222,17 +222,20 @@ An `overrides` array looks similar to the following example:
   {
     "searchTerm": "Mobile Suit Gundam - Version 2.0 (.*)",
     "nameType": "regex",// (4)!
-    "newGroup": "Mobile Suit Gundam - Version 2.0"
+    "newGroup": "Mobile Suit Gundam Veetwo"// (5)!
   }
 ]
 ```
 
 1.  The overrides array.
 2.  The search term used when looking for a title in an input DAT file.
 3.  The new group and short name to assign to the title, if it's found in an input DAT
-    file.
+    file. This isn't the literal group name that is assigned, Retool takes this as a
+    base and then changes it based on its naming rules.
 4.  What name type the search term is, so Retool can match it accurately against names in
     the input DAT file.
+5.  Don't put version strings or strings in parentheses in `newGroup` values, as they are
+    stripped.
 
 Each object in the `overrides` array can include the following keys:
 
@@ -277,7 +280,7 @@ A `condition` looks similar to the following example:
   {
     "searchTerm": "Tomb Raider III - (Adventures of|Les Aventures de) Lara Croft \\((Europe|France|Germany|Italy|Spain|USA)\\)(.*)?",
     "nameType": "regex",
-    "newGroup": "Tomb Raider III - Adventures of Lara Croft (Disc 2) (International Version)",
+    "newGroup": "Tomb Raider III - Adventures of Lara Croft Disc 2 International Version",
     "condition": {// (1)!
         "regionOrder": {// (2)!
             "higherRegions": ["Japan", "Asia"],// (3)!
@@ -719,10 +722,32 @@ German discs are chosen instead.
 
 #### Example: working with compilations
 
-Retool automatically considers individual titles and compilations that are related, and
-chooses the solution that results in the fewest duplicate titles (and therefore lowest
-storage requirement). Compilations in a `variants` array are handled in a similar way
-to the following example:
+Individual titles and compilations have their relationships defined in clone lists. When
+Retool considers these titles and looks to deduplicate, it chooses a solution that
+results in as many individual titles as possible being selected. This is because [patches](https://www.romhacking.net/)
+and [retro achievements](https://retroachievements.org/) tend to only be available for
+individual titles, and compilation filenames often don't tell you what titles they
+contain, making your collection less browsable.
+
+This method results in some duplicates being left in the output. For example, when Retool
+analyzes the following titles:
+
+* _Title A (USA)_
+* _Title B (USA)_
+* _Title A + Title C (USA)_
+
+It includes them all in the output, despite that not being the most optimal space saving
+solution (which would remove _Title A (USA)_). This is because when comparing the
+following titles:
+
+* _Title A (USA)_
+* _Title A + Title C (USA)_
+
+_Title A (USA)_ wins for the _Title A_ selection as it's an individual title (and
+preferred over compilation versions), and _Title A + Title C (USA)_ wins for _Title C_
+as that title is only contained in the compilation, a standalone variation doesn't exist.
+
+Compilations in a `variants` array are handled in a similar way to the following example:
 
 ```json
 "variants": [
@@ -771,8 +796,21 @@ USA
 Europe
 ```
 
-Then Retool selects _3-D Ultra Pinball & Trophy Bass (USA)_ as the 1G1R title, as that
-solution is the one with the least duplication.
+Then Retool selects _3-D Ultra Pinball & Trophy Bass (USA)_ as the single 1G1R title for
+both _3-D Ultra Pinball_ and _Trophy Bass_, as that solution includes the USA version of
+the titles, and the least duplication.
+
+However, if a user selects the following region order:
+
+```
+Europe
+USA
+```
+
+Then Retool selects _3-D Ultra Pinball (Europe)_ for _3-D Ultra Pinball_ as it's an
+individual title in a preferred region, while _3-D Ultra Pinball & Trophy Bass (USA)_ is
+chosen for _Trophy Bass_ as a standalone version of that title doesn't exist, and the
+compilation is the only remaining option.
 
 #### Example: working with priorities
 
@@ -955,9 +993,8 @@ Then the following happens with the compilations:
     * Ultimately _Example Title (USA)_ and _Example Title 2 - Special Edition (USA)_
       become the 1G1R titles, and _Example Title 1 & 2 (Europe)_ is discarded.
 
-!!! note
-    Superset priority is compared directly against compilation priority, just like title
-    priority is.
+Superset priorities are compared directly against compilation priorities, just like title
+priorities are.
 
 ## Format clone lists
 

docs/download.md

@@ -17,7 +17,7 @@ How you download and install Retool will depend on your level of comfort with co
     If you're upgrading from v1, don't overwrite the contents of the v1 folder with v2.
     Instead, start fresh with an empty folder.
 
-=== ":simple-windows: Windows binary"
+=== ":simple-windows: Windows binary (GUI only)"
     If you're a Windows user and want the easiest path, you can get Retool going in a few
     easy steps:
 
@@ -41,7 +41,7 @@ How you download and install Retool will depend on your level of comfort with co
         false positive. If the SHA256 of the downloaded ZIP matches the checksum on this
         page, you're likely safe to mark an exception in your anti-virus software.
 
-=== ":simple-python: Git and Python"
+=== ":simple-python: Git and Python (GUI and CLI)"
     If you're more comfortable with the command line, or are running on a non-Windows
     platform, then this option is for you.
 

docs/includes/file.md

@@ -1 +1 @@
-[retool-2.00.0-beta-7-win-x86-64.zip](https://unexpectedpanda.github.io/files/retool-2.00.0-beta-7-win-x86-64.zip)
+[retool-2.00.0-beta-8-win-x86-64.zip](https://unexpectedpanda.github.io/files/retool-2.00.0-beta-8-win-x86-64.zip)

docs/includes/sha256.md

@@ -1 +1 @@
-3426f0ab55738164476c77924145cd8c74b0b6f3b4cf57798becf1829b5a0dd3
+bb71fc1fb1277d35e0566dee044f8b81edd15242437c95162298c3cc1325bbdc

docs/naming-system.md

@@ -48,7 +48,7 @@ this is a title
 Group names are derived from three places:
 
 * The full name of a title (default).
-* `group` values in the [`renames`](../contribute-clone-lists/#renames) array in
+* `group` values in the [`variants`](../contribute-clone-lists/#variants) array in
   a clone list.
 * `newGroup` or `elseGroup` values in the [`overrides`](../contribute-clone-lists/#overrides)
   array in a clone list.

docs/retool-1g1r.md

@@ -167,6 +167,4 @@ makes use of scraped data from Redump and No-Intro's websites to provide additio
 language details not present in title names.
 
 Finally, it can treat languages as both a filter _and_ something that should have higher
-priority than regions, although you can absolutely prioritize regions if you desire.
-
-Want to know more? Find out how [Retool works](../how-retool-works).
+priority than regions, although you can absolutely prioritize regions if you desire.