QMK Keymaps

Table of Contents

• Installation
• About
• Features
• My Keymap
• References

Installation

Prerequisites

Follow the getting started docs to install QMK Firmware

Setup

# Clone the userspace
git clone https://git.sajenim.dev/jasmine/qmk_userspace.git

# Configure QMK to use external userspace
qmk config user.overlay_dir="$(realpath qmk_userspace)"

# Compile for Ferris Sweep
qmk compile -kb ferris/sweep -km sajenim

# Flash to keyboard (enter bootloader mode first)
qmk flash -kb ferris/sweep -km sajenim

About

This is a custom QMK userspace for the Ferris Sweep keyboard, featuring the Canary layout - a collaborative design by the Alternate Keyboard Layout (AKL) community with over 55% rolling trigrams for a flowy typing feel. The keymap includes extensive customizations for improved typing efficiency, emphasizing minimal finger movement through home row mods, combos, and intelligent repeat keys.

Design Philosophy

• Comfort first: All frequently used keys accessible without leaving home position
• Smart automation: Let the keyboard handle common patterns (repeat key, magic completions, autocorrect)
• Minimal layers: 5 carefully designed layers (CANARY, NAV, NUM, SYM, FUN) with logical access patterns

Features

Autocorrect

Automatically fixes common typing mistakes in real-time. Maintains a dictionary of frequently mistyped words and corrects them as you type, reducing the need for manual backspacing and retyping.

Combos

Press multiple keys simultaneously to output different characters or trigger actions. Enables access to numbers, symbols, and commands without leaving the home position, reducing finger travel and improving typing efficiency.

Home Row Mods

Modifier keys (Alt, Shift, GUI, Ctrl) placed on the home row as dual-function keys. Tap for the letter, hold for the modifier. Eliminates the need to reach for traditional modifier positions, reducing hand movement and strain.

Repeat / Magic Keys

Two intelligent repeat mechanisms on the thumb keys:

• Repeat Key - Repeats the last keystroke with context-aware enhancements for common trigrams and word briefs
• Magic Key - Context-aware completions based on the previous key. Reduces same-finger bigrams and enables common word completions

See magic sturdy for the inspiration behind the magic key implementation.

My Keymap

Usage Examples

Combos for Numbers: Press home row + upper row simultaneously for vertical number access:

• L + R → 2
• Y + S → 3
• P + T → 4

Magic Key Completions: Type a letter, then press the Magic key (right thumb):

• w + Magic → which
• b + Magic → efore
• + + Magic → = (creates +=)

Repeat Key Enhancements: Tap a key twice using the Repeat key (left thumb):

• a + Repeat → nd (completes "and")
• i + Repeat → ng (completes "ing")
• . + Repeat → ./ (first repeat), ../ (second repeat)

For complete documentation of all repeat and magic key behaviors, see the wiki.

References

Precondition
Home row mods timing and configuration guidance

Pascal Getreuer
Advanced QMK features and custom keycodes

Ikcelaks
Magic key implementation and layout analysis

Jonas Hietala
Keyboard layout development journey