quest/README.md

47 lines
1.3 KiB
Markdown
Raw Normal View History

2021-09-17 07:14:35 +10:00
# Quinn's Utterly Elegant Speedrun Timer
2021-09-17 05:21:45 +10:00
2021-09-17 07:14:35 +10:00
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
2021-09-17 09:25:36 +10:00
## Usage
Copy `examples/sample.json` somewhere, replace the sample information with
2022-01-16 02:23:13 +11:00
the names of your game, categories and segments. Changing the number of
segments after the first use of the split file is currently unsupported.
2021-09-17 09:25:36 +10:00
### Default Keybinds
| Keys | Action | Global |
| ---- | --------------------- | ------ |
| `R` | Start | YES |
| `F` | Stop / Reset | YES |
| `E` | Split | YES |
| `G` | Undo split | YES |
| `V` | Skip split | YES |
| `Q` | Close | NO |
| `T` | Toggle global hotkeys | YES |
| `C` | Toggle compact UI | NO |
2021-09-17 09:25:36 +10:00
Hotkeys can be configured in `$HOME/.config/quest/keymaps/default`
2022-01-16 02:23:13 +11:00
## Third Party Integration
If a feature isn't listed here, it probably isn't planned
yet and may not ever be
### [Splits.io](https://splits.io/)
- [X] Import game, category and segment names from generic format
2022-01-16 15:47:04 +11:00
- [ ] Import all information the generic format supports i.e. run histories
- [ ] Export runs in the generic format
2022-01-16 02:23:13 +11:00
### [Speedrun.com](https://www.speedrun.com/)
- [ ] Submit runs