* disambiguate Bootmagic rules in keymaps

The files edited by this commit were added at a point in time where `BOOTMAGIC_ENABLE = yes` enabled full Bootmagic.

This commit edits the files to specify that full Bootmagic is intended.

* remove BOOTMAGIC_ENABLE=full setting

* unify commented BOOTMAGIC_ENABLE rules in keyboards

Explicitly sets `BOOTMAGIC_ENABLE = no` in keyboards where the rule was commented out.

Command:

```
find keyboards/ -type f -name 'rules.mk' -and -not -path '*/keymaps/*' -exec sed -i -e 's;#[ \t]*\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-zA-Z]\+\).*;\1 = no       # Virtual DIP switch configuration;g' {} +
```

* remove commented Bootmagic rules from keymap/user level

Command:

```
find keyboards/ layouts/ users/ -type f -name 'rules.mk' -exec sed -i -e '/#.*\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*/d' {} +
```

* update keyboard BOOTMAGIC_ENABLE rule formatting

Sets the formatting of BOOTMAGIC_ENABLE rules to `BOOTMAGIC_ENABLE = [value]`, without the inline comments (which will be replaced later).

Command:

```
find keyboards/ -type f -name 'rules.mk' -and -not -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*;\1 = \2;g' '{}' +
```

* update keyboards' BOOTMAGIC_ENABLE settings

Updates keyboard `rules.mk` files to use `BOOTMAGIC_ENABLE = lite` where `BOOTMAGIC_ENABLE = full` was being used.

Command:

```
find keyboards/ -type f -name 'rules.mk' -and -not -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = \)full;\1lite;g' '{}' +
```

* update keymap/user BOOTMAGIC_ENABLE settings

Updates keymap/user `rules.mk` files to use `BOOTMAGIC_ENABLE = lite` where `BOOTMAGIC_ENABLE = full` was being used.

Commands:

```
find keyboards/ -type f -name 'rules.mk' -and -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE[ \t=]\+\)full;\1lite;g' '{}' +
find layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE[ \t=]\+\)full;\1lite;g' '{}' +
```

* remove and replace inline comments in keyboards and keymap/user files

Removes and replaces the inline comments, which have been updated to read `Enable Bootmagic Lite`.

Commands:

```
find keyboards/ -type f -name 'rules.mk' -and -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*;\1 = \2;g' '{}' +
find layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*;\1 = \2;g' '{}' +
find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = lite\);\1     # Enable Bootmagic Lite;g' '{}' +
find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = yes\);\1      # Enable Bootmagic Lite;g' '{}' +
find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = no\);\1       # Enable Bootmagic Lite;g' '{}' +
```

* rename improperly named makefiles

Some files intended to be used as makefiles had improper names causing them to not be used as intended when building.

This commit corrects the filenames of the affected files.

* update renamed file with new rule formatting

* update QMK's template files

Updates QMK's `rules.mk` templates to use the new inline comment.

* update QMK Docs

- remove documentation of full Bootmagic
- update links to Bootmagic Lite doc
- add doc for Magic Keycodes

* rules.mk patch for coarse/ixora and coarse/vinta

2021-08-06 23:59:56 -07:00

4.0 KiB

Raw Blame History

Magic Keycodes :id=magic-keycodes

Magic Keycodes are prefixed with MAGIC_, and allow you to access the functionality of the deprecated Bootmagic feature after your keyboard has initialized. To use the keycodes, assign them to your keymap as you would any other keycode.

Key	Aliases	Description
`MAGIC_SWAP_CONTROL_CAPSLOCK`	`CL_SWAP`	Swap Caps Lock and Left Control
`MAGIC_UNSWAP_CONTROL_CAPSLOCK`	`CL_NORM`	Unswap Caps Lock and Left Control
`MAGIC_CAPSLOCK_TO_CONTROL`	`CL_CTRL`	Treat Caps Lock as Control
`MAGIC_UNCAPSLOCK_TO_CONTROL`	`CL_CAPS`	Stop treating Caps Lock as Control
`MAGIC_SWAP_LCTL_LGUI`	`LCG_SWP`	Swap Left Control and GUI
`MAGIC_UNSWAP_LCTL_LGUI`	`LCG_NRM`	Unswap Left Control and GUI
`MAGIC_SWAP_RCTL_RGUI`	`RCG_SWP`	Swap Right Control and GUI
`MAGIC_UNSWAP_RCTL_RGUI`	`RCG_NRM`	Unswap Right Control and GUI
`MAGIC_SWAP_CTL_GUI`	`CG_SWAP`	Swap Control and GUI on both sides
`MAGIC_UNSWAP_CTL_GUI`	`CG_NORM`	Unswap Control and GUI on both sides
`MAGIC_TOGGLE_CTL_GUI`	`CG_TOGG`	Toggle Control and GUI swap on both sides
`MAGIC_SWAP_LALT_LGUI`	`LAG_SWP`	Swap Left Alt and GUI
`MAGIC_UNSWAP_LALT_LGUI`	`LAG_NRM`	Unswap Left Alt and GUI
`MAGIC_SWAP_RALT_RGUI`	`RAG_SWP`	Swap Right Alt and GUI
`MAGIC_UNSWAP_RALT_RGUI`	`RAG_NRM`	Unswap Right Alt and GUI
`MAGIC_SWAP_ALT_GUI`	`AG_SWAP`	Swap Alt and GUI on both sides
`MAGIC_UNSWAP_ALT_GUI`	`AG_NORM`	Unswap Alt and GUI on both sides
`MAGIC_TOGGLE_ALT_GUI`	`AG_TOGG`	Toggle Alt and GUI swap on both sides
`MAGIC_NO_GUI`	`GUI_OFF`	Disable the GUI keys
`MAGIC_UNNO_GUI`	`GUI_ON`	Enable the GUI keys
`MAGIC_SWAP_GRAVE_ESC`	`GE_SWAP`	Swap ` and Escape
`MAGIC_UNSWAP_GRAVE_ESC`	`GE_NORM`	Unswap ` and Escape
`MAGIC_SWAP_BACKSLASH_BACKSPACE`	`BS_SWAP`	Swap `\` and Backspace
`MAGIC_UNSWAP_BACKSLASH_BACKSPACE`	`BS_NORM`	Unswap `\` and Backspace
`MAGIC_HOST_NKRO`	`NK_ON`	Enable N-key rollover
`MAGIC_UNHOST_NKRO`	`NK_OFF`	Disable N-key rollover
`MAGIC_TOGGLE_NKRO`	`NK_TOGG`	Toggle N-key rollover
`MAGIC_EE_HANDS_LEFT`	`EH_LEFT`	Set the master half of a split keyboard as the left hand (for `EE_HANDS`)
`MAGIC_EE_HANDS_RIGHT`	`EH_RGHT`	Set the master half of a split keyboard as the right hand (for `EE_HANDS`)

4.0 KiB Raw Blame History

Magic Keycodes :id=magic-keycodes

4.0 KiB

Raw Blame History