NOTE: If you are getting VIGEM_ERROR_BUS_NOT_FOUND error, install ViGEmBus
- Related issue: #113
Notes
- Once the scan has started, do not move your mouse cursor. Character scan is especially sensitive to mouse movement, and even the slightest table bump will result in the game exiting the analog controller mode.
- SPD substats have a hidden decimal place that the scanner cannot directly parse. As a result, reproducing your character's stats (such as on optimizer websites) will most likely have a lower SPD stat than what it displays in-game. This is not an issue with the scanner, but rather a limitation when obtaining substats through OCR.
- HDR should be off to ensure OCR accuracy.
- Certain dual monitor configurations can cause screenshots to capture incorrectly. If this is the case, try moving HSR to a different monitor before retrying the scan. In very rare cases, you may need to disconnect all external monitors.
- Tested on 1920x1080 resolution. I don't have every light cone or character with their traces unlocked to test (in fact, i don't even play the game anymore. i'm just maintaining this for yall), so if something isn't being recorded properly such as a certain character's traces, let me know by creating an issue.
New changes
- 4.7 compatibility: Updated game data and capture coordinates for version 4.7, including new relic sets, light cones, and characters.
- Affinitive Eidolons: Characters with Affinitive Eidolons now export
affinitive_eidolons, a list of activated Affinitive Eidolon IDs (for example,[130801]for Acheron). The list is empty when the character has an Affinitive Eidolon but has not activated it, and the field is omitted for characters without one (#124). - Faster scans: Relic scans are about 4.2x faster with batched and streamed OCR, mss capture, and adaptive panel polling. A full scan of a 2,808-relic inventory dropped from about 13m53s to about 3m18s. Tesseract now runs at below-normal priority so OCR does not compete with the game. Thanks @EnderSyth (#118, #122).
- New scanner settings: Added an OCR batch size slider, plus debug toggles for saving capture PNGs and verbose event logging.
- Capture diagnostics: Debug mode now records per-capture timing, panel-wait histograms, and overlap evidence for troubleshooting.
- Smaller executable: Reduced the packaged executable size by about 35 MB.
Fixes
- Relic scan correctness: Added relic lock detection, duplicate stats-panel capture recovery, relic level crop fixes, fuzzy name/mainstat/substat recognition, mainstat/slot and substat-roll validation. Thanks @EnderSyth (#118).
- 4.7 inventory navigation: Fixed inventory traversal (#123).
For known bugs or errors, please refer to the issues page.
Instructions
- Set game text language to English.
- Set in-game resolution to one that has an aspect ratio of 16:9 (e.g. 1920x1080, 1280x720).
- In Star Rail, look away from any bright colours. Yes, really. The inventory screen is translucent and bright colours can bleed through to make the text harder to accurately detect and recognize. Looking towards the ground usually works in most cases, as long as the right side of the screen is relatively dark. (Double-check by opening the inventory page and see if the item info on the right contrasts well with the background.) You can skip this step if you're only scanning characters.
- Open the cellphone menu (ESC menu).
- Configure the necessary scanner settings in HSR Scanner.
- Start the scan.
- Do not move your mouse during the scan process.
- Once the scan is complete, some additional time may be required to process the data before generating the final JSON file output.
As of v0.3.0, the app's database is updated separately from this repo. If the database version doesn't match the latest game version, then the repo hasn't been updated yet and you will need to wait :)
Light cone data includes:
- Name
- Level
- Ascension
- Superimposition
- Character that it is currently equipped on
- Locked
Relic data includes:
- Set name
- Slot (Head, hands, body, feet, etc.)
- Rarity
- Main stat
- Substats
- Character that it is currently equipped on
- Locked
- Discarded
Character data includes:
- Name
- Level
- Ascension
- Eidolon
- Affinitive Eidolon (if applicable)
- Skill levels
- Memosprite levels
- Traces unlocked
HSR-Scanner is not affiliated with, endorsed, sponsored, or approved by HoYoverse.