docs/feature_bootmagic.md

   1 # Bootmagic
   2
   3 <!-- FIXME: Describe the bootmagic feature here. -->
   4
   5 ## Bootmagic Keycodes
   6
   7 Shortcuts for bootmagic options. You can use these even when bootmagic is off.
   8
   9 |Key                               |Aliases  |Description                         |
  10 |----------------------------------|---------|------------------------------------|
  11 |`MAGIC_SWAP_CONTROL_CAPSLOCK`     |         |Swap Left Control and Caps Lock     |
  12 |`MAGIC_CAPSLOCK_TO_CONTROL`       |         |Treat Caps Lock as Control          |
  13 |`MAGIC_SWAP_LALT_LGUI`            |         |Swap Left Alt and GUI               |
  14 |`MAGIC_SWAP_RALT_RGUI`            |         |Swap Right Alt and GUI              |
  15 |`MAGIC_NO_GUI`                    |         |Disable the GUI key                 |
  16 |`MAGIC_SWAP_GRAVE_ESC`            |         |Swap <code>&#96;</code> and Escape  |
  17 |`MAGIC_SWAP_BACKSLASH_BACKSPACE`  |         |Swap Backslash and Backspace        |
  18 |`MAGIC_HOST_NKRO`                 |         |Force NKRO on                       |
  19 |`MAGIC_SWAP_ALT_GUI`              |`AG_SWAP`|Swap Alt and GUI on both sides      |
  20 |`MAGIC_UNSWAP_CONTROL_CAPSLOCK`   |         |Unswap Left Control and Caps Lock   |
  21 |`MAGIC_UNCAPSLOCK_TO_CONTROL`     |         |Stop treating CapsLock as Control   |
  22 |`MAGIC_UNSWAP_LALT_LGUI`          |         |Unswap Left Alt and GUI             |
  23 |`MAGIC_UNSWAP_RALT_RGUI`          |         |Unswap Right Alt and GUI            |
  24 |`MAGIC_UNNO_GUI`                  |         |Enable the GUI key                  |
  25 |`MAGIC_UNSWAP_GRAVE_ESC`          |         |Unswap <code>&#96;</code> and Escape|
  26 |`MAGIC_UNSWAP_BACKSLASH_BACKSPACE`|         |Unswap Backslash and Backspace      |
  27 |`MAGIC_UNHOST_NKRO`               |         |Force NKRO off                      |
  28 |`MAGIC_UNSWAP_ALT_GUI`            |`AG_NORM`|Unswap Left Alt and GUI             |
  29 |`MAGIC_TOGGLE_NKRO`               |         |Turn NKRO on or off                 |
  30
  31
  32 ## Bootmagc Hotkeys
  33
  34 Use this by holding the SPACEBAR and the documented key while
  35 plugging in the USB connection. e.g. to get into bootloader mode
  36 hold `SPACE` and `B` while plugging in USB.
  37
  38
  39 |Key        |Description                                                             |
  40 |-----------|------------------------------------------------------------------------|
  41 |`ESC`      | Skip bootmagic and saved eeprom configuration                          |
  42 |`B`        | Enter bootloader instead of firmware                                   |
  43 |`BACKSPACE`| Clear the saved settings from flash                                    |
  44 |`LCTRL`    | Swap `Control` and `Capslock` and save into flash                      |
  45 |`CAPSLOCK` | Swap `Capslock` and `Control` and save into flash                      |
  46 |`LALT`     | Swap Left `Alt` and `GUI` and save into flash, e.g. for OSX Opt and Cmd|
  47 |`RALT`     | Swap Right `Alt` and `GUI` and save into flash                         |
  48 |`LGUI`     | Disable GUI key - e.g. disable Windows key during gaming               |
  49 |`GRAVE`    | Swap &#39; and `ESC` and save into flash                               |
  50 |`BACKSLASH`| Swap Blackslash and Backspace and save into flash                      |
  51 |`N`        | Enable NKRO (N Key Roll Over)                                          |
  52 |`0`        | Make Layer 0 the default layer at bootup, e.g. switch to dvorak        |
  53 |`1`        | Make Layer 1 the default layer at bootup                               |
  54 |`2`        | Make Layer 2 the default layer at bootup                               |
  55 |`3`        | Make Layer 3 the default layer at bootup                               |
  56 |`4`        | Make Layer 4 the default layer at bootup                               |
  57 |`5`        | Make Layer 5 the default layer at bootup                               |
  58 |`6`        | Make Layer 6 the default layer at bootup                               |
  59 |`7`        | Make Layer 7 the default layer at bootup                               |
  60
  61
  62
  63
  64