diff options
| author | Albert Y <76888457+filterpaper@users.noreply.github.com> | 2021-12-29 05:00:49 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-12-28 13:00:49 -0800 |
| commit | 3dee6e28dd2fce27945bd464f5a80d3508e7c1d4 (patch) | |
| tree | 287c8a05667f334fc141dfb04190261461a03c6a /docs | |
| parent | 787f15b58f099949cbcc3ef4bfea255c6185d708 (diff) | |
[Docs] Clarify placement and usage of RGB matrix effect inc files (#15572)
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: filterpaper <filterpaper@localhost>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/feature_rgb_matrix.md | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/docs/feature_rgb_matrix.md b/docs/feature_rgb_matrix.md index 3132360a38..3a40be5f5e 100644 --- a/docs/feature_rgb_matrix.md +++ b/docs/feature_rgb_matrix.md @@ -554,12 +554,11 @@ In order to change the delay of temperature decrease define ## Custom RGB Matrix Effects :id=custom-rgb-matrix-effects -By setting `RGB_MATRIX_CUSTOM_USER` (and/or `RGB_MATRIX_CUSTOM_KB`) in `rules.mk`, new effects can be defined directly from userspace, without having to edit any QMK core files. +By setting `RGB_MATRIX_CUSTOM_USER = yes` in `rules.mk`, new effects can be defined directly from your keymap or userspace, without having to edit any QMK core files. -To declare new effects, create a new `rgb_matrix_user/kb.inc` that looks something like this: +To declare new effects, create a `rgb_matrix_user.inc` file in the user keymap directory or userspace folder. -`rgb_matrix_user.inc` should go in the root of the keymap directory. -`rgb_matrix_kb.inc` should go in the root of the keyboard directory. +?> Hardware maintainers who want to limit custom effects to a specific keyboard can create a `rgb_matrix_kb.inc` file in the root of the keyboard directory, and add `RGB_MATRIX_CUSTOM_KB = yes` to the keyboard level `rules.mk`. To use custom effects in your code, simply prepend `RGB_MATRIX_CUSTOM_` to the effect name specified in `RGB_MATRIX_EFFECT()`. For example, an effect declared as `RGB_MATRIX_EFFECT(my_cool_effect)` would be referenced with: |