Releases: kel-z/HSR-Scanner
Releases · kel-z/HSR-Scanner
HSR Scanner v1.2.1
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
Refer to previous release for notes on recent major changes to output format.
Fixes
- Fix fatal error when trying to log character skill level parse failure. #98
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:
- Light Cone ID
- Name
- Level
- Ascension
- Superimposition
- Character ID that it is currently equipped on
- Locked
Relic data includes:
- Set ID
- Set name
- Slot (Head, hands, body, feet, etc.)
- Rarity
- Main stat
- Substats
- Character ID that it is currently equipped on
- Locked
- Discarded
Character data includes:
- Character ID
- Name
- Level
- Ascension
- Eidolon
- Skill levels
- Traces unlocked
HSR-Scanner is not affiliated with, endorsed, sponsored, or approved by HoYoverse.
HSR Scanner v1.2.0
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
versionfrom 3 to 4. - Light Cone:
- Added new
idstring which corresponds to the unique ID assigned to the light cone in the game's data - Renamed
key->name locationvalue now corresponds to character ID instead of character name- Renamed
_id->_uid
- Added new
- Relic:
- Added new
set_idstring which corresponds to the unique ID assigned to the relic set in the game's data locationvalue now corresponds to character ID instead of character name- Renamed
set->name - Renamed
_id->_uid
- Added new
- Character:
- Added
idstring which corresponds to the unique ID assigned to the character in the game's data - Renamed
key->name - Added
pathstring 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.
HSR Scanner v1.1.0
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
- Partial Relic Scan: Added a new scan option for scanning X most recently acquired relics.
Fixes
- Trailblazer Items: Fixed Trailblazer items not being equipped in the JSON output after v2.2 UI changes. #88
- Trace Level Parsing: Fixed trace level parsing fall-backs not working. #80
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.
HSR Scanner v1.1.0-pre.1
This is a pre-release build. Click here for the latest release instead.
Currently testing:
- Scan X most recent relics.
- Adjust pre-processing parameters for trace level screenshots. #80
HSR Scanner v1.0.0
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
- Minimum Character Level: Added a minimum character level filter to stop the character scan when it reaches a specified level.
- Better Completion Feedback: Scanner window will be brought to front after the screenshotting phase. Once the OCR process is done, the taskbar icon will flash and a notification sound will be played.
- Sort Substats: After scanning newly upgraded relics in the same session, substats will be sorted accordingly to keep it consistent with the ordering after HSR is relaunched.
Fixes
- v2.1 UI Changes: Updated scanner coordinates for v2.1 UI changes.
- 1366x768 Resolution: Allow 1366x768 resolution to proceed with scanning (Untested — there might be issues with navigation or scanning since it's not a true 16:9 resolution).
- TesseractError: Fixed an error with the TESSDATA_PREFIX env variable if it already exists on the system. #75
- NoneType Error: Catch rare NoneType error during template matching operations. Cause is still uncertain. #41
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.
HSR Scanner beta v0.6.2
(Mar 26, 2024, 2.1 update: Scanner currently doesn't work since UI elements were moved in the latest HSR update. A new release will be released soon to address these changes.)
Download HSR Scanner beta v0.6.2
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.
- 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
- JSON Output:
- New
metadatadictionary for account UID and variant of Trailblazer.uid: Int of length 9, ornullif user chooses not to include it (uid will not by included by default).trailblazer: EitherStelleorCaelus, determined automatically during the scan. Defaults toStelleif no Trailblazer was parsed during the scan (or previous scans).
- New
buildkey which contains a string for the version of HSR-Scanner that generated the output (i.e."v0.6.2").
- New
- Log: Added log levels, force scroll-down during scan, and save log to disk if debug mode is enabled.
- Hotkeys: Allow more possible assignable keys for inventory and character hotkeys (like F-keys). #67
Fixes
- Equipped Location: Fix certain characters being wrongly assigned to relics and light cones on 1600x900 resolution.
- Character Scan: Prevent character scan from parsing the previous character's name if the name field doesn't re-render fast enough when clicking to the next character. #49
- Character Count: Tweaked image processing parameters in Data Bank screen to hopefully parse the total character amount properly. #66
- Substat Parsing: Tweaked substat OCR parameters for better accuracy on lower resolutions.
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.
HSR Scanner beta v0.6.1
Download HSR Scanner beta v0.6.1
New changes
- Relic Output: Added new
discardattribute to relics. - Debug Mode by @LightArrowsEXE: When enabled, save images to disk while scanning.
Fixes
- Image Coordinates: Updated
locationandlockimage coordinates after v2.0 UI changes.
For known bugs or errors, please refer to the issues page.
Instructions
- 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 :)
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.
- 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.
Light cone data includes:
- Name
- Level
- Ascension
- Superimposition
- Character that it is currently equipped on
- Locked/unlocked
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.
Contributors
LightArrowsEXE
Assets 3
HSR Scanner beta v0.6.0
***(NOTE 2/5/2024): Star Rail v2.0 came with changes to the Relic stats details. location and lock will not output correctly. This will be fixed shortly in the next scanner release.
Download HSR Scanner beta v0.6.0
New changes
- Customizable Delay: Added two customizable delay options in the configure tab to fine-tune the scanning speed to their system's performance.
- Add navigation delay for navigating between different pages (inventory, character details, etc.)
- Add scan delay for clicking between individual items (relics, light cones, and characters).
Fixes
- OCR Tweaks: Updated image processing parameters for character count in the databank screen and relic level to improve consistency across lower resolutions.
- Minimum Relic Level Default: The default minimum relic level is now correctly set to 0 as originally intended.
- ESC Menu Exit Delay: Increased the base wait time after exiting the ESC menu.
- Window Detection: Fixed an issue where the scanner was not detecting the game window on some languages.
Known issues with this release
- Game resolution detection logic doesn't work correctly on some monitors #64
Instructions
- 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 :)
Notes
- 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.
Light cone data includes:
- Name
- Level
- Ascension
- Superimposition
- Character that it is currently equipped on
- Locked/unlocked
Relic data includes:
- Set name
- Slot (Head, hands, body, feet, etc.)
- Rarity
- Main stat
- Substats
- Character that it is currently equipped on
- Locked/unlocked
Character data includes:
- Name
- Level
- Ascension
- Eidolon
- Skill levels
- Traces unlocked
HSR-Scanner is not affiliated with, endorsed, sponsored, or approved by HoYoverse.
HSR Scanner beta v0.5.2
Download HSR Scanner beta v0.5.2
New changes
- Future Trailblazer Support: Refactor Trailblazer key logic to auto-update for future Trailblazer variants.
- More Logging: Added more log outputs.
- (Developer) SRO Export Format: Updated substat value percentage format from "xx.y" to "0.xxy".
- For Star Rail Optimizer (SRO) dev purposes. Otherwise, this format is currently unused as SRO is still in development.
Fixes
- Default item level: Fix scan ending early if item level fails to parse (since it defaults to the lowest level, which would've immediately failed any minimum level filters).
Known issues with this release
- On some combination of graphic setting and game resolution, the scanner will fail to template match Trailblazer which will crash the parser with a KeyError (since instead it would use the normal scan logic and scan the Trailblazer's name which would be the account name—which is not an in-game character name). #49
- Welt's icon incorrectly matches to Caelus (Preservation) consistently. #51 Patched 1/18/2024
- Relic levels can sometimes get scanned without the leading 1. #52
- Character scan fails on databank screen on lower resolutions. #55
Instructions
- 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 :)
Notes
- 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.
Light cone data includes:
- Name
- Level
- Ascension
- Superimposition
- Character that it is currently equipped on
- Locked/unlocked
Relic data includes:
- Set name
- Slot (Head, hands, body, feet, etc.)
- Rarity
- Main stat
- Sub-stats
- Character that it is currently equipped on
- Locked/unlocked
Character data includes:
- Name
- Level
- Ascension
- Eidolon
- Skill levels
- Traces unlocked
HSR-Scanner is not affiliated with, endorsed, sponsored, or approved by HoYoverse.
HSR Scanner beta v0.5.1
Download HSR Scanner beta v0.5.1
New changes
- Character Scanner: Implemented horizontal character scanner logic.
- This removes the animation delay every time the traces -> eidolon screen is opened for each character.
- (Developer) SRO Export Format: Added Star Rail Optimizer (SRO) format export option in Configure tab.
- For SRO dev purposes. Otherwise, this format is currently unused as SRO is still in development.
Fixes
- Validation Table: Updated some incorrect entries in substat value lookup table. #42
- Equipped Avatar Bug: Fixed an incorrect OpenCV enum value impacting the equipped icon reader. #43
- Even more substat value image coordinate adjustments since substat scanning on lower resolutions will forever be an ongoing issue: Pain.
Known issues with this release
- None reported so far.
Notes
- 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.
- For
Dan Heng • Imbibitor Lunae, the character•will appear as\u2022in 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\u2022as•when displaying or processing the JSON.
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/unlocked
Relic data includes:
- Set name
- Slot (Head, hands, body, feet, etc.)
- Rarity
- Main stat
- Sub-stats
- Character that it is currently equipped on
- Locked/unlocked
Character data includes:
- Name
- Level
- Ascension
- Eidolon
- Skill levels
- Traces unlocked
HSR-Scanner is not affiliated with, endorsed, sponsored, or approved by HoYoverse.