diff options
| author | Drashna Jaelre <drashna@live.com> | 2019-11-04 22:59:13 -0800 |
|---|---|---|
| committer | James Young <18669334+noroadsleft@users.noreply.github.com> | 2019-11-04 22:59:13 -0800 |
| commit | 542cb0a8ce3f324c6bd46751d733daf86384a8f6 (patch) | |
| tree | 08128a4e00a42fa0e78199d86f757a8d562952a9 /docs/keycodes.md | |
| parent | 0e664f92c4d61d685259607d7257c53f60da5fc0 (diff) | |
| download | firmware-542cb0a8ce3f324c6bd46751d733daf86384a8f6.tar.gz firmware-542cb0a8ce3f324c6bd46751d733daf86384a8f6.tar.bz2 firmware-542cb0a8ce3f324c6bd46751d733daf86384a8f6.zip | |
[Core] Convert Dynamic Macro to a Core Feature (#5948)
* Convert Dynamic Macro to a Core Feature
This imports the code from Dynamic Macro into the core code, and handles it, as such.
This deprecates the old method but does not remove it, for legacy support. This way, no existing user files need to be touched.
Additionally, this reorganizes the documentation to better reflect the changes.
Also, it adds user hooks to the feature so users can customize the existing functionality.
Based heavily on and closes #2976
* Apply suggestions from code review
Co-Authored-By: fauxpark <fauxpark@gmail.com>
Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
* Cleanup based on feedback
* Add short-form keycodes and document them
- add short-form keycodes to quantum/quantum_keycodes.h
- document the new aliases in docs/feature_dynamic_macros.md
* Add Dynamic Macros section and keycodes to docs/keycodes.md
* Make anti-nesting optional
* Add documentation for DYNAMIC_MACRO_NO_NESTING option
* Fix Merge artifacts
* Fix formatting typo in docs
Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com>
* Remove DYNAMIC_MACRO_RANGE as it's not needed
* Fix includes and layer var type
Diffstat (limited to 'docs/keycodes.md')
| -rw-r--r-- | docs/keycodes.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/keycodes.md b/docs/keycodes.md index 7dcff03fd..fa01df63d 100644 --- a/docs/keycodes.md +++ b/docs/keycodes.md @@ -297,6 +297,16 @@ This is a reference only. Each group of keys links to the page documenting their |`OUT_USB` |USB only | |`OUT_BT` |Bluetooth only | +## [Dynamic Macros](feature_dynamic_macros.md) + +|Key |Alias |Description | +|-----------------|---------|--------------------------------------------------| +|`DYN_REC_START1` |`DM_REC1`|Start recording Macro 1 | +|`DYN_REC_START2` |`DM_REC2`|Start recording Macro 2 | +|`DYN_MACRO_PLAY1`|`DM_PLY1`|Replay Macro 1 | +|`DYN_MACRO_PLAY2`|`DM_PLY2`|Replay Macro 2 | +|`DYN_REC_STOP` |`DM_RSTP`|Finish the macro that is currently being recorded.| + ## [Layer Switching](feature_advanced_keycodes.md#switching-and-toggling-layers) |Key |Description | |