From d2f45396417613af13a9256362283d67363451a0 Mon Sep 17 00:00:00 2001 From: Scott Pruett Date: Sat, 4 Jun 2022 15:32:31 -0400 Subject: [PATCH] README --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..66ef12f --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# 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. + +## 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. \ No newline at end of file