Notes
- 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
The introduction of adding alternate paths to existing characters means that the old way of using character names as the key is no longer unique without having to do "March 7thPreservation" or "March 7thHunt", which is not feasible in the long run. Switching from name-based keys to IDs assigned in the game data provides a more future-proof way of handling future additions of character variants. The name and path properties are kept to serve as metadata for developer or debugging purposes without having to lookup the mappings for ID to name. View example export
- Major Changes to Output Format:
- Incremented
version
from 3 to 4. - Light Cone:
- Added new
id
string which corresponds to the unique ID assigned to the light cone in the game's data - Renamed
key
->name
location
value now corresponds to character ID instead of character name- Renamed
_id
->_uid
- Added new
- Relic:
- Added new
set_id
string which corresponds to the unique ID assigned to the relic set in the game's data location
value now corresponds to character ID instead of character name- Renamed
set
->name
- Renamed
_id
->_uid
- Added new
- Character:
- Added
id
string which corresponds to the unique ID assigned to the character in the game's data - Renamed
key
->name
- Added
path
string for the path of the character
- Added
- Incremented
A convenient list of IDs can be found on fribbels hsr-optimizer.
Fixes
- None this release.
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
- Skill levels
- Traces unlocked
HSR-Scanner is not affiliated with, endorsed, sponsored, or approved by HoYoverse.