diff options
author | Pascal Getreuer <[email protected]> | 2025-05-11 16:30:19 -0700 |
---|---|---|
committer | GitHub <[email protected]> | 2025-05-12 09:30:19 +1000 |
commit | f4171412a676ae3cbd1cd50e859a7deb1a554e15 (patch) | |
tree | 57d1acc2b9f9651b8d82299a3288cbe51b0199cb /docs | |
parent | 7f42a5bc03a3f80d65314c69adb0b1176cf13167 (diff) | |
download | qmk_firmware-f4171412a676ae3cbd1cd50e859a7deb1a554e15.tar.gz qmk_firmware-f4171412a676ae3cbd1cd50e859a7deb1a554e15.zip |
Enable community modules to define LED matrix and RGB matrix effects. (#25187)
Co-authored-by: Joel Challis <[email protected]>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/features/community_modules.md | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/features/community_modules.md b/docs/features/community_modules.md index 8dede47bd4..eff07c939a 100644 --- a/docs/features/community_modules.md +++ b/docs/features/community_modules.md @@ -123,6 +123,14 @@ The source file may provide functions which allow access to information specifie Introspection is a relatively advanced topic within QMK, and existing patterns should be followed. If you need help please [open an issue](https://github.com/qmk/qmk_firmware/issues/new) or [chat with us on Discord](https://discord.gg/qmk). ::: +### `led_matrix_module.inc` + +This file defines LED matrix effects in the same form as used with `led_matrix_kb.inc` and `led_matrix_user.inc` (see [Custom LED Matrix Effects](led_matrix#custom-led-matrix-effects)). Effect mode names are prepended with `LED_MATRIX_COMMUNITY_MODULE_`. + +### `rgb_matrix_module.inc` + +This file defines RGB matrix effects in the same form as used with `rgb_matrix_kb.inc` and `rgb_matrix_user.inc` (see [Custom RGB Matrix Effects](rgb_matrix#custom-rgb-matrix-effects)). Effect mode names are prepended with `RGB_MATRIX_COMMUNITY_MODULE_`. + ### Compatible APIs Community Modules may provide specializations for the following APIs: |