Skip to content

Add custom key bindings via config.toml #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ptrsauer merged 2 commits into from
Feb 15, 2026
Merged

Add custom key bindings via config.toml #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
69f57cf
Add custom key bindings via config.toml
ptrsauer Feb 15, 2026
c79810f
Address review findings: Unicode support, conflict detection, gracefu…
ptrsauer Feb 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,8 +223,25 @@ results_chart_y = "gray;italic"

# restart/quit prompt in results ui
results_restart_prompt = "gray;italic"

[key_map]
# results screen: quit, new random test, repeat same test
quit = "q"
restart = "r"
repeat = "t"
# results screen: practice missed/slow words
practice_missed = "p"
practice_slow = "s"
# test screen: start new test with different words
new_test = "Tab"
```

### key binding format

Key bindings are specified as strings. A single character (e.g. `"q"`) maps to that key. Special keys are capitalized: `Tab`, `Space`, `Enter`, `Esc`, `Backspace`, `Delete`.

Modifier keys use a prefix with a dash: `C-` for Ctrl, `A-` for Alt. For example, `"C-r"` means Ctrl+R.

### style format

The configuration uses a custom style format which can specify most [ANSI escape styling codes](<https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_(Select_Graphic_Rendition)_parameters>), encoded as a string.
Expand Down
Loading