quest/README.md
2021-09-17 09:25:36 +10:00

30 lines
815 B
Markdown

# Quinn's Utterly Elegant Speedrun Timer
A speedrun timer for \*nix terminals
## Features
- Global hotkeys
- 24-bit terminal color
- Human readable JSON splits file
- Import splits from a Splits.io file
- High fps rendering
## Usage
Copy `examples/sample.json` somewhere, replace the sample information with
the names of your game, catagories and splits. Changing split names/number of
splits after the first use of the split file is currently unsupported.
### Default Keybinds
| Keys | Action |
| ---- | --------------------- |
| `R` | Start |
| `F` | Stop |
| `E` | Split |
| `G` | Undo split |
| `C` | Close |
| `T` | Toggle global hotkeys |
Customisable hotkeys without editing the source code coming soon!