X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=docs%2Ffeature_dynamic_macros.md;h=0d11a28641a678167584a73785a594e0aeb3b209;hb=75795186135e6d83de1ff3bb108f9c5471742ba4;hp=23fefea4ce7e5c7406504c9dec073f786ca77acf;hpb=7b0356d1d49da6574570e110f61f95692afdb3d0;p=qmk_firmware.git diff --git a/docs/feature_dynamic_macros.md b/docs/feature_dynamic_macros.md index 23fefea4c..0d11a2864 100644 --- a/docs/feature_dynamic_macros.md +++ b/docs/feature_dynamic_macros.md @@ -4,10 +4,10 @@ QMK supports temporary macros created on the fly. We call these Dynamic Macros. You can store one or two macros and they may have a combined total of 128 keypresses. You can increase this size at the cost of RAM. -To enable them, first add a new element to the `planck_keycodes` enum — `DYNAMIC_MACRO_RANGE`: +To enable them, first add a new element to the end of your `keycodes` enum — `DYNAMIC_MACRO_RANGE`: ```c -enum planck_keycodes { +enum keycodes { QWERTY = SAFE_RANGE, COLEMAK, DVORAK, @@ -20,7 +20,7 @@ enum planck_keycodes { }; ``` -It must be the last element because `dynamic_macros.h` will add some more keycodes after it. +Your `keycodes` enum may have a slightly different name. You must add `DYNAMIC_MACRO_RANGE` as the last element because `dynamic_macros.h` will add some more keycodes after it. Below it, include the `dynamic_macro.h` header: @@ -52,7 +52,7 @@ For users of the earlier versions of dynamic macros: It is still possible to fin ```c uint16_t macro_kc = (keycode == MO(_DYN) ? DYN_REC_STOP : keycode); - + if (!process_record_dynamic_macro(macro_kc, record)) { return false; }