Skip to content

Commit

Permalink
Update MT_MAP documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
tynanbe committed Jun 25, 2020
1 parent 9bc7ab6 commit 0f2fd93
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions users/tynanbe/tynanbe_keymap.h
Original file line number Diff line number Diff line change
Expand Up @@ -86,10 +86,19 @@
* MT_MAP(_SYM, ROW_L, ROW_R, ROW_L_MODS, ROW_R_MODS)
* ```
*
* In the above example, the first key in `row_l_mods` will send `KC_TILDE` when
* QMK recognizes a tap event, rather than `KC_F21`, simply by recognizing that
* the keycodes differ. Conversely, the second key in `row_l_mods` will bypass
* any special processing and send `KC_A` on tap events.
* In the above example, the first key in `row_l_mods` will send `KC_TILDE`
* when QMK recognizes a tap event for the first key in `ROW_L_MODS` on the
* `_SYM` layer, instead of `KC_F21`, simply by recognizing that the keycodes
* differ. Conversely, the second key in `row_l_mods` will bypass this special
* handling and send `KC_A` on tap events.
*
* Note: Using `KC_F21` through `KC_F24` in the first four positions of
* `ROW_L_MODS` and the last four positions of `ROW_R_MODS`, as placeholders
* for any shifted keycodes in `ROW_L` and `ROW_R`, will limit possible overlap
* with legitimate basic keycodes (that should not receive any special
* handling), to four uncommonly used basic keycodes, minimizing the chances of
* causing any inadvertent tap code replacements; however, any basic keycodes
* can be used, as long as they differ from their non-mod-tapped counterparts.
*/

#define MT_MAP_KEYCODE(kc, mt_kc) \
Expand Down

0 comments on commit 0f2fd93

Please sign in to comment.