CloneHero Scoreboard

The problem

You're rocking out on Sweet Child o' Mine, and you're bringing the house down! You nail the solos, and reach the end. That's when you see it -

NEW HIGH SCORE!

So what are your options at this point? Well you can't export your high scores, but you can take a screenshot.

While lots of tools help you understand your performance while you're playing, there isn't a good way to view your data outside of the game aside from those screenshots. If only you could export them to a CSV and open them in a spreadsheet. Or even better, wouldn't it be great if you could just see your high scores appear in a Google Sheet?

The solution

CloneHero Scoreboard uses OCR to lift the text off of your screenshots, organizes your scores and stats for you, and can export them to a CSV and/or a Google Sheet!

How it works

When the script runs, it does the following -

1. Check the screenshot folder provided by the --img_dir flag for new .png images.
2. Make text stand out more.
   1. Remove yellow and blue color channels.
   2. Increase contrast.
   3. Convert each image to black and white.
3. Try lifting the text off of the black/white image. Check 3 different ways, and do nothing if no score can be found / determined.
4. If the score is found, try to get other stats as well.
5. Check if there is an existing score for the song.
6. If there is an existing song, compare the scores to make sure the new score is better.
7. Update the CSV and/or Google Sheet if the new score is in fact the better score.
8. [OPTIONAL] - Delete the screenshots that were successfully processed.
9. [OPTIONAL] - Delete all screenshots that were found.

Installation

Requirements

• Python 3.9.1 (The latest release as of this writing)
• Tesseract
• [Optional] Google Cloud Service Account (for exporting directly to a Google Sheet) (Instructions here)

Instructions

1. Clone this repo
2. Run python3 setup.py install
3. Back up your screenshot directory
4. Run the script

For example:

python3 scoreboard.py --img_dir=/path/to/clonehero/screenshots --google_sheet="My CloneHero High Scores" --remove_captured

Advanced usage

As shown in the example above, the script supports multiple flags. To see all available flags, run -

python3 scoreboard.py --help

The script can also be added to a crontab or scheduled task to run every so often. How does one do this?

• Linux Crontab
• Windows Scheduler

FAQ

• Q: Why didn't CHS export my score(s)?
• A: It probably couldn't find your score in the screenshot. The script attempts 3 different ways of lifting the score off the image. If it fails to get the score all 3 times, it will skip the song entirely.

---

• Q: Will you fix foo issue?
• A: Maybe if you ask nicely? ;)

---

• Q: Will you implement foo feature?
• A: Maybe if you ask nicely and send cookies?