Skip to content

About

Omatutor: a vimtutor-style game for building muscle memory with Omarchy's keybindings

Topics

Resources

Stars

3 stars

Watchers

1 watching

Forks

Latest commit

 

History

5 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Omatutor

A vimtutor-style game for building muscle memory with Omarchy's keybindings.

It runs inside your real Hyprland session, not a simulation. A thin panel along the bottom of the screen gives you an instruction ("Move focus LEFT ←"), you press the real keys, and Omatutor watches Hyprland's state over its IPC socket to see whether you did it. The practice windows are big lettered tiles (A, B, C) on a spare workspace. The tile you need lights up.

Lesson 1 asks you to move focus left; tile A is lit as the target and the panel below the tiles shows the keys

Install and run

git clone https://github.com/briantoll/omarchy-tutor
cd omarchy-tutor
./install.sh                # puts omatutor on your PATH and in the app launcher
omatutor               # menu
omatutor drill         # straight into the 5-minute drill
omatutor sprint        # 60-second sprint
omatutor lesson 3      # a specific lesson
omatutor --reset       # forget progress

It needs nothing beyond Python 3 and a terminal Omarchy already ships (foot, alacritty, kitty or ghostty). Omatutor picks an empty workspace (7 if it's free), and when you quit it closes its tiles and takes you back to where you started.

To put it in the Omarchy menu (Super + Alt + Space) under Learn, next to Keybindings, add this line to ~/.config/omarchy/extensions/omarchy-menu.jsonc. The menu picks it up without a restart.

"learn.practice": {"icon":"󰌌","label":"Practice keys","action":"omatutor"},

The menu: seven lessons, two timed drills, and your slowest keys

Lessons

# Lesson Keys drilled
1 Focus Super + arrows, Alt + Tab
2 Arrange Super + Shift + arrows (swap), Super + J (split), Super + - / = (resize)
3 Workspaces Super + 1–9, Super + Ctrl + Tab (former), Super + Tab / Shift + Tab
4 Moving windows Super + Shift + N (follow), Super + Shift + Alt + N (silent)
5 Window modes Super + T float, Super + F full screen, Super + Alt + F full width, Super + O pop out, Super + Enter, Super + W
6 Layouts & groups Super + L dwindle ⇄ scrolling, Super + G group, Super + Alt + arrows / Tab / G
7 Scratchpad Super + Alt + S, Super + S

Each lesson has two rounds. First you do every move with the keys shown, then you do them all again, shuffled, from memory.

The workspace lessons never send you into your own apps. Omatutor parks a big numbered signpost on two empty workspaces next to the practice one and only ever sends you there, and whenever you are away from the tiles the panel says where you are and which key brings you back. Super + Tab cycles through every open workspace, so for those prompts the panel also names the workspace the key will land on.

When you get it right, the tile confirms it and the panel shows your time:

A correct answer: the target tile turns green with a tick and the panel shows your time

If you do something other than what was asked, the panel flashes red and shows the keys. Undo it with the same key and try again. If a wrong move leaves the tiles in a mess, Omatutor tidies them up before the next prompt, and if you get properly stuck it resets the tiles and moves on.

A wrong answer: the panel shows "not quite" in red with the keys above it

Drills

The 5-minute drill and 60-second sprint throw random moves at you from the lessons you've finished (lessons 1–3 until you've done three). The key hint stays hidden for 4 seconds. Faster answers score more, clean answers build a combo multiplier, and using the hint halves the points.

A drill prompt with the hint still hidden and the clock running

Moves you're slow on or miss come up more often (a simple Leitner-box weighting). Every round ends with your score and the moves that cost you the most time, and k in the menu shows your slowest keys overall.

End of a drill: score, new best, and the slowest moves of the round with their keys

Your slowest keys: every move you've drilled, ordered by average time, with its keys

While you're playing, press Esc in any tile to go back to the menu, h for a hint, or s to skip.

How it works

  • The key hints are read from your live config through omarchy-menu-keybindings --print (the same data as Super + K). If you rebind something, Omatutor shows your binding, but the action it checks for stays the same.
  • Every step is a check on Hyprland's state (clients, activewindow, activeworkspace, monitors, workspaces), polled about 25 times a second over the socket.
  • Tiles are terminals running omatutor --tile X, launched with your default terminal.
  • Progress is saved in ~/.local/state/omatutor/progress.json.

Notes

  • Anything you open on the practice workspace during a session (e.g. a terminal from a stray Super + Enter) gets closed when the tiles are reset.
  • The signpost workspaces are claimed the first time a workspace exercise comes up and released when you quit.
  • If the layout lesson changes the practice workspace's layout, Omatutor restores Omarchy's saved layout file for that workspace when you quit.
  • Multi-monitor moves aren't drilled yet.

About

Omatutor: a vimtutor-style game for building muscle memory with Omarchy's keybindings

Topics

Resources

Stars

3 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages