qmk/modules/getreuer/palettefx/README.md

PaletteFx

Module	getreuer/palettefx
Version	2025-03-07
Maintainer	Pascal Getreuer (@getreuer)
License	Apache 2.0
Documentation	https://getreuer.info/posts/keyboards/palettefx

This is a community module adaptation of PaletteFx for colorful palette-based RGB matrix effects. While most of QMK's built-in RGB matrix effects are based on a single color hue, sampling from a palette of colors allows for more personality. PaletteFx is a suite of custom effects for QMK's RGB Matrix in which the effect colors are sampled from a palette, aka color gradient or color map.

Add PaletteFx to your keymap

Add the following to your keymap.json:

{
    "modules": ["getreuer/palettefx"]
}

Then in your keymap folder, create a file rgb_matrix_user.inc with the following content, or if it already exists, add this as the first line:

#include "palettefx.inc"

Using PaletteFx

Selecting effects: PaletteFx effects are appended to the list of existing RGB Matrix effects. Use the usual RM_NEXT / RM_PREV keycodes to switch to the PaletteFx effects.

Selecting palettes: PaletteFx effects repurpose the RGB Matrix hue setting to select which palette to use. Use the hue keycodes RM_HUEU / RM_HUED to cycle through them. The ith palette corresponds to hue = RGB_MATRIX_HUE_STEP * i.

Further details

Optionally, you can define your own palettes and palette-based effects. See the PaletteFx documentation for details.