diff options
author | Joel Challis <[email protected]> | 2023-11-26 18:36:45 +0000 |
---|---|---|
committer | GitHub <[email protected]> | 2023-11-27 05:36:45 +1100 |
commit | 1ed03f498fa204178c2696c510ac6a2cd8524e2d (patch) | |
tree | b97c1f983b7e4b57c007d0feedadd3ad3e39062b /users/drashna/rgb/readme.md | |
parent | 4908d4b1ca260efecf3613e6517aa3a6f2034876 (diff) | |
download | qmk_firmware-1ed03f498fa204178c2696c510ac6a2cd8524e2d.tar.gz qmk_firmware-1ed03f498fa204178c2696c510ac6a2cd8524e2d.zip |
Remove userspace keymaps (#22544)
Diffstat (limited to 'users/drashna/rgb/readme.md')
-rw-r--r-- | users/drashna/rgb/readme.md | 52 |
1 files changed, 0 insertions, 52 deletions
diff --git a/users/drashna/rgb/readme.md b/users/drashna/rgb/readme.md deleted file mode 100644 index 4deaa0a463..0000000000 --- a/users/drashna/rgb/readme.md +++ /dev/null @@ -1,52 +0,0 @@ -# RGB - -Custom RGB code can be disabled by setting `CUSTOM_RGBLIGHT = no` or `CUSTOM_RGB_MATRIX = no` in your `rules.mk` - -## RGB Light - -### Layer Indication Code - -At least for RGB Light, the `layer_state_set` function is used to detect the current highest layer, and change the underglow based on that layer. - -This works for both the regular layers, and for the default layers, too. - -I use the sethsv variants of the commands, so that different modes can be used, as well. - -RGB Matrix uses a custom, per board implementation, at the moment. - -### RGB Light Startup Animation - -On startup, if enabled, the board will cycle through the entire hue wheel, starting and ending on the default layer color. - -```c -void keyboard_post_init_rgb(void) { -#if defined(RGBLIGHT_ENABLE) && defined(RGBLIGHT_STARTUP_ANIMATION) - if (userspace_config.rgb_layer_change) { rgblight_enable_noeeprom(); } - if (rgblight_config.enable) { - layer_state_set_user(layer_state); - uint16_t old_hue = rgblight_config.hue; - rgblight_mode_noeeprom(RGBLIGHT_MODE_STATIC_LIGHT); - for (uint16_t i = 255; i > 0; i--) { - rgblight_sethsv_noeeprom( ( i + old_hue) % 255, 255, 255); - matrix_scan(); - wait_ms(10); - } - } -#endif - layer_state_set_user(layer_state); -} -``` - -This could probably benefit from some cleanup and better handling. - -## RGB Matrix - -### Idle Animation - -This feature can be toggled with the `RGB_IDL` keycode. - -This sets the mode to the Heatmap Animation when typing, but will switch to the cycle in animations when idle. - -### Layer Indication - -This sets the modifier keys to indicate the current layer state, with the option to override the behavior. |