aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRyan <[email protected]>2024-11-20 09:53:33 +1100
committerGitHub <[email protected]>2024-11-20 09:53:33 +1100
commit9c865839819bf9ec3ed573354a53bcbe905080f7 (patch)
tree9b9b94bf3ec84ad3dcdac28949046180c55243d8 /docs
parente66fce38b232646111e6811a03133e557d897cba (diff)
downloadqmk_firmware-9c865839819bf9ec3ed573354a53bcbe905080f7.tar.gz
qmk_firmware-9c865839819bf9ec3ed573354a53bcbe905080f7.zip
Backward compatibility for new RGB keycode handling (#24490)
Co-authored-by: Dasky <[email protected]>
Diffstat (limited to 'docs')
-rw-r--r--docs/features/rgblight.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/features/rgblight.md b/docs/features/rgblight.md
index 2afc2eb7d0..4322fe796e 100644
--- a/docs/features/rgblight.md
+++ b/docs/features/rgblight.md
@@ -59,6 +59,10 @@ Changing the **Value** sets the overall brightness.<br>
## Keycodes
+::: warning
+These keycodes also simultaneously control [RGB Matrix](rgb_matrix), if enabled. This behaviour is in the process of being deprecated, so during this time it is recommended to additionally include the dedicated RGB Matrix keycodes to your keymap, and add `#define RGB_MATRIX_DISABLE_SHARED_KEYCODES` to `config.h`.
+:::
+
|Key |Aliases |Description |
|------------------------------|----------|---------------------------------------------------------------------|
|`QK_UNDERGLOW_TOGGLE` |`UG_TOGG` |Toggle RGB lighting on or off |