config.h 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156
  1. /* Copyright 2020 elijahblake81
  2. *
  3. * This program is free software: you can redistribute it and/or modify
  4. * it under the terms of the GNU General Public License as published by
  5. * the Free Software Foundation, either version 2 of the License, or
  6. * (at your option) any later version.
  7. *
  8. * This program is distributed in the hope that it will be useful,
  9. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11. * GNU General Public License for more details.
  12. *
  13. * You should have received a copy of the GNU General Public License
  14. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  15. */
  16. #pragma once
  17. #define MODS_SHIFT (get_mods() & MOD_MASK_SHIFT)
  18. #define MODS_CTRL (get_mods() & MOD_MASK_CTRL)
  19. #define MODS_ALT (get_mods() & MOD_MASK_ALT)
  20. // #define IS_COMMAND() (get_mods() == MOD_MASK_SHIFT) // Key combination that allows the use of magic commands (useful for debugging)
  21. // #define NO_DEBUG // Disable debugging
  22. // #define NO_PRINT // Disable printing/debugging using hid_listen
  23. // #define NO_ACTION_LAYER // Disable layers
  24. // #define NO_ACTION_TAPPING // Disable tap dance and other tapping features
  25. // #define NO_ACTION_ONESHOT // Disable one-shot modifiers
  26. // #define NO_ACTION_MACRO // Disable old style macro handling: MACRO() & action_get_macro
  27. // #define TERMINAL_HELP
  28. // #define MOUSEKEY_INTERVAL 20
  29. // #define MOUSEKEY_DELAY 0
  30. // #define MOUSEKEY_TIME_TO_MAX 60
  31. // #define MOUSEKEY_MAX_SPEED 10
  32. // #define MOUSEKEY_WHEEL_DELAY 0
  33. #define FORCE_NKRO // NKRO by default requires to be turned on, this forces it on during keyboard startup regardless of EEPROM setting. NKRO can still be turned off but will be turned on again if the keyboard reboots.
  34. // #define QMK_KEYS_PER_SCAN 4 // Allows sending more than one key per scan. By default, only one key event gets sent via process_record() per scan. This has little impact on most typing, but if you're doing a lot of chords, or your scan rate is slow to begin with, you can have some delay in processing key events. Each press and release is a separate event. For a keyboard with 1ms or so scan times, even a very fast typist isn't going to produce the 500 keystrokes a second needed to actually get more than a few ms of delay from this. But if you're doing chording on something with 3-4ms scan times? You probably want this.
  35. // #define STRICT_LAYER_RELEASE // Force a key release to be evaluated using the current layer stack instead of remembering which layer it came from (used for advanced cases)
  36. // #define LOCKING_SUPPORT_ENABLE // Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap
  37. // #define LOCKING_RESYNC_ENABLE // Tries to keep switch state consistent with keyboard LED state
  38. // #define TAPPING_TERM 200 // How long before a tap becomes a hold, if set above 500, a key tapped during the tapping term will turn it into a hold too
  39. // #define TAPPING_TERM_PER_KEY // Enabling to allow to tweak individual keys
  40. // #define RETRO_TAPPING // Tap anyway, even after TAPPING_TERM, if there was no other key interruption between press and release
  41. // #define TAPPING_TOGGLE 2 // How many taps before triggering the toggle
  42. // #define PERMISSIVE_HOLD // Makes tap and hold keys trigger the hold if another key is pressed before releasing, even if it hasn't hit the TAPPING_TERM. See Permissive Hold for details
  43. // #define IGNORE_MOD_TAP_INTERRUPT // Makes it possible to do rolling combos (zx) with keys that convert to other keys on hold, by enforcing the TAPPING_TERM for both keys. See Mod tap interrupt for details
  44. // #define TAPPING_FORCE_HOLD // Makes it possible to use a dual role key as modifier shortly after having been tapped. See Hold after tap. Breaks any Tap Toggle functionality (TT or the One Shot Tap Toggle)
  45. // #define LEADER_TIMEOUT 300 // How long before the leader key times out. If you're having issues finishing the sequence before it times out, you may need to increase the timeout setting. Or you may want to enable the LEADER_PER_KEY_TIMING option, which resets the timeout after each key is tapped.
  46. // #define LEADER_PER_KEY_TIMING // Sets the timer for leader key chords to run on each key press rather than overall
  47. // #define LEADER_KEY_STRICT_KEY_PROCESSING // Disables keycode filtering for Mod-Tap and Layer-Tap keycodes. Eg, if you enable this, you would need to specify MT(MOD_CTL, KC_A) if you want to use KC_A.
  48. // #define ONESHOT_TIMEOUT 3000 // How long before oneshot times out
  49. // #define ONESHOT_TAP_TOGGLE 2 // How many taps before oneshot toggle is triggered
  50. // #define COMBO_COUNT 2 // Set this to the number of combos that you're using in the Combo feature.
  51. // #define COMBO_TERM 200 // How long for the Combo keys to be detected. Defaults to TAPPING_TERM if not defined.
  52. // #define TAP_CODE_DELAY 100 // Sets the delay between register_code and unregister_code, if you're having issues with it registering properly (common on VUSB boards). The value is in milliseconds.
  53. // #define TAP_HOLD_CAPS_DELAY 80 // Sets the delay for Tap Hold keys (LT, MT) when using KC_CAPSLOCK keycode, as this has some special handling on MacOS. The value is in milliseconds, and defaults to 80 ms if not defined. For macOS, you may want to set this to 200 or higher.
  54. #define RGB_MATRIX_FRAMEBUFFER_EFFECTS
  55. #define RGB_MATRIX_KEYPRESSES // reacts to keypresses
  56. // #define RGB_MATRIX_KEYRELEASES // reacts to keyreleases (instead of keypresses)
  57. //Teal and Blue
  58. //#define RGB_MATRIX_STARTUP_HUE 127 // Default boot color
  59. //#define RGB_MATRIX_STARTUP_SPD 47 // Used to determine the color for the modifiers
  60. //Teal and Blue
  61. //#define RGB_MATRIX_STARTUP_HUE 120 // Default boot color
  62. //#define RGB_MATRIX_STARTUP_SPD 50 //Used to determine the color for the modifiers
  63. //QMK HSV is based on 255 value wheel rather than 360
  64. //Cyan and Yellow
  65. //#define RGB_MATRIX_STARTUP_HUE 127 // Default boot color
  66. //#define RGB_MATRIX_STARTUP_SPD 177
  67. //Cyan and Green
  68. //#define RGB_MATRIX_STARTUP_HUE 127 // Default boot color
  69. //#define RGB_MATRIX_STARTUP_SPD 215
  70. // #define RGB_MATRIX_STARTUP_VAL RGB_MATRIX_MAXIMUM_BRIGHTNESS
  71. #define RGB_MATRIX_STARTUP_MODE RGB_MATRIX_SOLID_REACTIVE // Sets the default mode, if none has been set
  72. #define RGB_MATRIX_STARTUP_HUE 180 //purple alphas with green background when pressed.
  73. // #define RGBLIGHT_HUE_STEP 12 // Units to step when in/decreasing hue
  74. // #define RGBLIGHT_SAT_STEP 25 // Units to step when in/decreasing saturation
  75. // #define RGBLIGHT_VAL_STEP 12 // Units to step when in/decreasing value (brightness)
  76. // #define RGB_DISABLE_AFTER_TIMEOUT 0 // number of ticks to wait until disabling effects
  77. // #define RGB_DISABLE_WHEN_USB_SUSPENDED // turn off effects when suspended
  78. // #define RGB_MATRIX_LED_PROCESS_LIMIT (DRIVER_LED_TOTAL + 4) / 5 // limits the number of LEDs to process in an animation per task run (increases keyboard responsiveness)
  79. // #define RGB_MATRIX_LED_FLUSH_LIMIT 16 // limits in milliseconds how frequently an animation will update the LEDs. 16 (16ms) is equivalent to limiting to 60fps (increases keyboard responsiveness)
  80. #define RGBLIGHT_ANIMATIONS // Run RGB animations
  81. // #define RGBLIGHT_ANIMATIONS // Enable all additional animation modes.
  82. #define RGBLIGHT_EFFECT_ALTERNATING // Enable alternating animation mode.
  83. #define RGBLIGHT_EFFECT_BREATHING // Enable breathing animation mode.
  84. // #define RGBLIGHT_EFFECT_CHRISTMAS // Enable christmas animation mode.
  85. // #define RGBLIGHT_EFFECT_KNIGHT // Enable knight animation mode.
  86. // #define RGBLIGHT_EFFECT_RAINBOW_MOOD // Enable rainbow mood animation mode.
  87. // #define RGBLIGHT_EFFECT_RAINBOW_SWIRL // Enable rainbow swirl animation mode.
  88. // #define RGBLIGHT_EFFECT_RGB_TEST // Enable RGB test animation mode.
  89. // #define RGBLIGHT_EFFECT_SNAKE // Enable snake animation mode.
  90. // #define RGBLIGHT_EFFECT_STATIC_GRADIENT // Enable static gradient mode.
  91. // #define RGBLIGHT_EFFECT_BREATHE_CENTER // If defined, used to calculate the curve for the breathing animation. Valid values are 1.0 to 2.7
  92. // #define RGBLIGHT_EFFECT_BREATHE_MAX 255 // The maximum brightness for the breathing mode. Valid values are 1 to 255
  93. // #define RGBLIGHT_EFFECT_CHRISTMAS_INTERVAL 1000 // How long to wait between light changes for the "Christmas" animation, in milliseconds
  94. // #define RGBLIGHT_EFFECT_CHRISTMAS_STEP 2 // The number of LEDs to group the red/green colors by for the "Christmas" animation
  95. // #define RGBLIGHT_EFFECT_KNIGHT_LED_NUM RGBLED_NUM // The number of LEDs to have the "Knight" animation travel
  96. // #define RGBLIGHT_EFFECT_KNIGHT_LENGTH 3 // The number of LEDs to light up for the "Knight" animation
  97. // #define RGBLIGHT_EFFECT_KNIGHT_OFFSET 0 // The number of LEDs to start the "Knight" animation from the start of the strip by
  98. // #define RGBLIGHT_RAINBOW_SWIRL_RANGE 255 // Range adjustment for the rainbow swirl effect to get different swirls
  99. // #define RGBLIGHT_EFFECT_SNAKE_LENGTH 4 // The number of LEDs to light up for the "Snake" animation
  100. // This list in in the correct mode order. Next mode is the following line, previous mode is previous line. Loops around.
  101. // #define DISABLE_RGB_MATRIX_SOLID_COLOR // Static single hue, no speed support
  102. // #define DISABLE_RGB_MATRIX_ALPHAS_MODS // Static dual hue, speed is hue for secondary hue
  103. // #define DISABLE_RGB_MATRIX_GRADIENT_UP_DOWN // Static gradient top to bottom, speed controls how much gradient changes
  104. // #define DISABLE_RGB_MATRIX_BREATHING // Single hue brightness cycling animation
  105. // #define DISABLE_RGB_MATRIX_BAND_SAT // Single hue band fading saturation scrolling left to right
  106. // #define DISABLE_RGB_MATRIX_BAND_VAL // Single hue band fading brightness scrolling left to right
  107. // #define DISABLE_RGB_MATRIX_BAND_PINWHEEL_SAT // Single hue 3 blade spinning pinwheel fades saturation
  108. // #define DISABLE_RGB_MATRIX_BAND_PINWHEEL_VAL // Single hue 3 blade spinning pinwheel fades brightness
  109. // #define DISABLE_RGB_MATRIX_BAND_SPIRAL_SAT // Single hue spinning spiral fades saturation
  110. // #define DISABLE_RGB_MATRIX_BAND_SPIRAL_VAL // Single hue spinning spiral fades brightness
  111. // #define DISABLE_RGB_MATRIX_CYCLE_ALL // Full keyboard solid hue cycling through full gradient
  112. // #define DISABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT // Full gradient scrolling left to right
  113. // #define DISABLE_RGB_MATRIX_CYCLE_UP_DOWN // Full gradient scrolling top to bottom
  114. // #define DISABLE_RGB_MATRIX_CYCLE_OUT_IN // Full gradient scrolling out to in
  115. // #define DISABLE_RGB_MATRIX_CYCLE_OUT_IN_DUAL // Full dual gradients scrolling out to in
  116. // #define DISABLE_RGB_MATRIX_RAINBOW_MOVING_CHEVRON // Full gradent Chevron shapped scrolling left to right
  117. // #define DISABLE_RGB_MATRIX_CYCLE_PINWHEEL // Full gradient spinning pinwheel around center of keyboard
  118. // #define DISABLE_RGB_MATRIX_CYCLE_SPIRAL // Full gradient spinning spiral around center of keyboard
  119. // #define DISABLE_RGB_MATRIX_DUAL_BEACON // Full gradient spinning around center of keyboard
  120. // #define DISABLE_RGB_MATRIX_RAINBOW_BEACON // Full tighter gradient spinning around center of keyboard
  121. // #define DISABLE_RGB_MATRIX_RAINBOW_PINWHEELS // Full dual gradients spinning two halfs of keyboard
  122. // #define DISABLE_RGB_MATRIX_RAINDROPS // Randomly changes a single key's hue
  123. // #define DISABLE_RGB_MATRIX_JELLYBEAN_RAINDROPS // Randomly changes a single key's hue and saturation
  124. // =================================================== Requires RGB_MATRIX_FRAMEBUFFER_EFFECTS =============================================================
  125. // #define DISABLE_RGB_MATRIX_TYPING_HEATMAP // How hot is your WPM!
  126. #define DISABLE_RGB_MATRIX_DIGITAL_RAIN // That famous computer simulation
  127. // =================================================== RGB_MATRIX_KEYPRESSES OR RGB_MATRIX_KEYRELEASES =====================================================
  128. // #define DISABLE_RGB_MATRIX_SOLID_REACTIVE // Static single hue, pulses keys hit to shifted hue then fades to current hue
  129. // #define DISABLE_RGB_MATRIX_SOLID_REACTIVE_SIMPLE // Pulses keys hit to hue & value then fades value out
  130. // #define DISABLE_RGB_MATRIX_SOLID_REACTIVE_WIDE // Hue & value pulse near a single key hit then fades value out
  131. // #define DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE // Hue & value pulse near multiple key hits then fades value out
  132. // #define DISABLE_RGB_MATRIX_SOLID_REACTIVE_CROSS // Hue & value pulse the same column and row of a single key hit then fades value out
  133. // #define DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTICROSS // Hue & value pulse the same column and row of multiple key hits then fades value out
  134. // #define DISABLE_RGB_MATRIX_SOLID_REACTIVE_NEXUS // Hue & value pulse away on the same column and row of a single key hit then fades value out
  135. // #define DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS // Hue & value pulse away on the same column and row of multiple key hits then fades value out
  136. // #define DISABLE_RGB_MATRIX_SPLASH // Full gradient & value pulse away from a single key hit then fades value out
  137. // #define DISABLE_RGB_MATRIX_MULTISPLASH // Full gradient & value pulse away from multiple key hits then fades value out
  138. // #define DISABLE_RGB_MATRIX_SOLID_SPLASH // Hue & value pulse away from a single key hit then fades value out
  139. // #define DISABLE_RGB_MATRIX_SOLID_MULTISPLASH // Hue & value pulse away from multiple key hits then fades value out