Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/kel-z/HSR-Scanner
Browse files Browse the repository at this point in the history
  • Loading branch information
kel-z committed Jun 7, 2023
2 parents cc94814 + c944f0f commit df17c0e
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The output is loosely based off of Genshin's `.GOOD` export format. **Please not
- 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).
- In the case of ties, namely two stat bonuses *X* and *Y* that both unlock at the same Ascension level, the one that visually connects to the highest `stat_#` on the in-game character traces page comes first. For example, if a stat bonus *X* connects to `stat_2` and stat bonus *Y* connects to `stat_1`, then *X* would be `stat_3` and *Y* would be `stat_4`.
- If *X* and *Y* both connect to the same `stat_#` (only found in Erudition), then visually assign from top to bottom.
- The exact string values can be found in [game_data.py](src/utils/game_data.py).
- The exact string values used can be found [here](src/utils/game_data_helpers.py).

Current output sample:
```
Expand Down Expand Up @@ -171,4 +171,4 @@ Current output sample:
Check [sample_output.json](sample_output.json) for a full-sized, unfiltered example.

## Dev notes
- This app relies on reading text from images captured during the scan process, as opposed to reading directly from memory. As a result, OCR is prone to errors, especially given the variability of relic sub-stats and lack of a model optimized for Star Rail. It also doesn't help that the inventory screen is translucent, as mentioned in step two of [instructions](#instructions). This issue can be alleviated via error-checking in future releases once every possible sub-stat value is known and can be checked against.
- This app relies on reading text from images captured during the scan process, as opposed to reading directly from memory. As a result, OCR is prone to errors, especially given the variability of relic sub-stats and lack of a model optimized for Star Rail. It also doesn't help that the inventory screen is translucent, as mentioned in step two of [instructions](#instructions). This issue can be alleviated via error-checking in future releases once every possible sub-stat value is known and can be checked against.

0 comments on commit df17c0e

Please sign in to comment.