Skip to content

Commit

Permalink
[Doc] Improve magic keycode section (qmk#21787)
Browse files Browse the repository at this point in the history
  • Loading branch information
filterpaper authored Aug 23, 2023
1 parent 3f19272 commit c2b8375
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions docs/squeezing_avr.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,7 @@ SPACE_CADET_ENABLE = no
GRAVE_ESC_ENABLE = no
MAGIC_ENABLE = no
```
These features are enabled by default, but may not be needed. Double check to make sure, though.
Largest in size is "magic" -- the QMK magic keycodes -- which control things like NKRO toggling, GUI and ALT/CTRL swapping, etc. Disabling it will disable those functions.
These features are enabled by default, but they may not be needed. Double check to make sure. The [Magic Keycodes](keycodes_magic.md) are the largest and control things like NKRO toggling, GUI and ALT/CTRL swapping, etc. Disabling them will disable those functions. See [Magic Functions](#magic-functions) for disabling related functions.

If you use `sprintf` or `snprintf` functions you can save around ~400 Bytes by enabling this option.
```make
Expand Down Expand Up @@ -88,7 +87,7 @@ Or if you're not using layers at all, you can outright remove the functionality
#define NO_ACTION_LAYER
```

## Magic keycodes
## Magic Functions

There are two `__attribute__ ((weak))` placeholder functions available to customize magic keycodes. If you are not using that feature to swap keycodes, such as backslash with backspace, add the following to your `keymap.c` or user space code:
```c
Expand Down

0 comments on commit c2b8375

Please sign in to comment.