OCR Tracking for Circuit Superstars
Go to file
Scott Pruett 40aa5d02b9 add screenshot to README 2022-06-04 17:06:04 -04:00
.vscode add VSCode tasks 2022-05-23 20:50:52 -04:00
src add screenshot to README 2022-06-04 17:06:04 -04:00
.gitignore local OCR 2022-06-02 22:58:01 -04:00
Cargo.lock cleanups, formatting 2022-06-04 15:32:23 -04:00
Cargo.toml cleanups, formatting 2022-06-04 15:32:23 -04:00
LICENSE MIT license 2022-06-03 22:41:42 -04:00
README.md add screenshot to README 2022-06-04 17:06:04 -04:00
config.json UI touchup 2022-06-04 16:43:15 -04:00
config_1080p.json adjust configs, update to local-only OCR 2022-06-03 22:30:07 -04:00
learned.json few more tests 2022-06-03 22:39:19 -04:00
learned_chars.txt local OCR 2022-06-02 22:58:01 -04:00
ocr.json local OCR working 2022-06-03 22:19:06 -04:00
race_stats.csv local OCR working 2022-06-03 22:19:06 -04:00
scale_config.py dark mode release 2022-05-22 22:23:28 -04:00
suggestions.md cleanups, formatting 2022-06-04 15:32:23 -04:00

README.md

Supper: Circuit Superstars Tracking

Supper is a tracking app for Circuit Superstars. It watches you play and tracks your lap times and strategies, so you can analyze them later.

Features

  • OCR-based, no system hooks or magic required
  • Relatively simple UI
  • Customizable for different screen resolutions
  • Lap time tracking over the course of a race, with deltas shown
  • Resource tracking for each lap (gas, tires, health)
  • Automatic recognition of tracks from the minimap
  • CSV export for race data for your own analysis of lap times or pit strategies

Development

Supper is intended to be relatively cross-platform, but the main target is Windows (given that Circuit Superstars is Windows-exclusive currently). Features are prioritized for this environment.

Supper is a typical Rust application, build it with cargo build [--release] or run it with cargo run [--release].

Core dependencies:

  • egui: for the UI
  • scrap: for screenshotting
  • image: for image processing
  • img_hash: for image hashing algorithms, used in OCR
  • serde: for parsing and serializing JSON configs
  • anyhow, time, rand, csv as general utilities

If you wish to contribute, reach out first! Check your code with cargo fmt and cargo clippy before submitting anything.