X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=docs%2Ffeature_rgblight.md;h=0a5e2a8b15203eb555e232cbb957de9c3ffd3c5a;hb=32bb8f6b8af104c4a64b029820a4c7014eaf825d;hp=4ee32f3ec24167275035c82d22e1575769f9f129;hpb=f1451b4b04bad7d618bbc7fe3517ab736f819d86;p=qmk_firmware.git diff --git a/docs/feature_rgblight.md b/docs/feature_rgblight.md index 4ee32f3ec..0a5e2a8b1 100644 --- a/docs/feature_rgblight.md +++ b/docs/feature_rgblight.md @@ -49,8 +49,10 @@ If you have `#define RGBLIGHT_ANIMATIONS` in your `config.h` you will have a num | Option | Default Value | Description | |--------|---------------|-------------| | `RGBLIGHT_ANIMATIONS` | | `#define` this to enable animation modes. | -| `RGBLIGHT_EFFECT_SNAKE_LENGTH` | 4 | The number of LEDs to light up for the "snake" mode. | -| `RGBLIGHT_EFFECT_KNIGHT_LENGTH` | 3 | The number of LEDs to light up for the "knight" mode. | +| `RGBLIGHT_EFFECT_BREATHE_CENTER` | 1.85 | Used to calculate the curve for the breathing animation. Valid values 1.0-2.7. | +| `RGBLIGHT_EFFECT_BREATHE_MAX` | 255 | The maximum brightness for the breathing mode. Valid values 1-255. | +| `RGBLIGHT_EFFECT_SNAKE_LENGTH` | 4 | The number of LEDs to light up for the "snake" animation. | +| `RGBLIGHT_EFFECT_KNIGHT_LENGTH` | 3 | The number of LEDs to light up for the "knight" animation. | | `RGBLIGHT_EFFECT_KNIGHT_OFFSET` | 0 | Start the knight animation this many LEDs from the start of the strip. | | `RGBLIGHT_EFFECT_KNIGHT_LED_NUM` | RGBLED_NUM | The number of LEDs to have the "knight" animation travel. | | `RGBLIGHT_EFFECT_CHRISTMAS_INTERVAL` | 1000 | How long to wait between light changes for the "christmas" animation. Specified in ms. | @@ -86,6 +88,7 @@ These control the RGB Lighting functionality. |-----------|------------|-------------| ||`RGB_TOG`|toggle on/off| ||`RGB_MOD`|cycle through modes| +||`RGB_SMOD`|cycle through modes, use reverse direction when shift is hold| ||`RGB_HUI`|hue increase| ||`RGB_HUD`|hue decrease| ||`RGB_SAI`|saturation increase|