supper/README.md

35 lines
1.3 KiB
Markdown

# Supper: Circuit Superstars Tracking
Supper is a tracking app for [Circuit Superstars](https://www.circuit-superstars.com/). It watches
you play and tracks your lap times and strategies, so you can analyze them later.
![](src/data/example-ui.png)
## 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.