Merge pull request #77 from kel-z/dev

Release 2.1: sort substats, min character lvl, notify on complete

README.md

@@ -34,7 +34,7 @@ HSR Scanner has the following scan options:
 - Select whether to scan light cones, relics, and/or characters.
 - Include UID in the JSON file (disabled by default).
 - Set output location for the JSON file.
-- Filter light cones and relics based on a minimum rarity or level threshhold.
+- Filter light cones, relics, and characters based on a minimum rarity or level threshhold.
 
 If Star Rail lags on your system, the scanner might perform its inputs too fast for the game to respond or re-render in time. To work around this, there are two types of delays that can be increased in the configure tab:
 
@@ -55,6 +55,7 @@ The output is loosely based off of Genshin's `.GOOD` export format. I don't expe
 - If the Trailblazer variant was not determinable during the scan or previous scans, it will default to `Stelle`.
 - Flat substats and percentage substats are differentiated by an underscore suffix in the key.
   - Main stats will never have an underscore suffix.
+- Substats are sorted in the order of: `HP, ATK, DEF, HP%, ATK%, DEF%, SPD, CRIT Rate, CRIT DMG, Effect Hit Rate, Effect RES, Break Effect`. This ordering applies for every relic with the exception of newly upgraded relics, which gets fixed when the user logs out and logs back in. As a result, the scanner will automatically sort the substats before generating the output.
 - The `_id` value for light cones and relics is arbitrarily assigned during the scanning process. It is intended for easy lookup in case of any errors logged during the scan, for double-checking or manual correction purposes.
 - For `Dan Heng • Imbibitor Lunae`, the character `•` will appear as `\u2022` in the JSON output. This is the Unicode representation of the character and is a normal behaviour when special characters are included in JSON. Most modern environments will automatically render `\u2022` as `•` when displaying or processing the JSON.
 - For character traces, `ability_#` and `stat_#` are ordered by earliest availability (i.e. `stat_1` can be unlocked at Ascension 0, but `stat_2` requires Ascension 2).
@@ -67,7 +68,7 @@ Current output sample:
 ```JSON
 {
     "source": "HSR-Scanner",
-    "build": "v0.6.2",
+    "build": "v1.0.0",
     "version": 3,
     "metadata": {
         "uid": 601869216,