summaryrefslogtreecommitdiffstats
path: root/keyboards/crkbd/readme.md
diff options
context:
space:
mode:
authorDrashna Jaelre <drashna@live.com>2021-11-15 10:41:04 -0800
committerGitHub <noreply@github.com>2021-11-15 10:41:04 -0800
commit160b0558f55f1357e1a48175c949e98d32630e6b (patch)
tree459e163bfda5c90a615dada0d282891795cb7d42 /keyboards/crkbd/readme.md
parentc9fd69871165eb889be5421df518d8e35b2be027 (diff)
Require explicit enabling of RGB Matrix modes (#15018)
Diffstat (limited to 'keyboards/crkbd/readme.md')
-rw-r--r--keyboards/crkbd/readme.md76
1 files changed, 48 insertions, 28 deletions
diff --git a/keyboards/crkbd/readme.md b/keyboards/crkbd/readme.md
index f3bf152d20..64b51f54f0 100644
--- a/keyboards/crkbd/readme.md
+++ b/keyboards/crkbd/readme.md
@@ -56,34 +56,54 @@ And in your `config.h` file, add the following:
/* Disable the animations you don't want/need. You will need to disable a good number of these *
* because they take up a lot of space. Disable until you can successfully compile your firmware. */
-// # define DISABLE_RGB_MATRIX_ALPHAS_MODS
-// # define DISABLE_RGB_MATRIX_GRADIENT_UP_DOWN
-// # define DISABLE_RGB_MATRIX_BREATHING
-// # define DISABLE_RGB_MATRIX_CYCLE_ALL
-// # define DISABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT
-// # define DISABLE_RGB_MATRIX_CYCLE_UP_DOWN
-// # define DISABLE_RGB_MATRIX_CYCLE_OUT_IN
-// # define DISABLE_RGB_MATRIX_CYCLE_OUT_IN_DUAL
-// # define DISABLE_RGB_MATRIX_RAINBOW_MOVING_CHEVRON
-// # define DISABLE_RGB_MATRIX_DUAL_BEACON
-// # define DISABLE_RGB_MATRIX_RAINBOW_BEACON
-// # define DISABLE_RGB_MATRIX_RAINBOW_PINWHEELS
-// # define DISABLE_RGB_MATRIX_RAINDROPS
-// # define DISABLE_RGB_MATRIX_JELLYBEAN_RAINDROPS
-// # define DISABLE_RGB_MATRIX_TYPING_HEATMAP
-// # define DISABLE_RGB_MATRIX_DIGITAL_RAIN
-// # define DISABLE_RGB_MATRIX_SOLID_REACTIVE
-// # define DISABLE_RGB_MATRIX_SOLID_REACTIVE_SIMPLE
-// # define DISABLE_RGB_MATRIX_SOLID_REACTIVE_WIDE
-// # define DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE
-// # define DISABLE_RGB_MATRIX_SOLID_REACTIVE_CROSS
-// # define DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTICROSS
-// # define DISABLE_RGB_MATRIX_SOLID_REACTIVE_NEXUS
-// # define DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS
-// # define DISABLE_RGB_MATRIX_SPLASH
-// # define DISABLE_RGB_MATRIX_MULTISPLASH
-// # define DISABLE_RGB_MATRIX_SOLID_SPLASH
-// # define DISABLE_RGB_MATRIX_SOLID_MULTISPLASH
+// RGB Matrix Animation modes. Explicitly enabled
+// For full list of effects, see:
+// https://docs.qmk.fm/#/feature_rgb_matrix?id=rgb-matrix-effects
+# define ENABLE_RGB_MATRIX_ALPHAS_MODS
+# define ENABLE_RGB_MATRIX_GRADIENT_UP_DOWN
+# define ENABLE_RGB_MATRIX_GRADIENT_LEFT_RIGHT
+# define ENABLE_RGB_MATRIX_BREATHING
+# define ENABLE_RGB_MATRIX_BAND_SAT
+# define ENABLE_RGB_MATRIX_BAND_VAL
+# define ENABLE_RGB_MATRIX_BAND_PINWHEEL_SAT
+# define ENABLE_RGB_MATRIX_BAND_PINWHEEL_VAL
+# define ENABLE_RGB_MATRIX_BAND_SPIRAL_SAT
+# define ENABLE_RGB_MATRIX_BAND_SPIRAL_VAL
+# define ENABLE_RGB_MATRIX_CYCLE_ALL
+# define ENABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT
+# define ENABLE_RGB_MATRIX_CYCLE_UP_DOWN
+# define ENABLE_RGB_MATRIX_RAINBOW_MOVING_CHEVRON
+# define ENABLE_RGB_MATRIX_CYCLE_OUT_IN
+# define ENABLE_RGB_MATRIX_CYCLE_OUT_IN_DUAL
+# define ENABLE_RGB_MATRIX_CYCLE_PINWHEEL
+# define ENABLE_RGB_MATRIX_CYCLE_SPIRAL
+# define ENABLE_RGB_MATRIX_DUAL_BEACON
+# define ENABLE_RGB_MATRIX_RAINBOW_BEACON
+# define ENABLE_RGB_MATRIX_RAINBOW_PINWHEELS
+# define ENABLE_RGB_MATRIX_RAINDROPS
+# define ENABLE_RGB_MATRIX_JELLYBEAN_RAINDROPS
+# define ENABLE_RGB_MATRIX_HUE_BREATHING
+# define ENABLE_RGB_MATRIX_HUE_PENDULUM
+# define ENABLE_RGB_MATRIX_HUE_WAVE
+# define ENABLE_RGB_MATRIX_PIXEL_RAIN
+# define ENABLE_RGB_MATRIX_PIXEL_FLOW
+# define ENABLE_RGB_MATRIX_PIXEL_FRACTAL
+// enabled only if RGB_MATRIX_FRAMEBUFFER_EFFECTS is defined
+# define ENABLE_RGB_MATRIX_TYPING_HEATMAP
+# define ENABLE_RGB_MATRIX_DIGITAL_RAIN
+// enabled only of RGB_MATRIX_KEYPRESSES or RGB_MATRIX_KEYRELEASES is defined
+# define ENABLE_RGB_MATRIX_SOLID_REACTIVE_SIMPLE
+# define ENABLE_RGB_MATRIX_SOLID_REACTIVE
+# define ENABLE_RGB_MATRIX_SOLID_REACTIVE_WIDE
+# define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE
+# define ENABLE_RGB_MATRIX_SOLID_REACTIVE_CROSS
+# define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTICROSS
+# define ENABLE_RGB_MATRIX_SOLID_REACTIVE_NEXUS
+# define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS
+# define ENABLE_RGB_MATRIX_SPLASH
+# define ENABLE_RGB_MATRIX_MULTISPLASH
+# define ENABLE_RGB_MATRIX_SOLID_SPLASH
+# define ENABLE_RGB_MATRIX_SOLID_MULTISPLASH
#endif
```