Nick Brassel
2 years ago
2 changed files with 139 additions and 139 deletions
Split View
Diff Options
-
+75 -75keyboards/gmmk/pro/ansi/keymaps/stickandgum/config.h
-
+64 -64keyboards/gmmk/pro/ansi/keymaps/stickandgum/readme.md
+ 75
- 75
keyboards/gmmk/pro/ansi/keymaps/stickandgum/config.h
View File
| @ -1,75 +1,75 @@ | |||
| /* Copyright 2021 stickandgum | |||
| * | |||
| * This program is free software: you can redistribute it and/or modify | |||
| * it under the terms of the GNU General Public License as published by | |||
| * the Free Software Foundation, either version 2 of the License, or | |||
| * (at your option) any later version. | |||
| * | |||
| * This program is distributed in the hope that it will be useful, | |||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | |||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |||
| * GNU General Public License for more details. | |||
| * | |||
| * You should have received a copy of the GNU General Public License | |||
| * along with this program. If not, see <http://www.gnu.org/licenses/>. | |||
| */ | |||
| #pragma once | |||
| // I like NKRO.. but let's not force it. @drashna pointed out some older hardware has issues - Toggle it via keycode if you like. | |||
| // #define FORCE_NKRO | |||
| // At the time of this, there are 41 effects! That may be a bit too many to cycle through - keeping what I believe is the best. | |||
| #ifdef RGB_MATRIX_ENABLE | |||
| // #define RGB_MATRIX_STARTUP_MODE RGB_MATRIX_SOLID_COLOR | |||
| // Below added per: https://beta.docs.qmk.fm/using-qmk/hardware-features/lighting/feature_rgb_matrix#suspended-state-id-suspended-state | |||
| #define RGB_DISABLE_WHEN_USB_SUSPENDED | |||
| #define RGB_MATRIX_FRAMEBUFFER_EFFECTS // Heatmap, Rain | |||
| #define RGB_MATRIX_KEYPRESSES // REACTIVE, SPLASH modes | |||
| // Soon we need to ENABLE modes by DEFAULT soon as per: https://github.com/qmk/qmk_firmware/pull/13758 Thanks @noroadsleft | |||
| // #define DISABLE_RGB_MATRIX_SOLID_COLOR // BUILT IN (MAPPED!) Static single color. | |||
| // #define DISABLE_RGB_MATRIX_ALPHAS_MODS // Accenting various keys on the keyboard. | |||
| // #define DISABLE_RGB_MATRIX_GRADIENT_UP_DOWN // Top down rainbow! | |||
| #define DISABLE_RGB_MATRIX_GRADIENT_LEFT_RIGHT // Left Right Rainbow (the top-down is better imho). | |||
| // #define DISABLE_RGB_MATRIX_BREATHING // Built in (MAPPED!) | |||
| // #define DISABLE_RGB_MATRIX_BAND_SAT // Single hue band fading saturation scrolling left to right (with white) | |||
| // #define DISABLE_RGB_MATRIX_BAND_VAL // Single hue band fading brightness scrolling left to right (with black) | |||
| #define DISABLE_RGB_MATRIX_BAND_PINWHEEL_SAT // Single hue 3 blade spinning pinwheel fades sat (RGB_MATRIX_CYCLE_PINWHEEL) | |||
| #define DISABLE_RGB_MATRIX_BAND_PINWHEEL_VAL // See above | |||
| #define DISABLE_RGB_MATRIX_BAND_SPIRAL_SAT // See above | |||
| // #define DISABLE_RGB_MATRIX_BAND_SPIRAL_VAL // Single hue spinning spiral fades brightness (with black) | |||
| #define DISABLE_RGB_MATRIX_CYCLE_ALL // Full keyboard cycling through rainbow | |||
| // #define DISABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT // BUILT IN (MAPPED!) Full Rainbow Left to Right | |||
| #define DISABLE_RGB_MATRIX_CYCLE_UP_DOWN // Full gradient scrolling top to bottom | |||
| #define DISABLE_RGB_MATRIX_CYCLE_OUT_IN // Rainbow circles coming to center. | |||
| #define DISABLE_RGB_MATRIX_CYCLE_OUT_IN_DUAL // Two Rainbow circles coming to 1/3 and 2/3 points. | |||
| #define DISABLE_RGB_MATRIX_RAINBOW_MOVING_CHEVRON // Full gradent Chevron shapped scrolling left to right | |||
| // #define DISABLE_RGB_MATRIX_CYCLE_PINWHEEL // BUILT IN (MAPPED!) - Consider disabling this - my poor eyes. | |||
| #define DISABLE_RGB_MATRIX_CYCLE_SPIRAL // Full gradient spinning spiral around center of keyboard | |||
| #define DISABLE_RGB_MATRIX_DUAL_BEACON // Two rainbows spinning around keyboards | |||
| #define DISABLE_RGB_MATRIX_RAINBOW_BEACON // Similar to above. | |||
| #define DISABLE_RGB_MATRIX_RAINBOW_PINWHEELS // Enough of the spinning rainbows - we get it! :-) | |||
| #define DISABLE_RGB_MATRIX_RAINDROPS // Jellybeans are better. | |||
| // #define DISABLE_RGB_MATRIX_JELLYBEAN_RAINDROPS // Randomly changes a single key's hue and saturation - better than above. | |||
| #define DISABLE_RGB_MATRIX_HUE_BREATHING // Hue shifts up a slight ammount at the same time, then shifts back | |||
| #define DISABLE_RGB_MATRIX_HUE_PENDULUM // Hue shifts up a slight ammount in a wave to the right, then back to the left | |||
| #define DISABLE_RGB_MATRIX_HUE_WAVE // Hue shifts up a slight ammount and then back down in a wave to the right | |||
| // #define DISABLE_RGB_MATRIX_TYPING_HEATMAP // Hot keys! | |||
| // #define DISABLE_RGB_MATRIX_DIGITAL_RAIN // The Matrix! | |||
| #define DISABLE_RGB_MATRIX_SOLID_REACTIVE_SIMPLE // Key hits shown in current hue - all other keys black: wide slightly better imo | |||
| #define DISABLE_RGB_MATRIX_SOLID_REACTIVE // Key hits shown in current hue - all other keys shifted hue | |||
| // #define DISABLE_RGB_MATRIX_SOLID_REACTIVE_WIDE // Hue & value pulse around a single key hit then fades value out (black otherwise) | |||
| #define DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE // same as above but a bit too intense imo. | |||
| #define DISABLE_RGB_MATRIX_SOLID_REACTIVE_CROSS // Column and Row single color fade. | |||
| #define DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTICROSS // Column and Row single color fade. (Multi-keys) | |||
| #define DISABLE_RGB_MATRIX_SOLID_REACTIVE_NEXUS // Hue & value pulse away on the same column and row of key hit then fades | |||
| #define DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS // Hue & value pulse away on the same column and row of multi-key hit then fades | |||
| #define DISABLE_RGB_MATRIX_SPLASH // Full rainbow pulses from key hit. All else black. | |||
| #define DISABLE_RGB_MATRIX_MULTISPLASH // Full rainbow pulses from multi-keys. All else black. | |||
| #define DISABLE_RGB_MATRIX_SOLID_SPLASH // Single color pulses from key hit. All else black. (Using solid_reactive_wide instead). | |||
| #define DISABLE_RGB_MATRIX_SOLID_MULTISPLASH // Single color pulses from muli-keys. All else black. (Using solid_reactive_wide instead). | |||
| #endif | |||
| /* Copyright 2021 stickandgum | |||
| * | |||
| * This program is free software: you can redistribute it and/or modify | |||
| * it under the terms of the GNU General Public License as published by | |||
| * the Free Software Foundation, either version 2 of the License, or | |||
| * (at your option) any later version. | |||
| * | |||
| * This program is distributed in the hope that it will be useful, | |||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | |||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |||
| * GNU General Public License for more details. | |||
| * | |||
| * You should have received a copy of the GNU General Public License | |||
| * along with this program. If not, see <http://www.gnu.org/licenses/>. | |||
| */ | |||
| #pragma once | |||
| // I like NKRO.. but let's not force it. @drashna pointed out some older hardware has issues - Toggle it via keycode if you like. | |||
| // #define FORCE_NKRO | |||
| // At the time of this, there are 41 effects! That may be a bit too many to cycle through - keeping what I believe is the best. | |||
| #ifdef RGB_MATRIX_ENABLE | |||
| // #define RGB_MATRIX_STARTUP_MODE RGB_MATRIX_SOLID_COLOR | |||
| // Below added per: https://beta.docs.qmk.fm/using-qmk/hardware-features/lighting/feature_rgb_matrix#suspended-state-id-suspended-state | |||
| #define RGB_DISABLE_WHEN_USB_SUSPENDED | |||
| #define RGB_MATRIX_FRAMEBUFFER_EFFECTS // Heatmap, Rain | |||
| #define RGB_MATRIX_KEYPRESSES // REACTIVE, SPLASH modes | |||
| // Soon we need to ENABLE modes by DEFAULT soon as per: https://github.com/qmk/qmk_firmware/pull/13758 Thanks @noroadsleft | |||
| // #define DISABLE_RGB_MATRIX_SOLID_COLOR // BUILT IN (MAPPED!) Static single color. | |||
| // #define DISABLE_RGB_MATRIX_ALPHAS_MODS // Accenting various keys on the keyboard. | |||
| // #define DISABLE_RGB_MATRIX_GRADIENT_UP_DOWN // Top down rainbow! | |||
| #define DISABLE_RGB_MATRIX_GRADIENT_LEFT_RIGHT // Left Right Rainbow (the top-down is better imho). | |||
| // #define DISABLE_RGB_MATRIX_BREATHING // Built in (MAPPED!) | |||
| // #define DISABLE_RGB_MATRIX_BAND_SAT // Single hue band fading saturation scrolling left to right (with white) | |||
| // #define DISABLE_RGB_MATRIX_BAND_VAL // Single hue band fading brightness scrolling left to right (with black) | |||
| #define DISABLE_RGB_MATRIX_BAND_PINWHEEL_SAT // Single hue 3 blade spinning pinwheel fades sat (RGB_MATRIX_CYCLE_PINWHEEL) | |||
| #define DISABLE_RGB_MATRIX_BAND_PINWHEEL_VAL // See above | |||
| #define DISABLE_RGB_MATRIX_BAND_SPIRAL_SAT // See above | |||
| // #define DISABLE_RGB_MATRIX_BAND_SPIRAL_VAL // Single hue spinning spiral fades brightness (with black) | |||
| #define DISABLE_RGB_MATRIX_CYCLE_ALL // Full keyboard cycling through rainbow | |||
| // #define DISABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT // BUILT IN (MAPPED!) Full Rainbow Left to Right | |||
| #define DISABLE_RGB_MATRIX_CYCLE_UP_DOWN // Full gradient scrolling top to bottom | |||
| #define DISABLE_RGB_MATRIX_CYCLE_OUT_IN // Rainbow circles coming to center. | |||
| #define DISABLE_RGB_MATRIX_CYCLE_OUT_IN_DUAL // Two Rainbow circles coming to 1/3 and 2/3 points. | |||
| #define DISABLE_RGB_MATRIX_RAINBOW_MOVING_CHEVRON // Full gradent Chevron shapped scrolling left to right | |||
| // #define DISABLE_RGB_MATRIX_CYCLE_PINWHEEL // BUILT IN (MAPPED!) - Consider disabling this - my poor eyes. | |||
| #define DISABLE_RGB_MATRIX_CYCLE_SPIRAL // Full gradient spinning spiral around center of keyboard | |||
| #define DISABLE_RGB_MATRIX_DUAL_BEACON // Two rainbows spinning around keyboards | |||
| #define DISABLE_RGB_MATRIX_RAINBOW_BEACON // Similar to above. | |||
| #define DISABLE_RGB_MATRIX_RAINBOW_PINWHEELS // Enough of the spinning rainbows - we get it! :-) | |||
| #define DISABLE_RGB_MATRIX_RAINDROPS // Jellybeans are better. | |||
| // #define DISABLE_RGB_MATRIX_JELLYBEAN_RAINDROPS // Randomly changes a single key's hue and saturation - better than above. | |||
| #define DISABLE_RGB_MATRIX_HUE_BREATHING // Hue shifts up a slight ammount at the same time, then shifts back | |||
| #define DISABLE_RGB_MATRIX_HUE_PENDULUM // Hue shifts up a slight ammount in a wave to the right, then back to the left | |||
| #define DISABLE_RGB_MATRIX_HUE_WAVE // Hue shifts up a slight ammount and then back down in a wave to the right | |||
| // #define DISABLE_RGB_MATRIX_TYPING_HEATMAP // Hot keys! | |||
| // #define DISABLE_RGB_MATRIX_DIGITAL_RAIN // The Matrix! | |||
| #define DISABLE_RGB_MATRIX_SOLID_REACTIVE_SIMPLE // Key hits shown in current hue - all other keys black: wide slightly better imo | |||
| #define DISABLE_RGB_MATRIX_SOLID_REACTIVE // Key hits shown in current hue - all other keys shifted hue | |||
| // #define DISABLE_RGB_MATRIX_SOLID_REACTIVE_WIDE // Hue & value pulse around a single key hit then fades value out (black otherwise) | |||
| #define DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE // same as above but a bit too intense imo. | |||
| #define DISABLE_RGB_MATRIX_SOLID_REACTIVE_CROSS // Column and Row single color fade. | |||
| #define DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTICROSS // Column and Row single color fade. (Multi-keys) | |||
| #define DISABLE_RGB_MATRIX_SOLID_REACTIVE_NEXUS // Hue & value pulse away on the same column and row of key hit then fades | |||
| #define DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS // Hue & value pulse away on the same column and row of multi-key hit then fades | |||
| #define DISABLE_RGB_MATRIX_SPLASH // Full rainbow pulses from key hit. All else black. | |||
| #define DISABLE_RGB_MATRIX_MULTISPLASH // Full rainbow pulses from multi-keys. All else black. | |||
| #define DISABLE_RGB_MATRIX_SOLID_SPLASH // Single color pulses from key hit. All else black. (Using solid_reactive_wide instead). | |||
| #define DISABLE_RGB_MATRIX_SOLID_MULTISPLASH // Single color pulses from muli-keys. All else black. (Using solid_reactive_wide instead). | |||
| #endif | |||
+ 64
- 64
keyboards/gmmk/pro/ansi/keymaps/stickandgum/readme.md
View File
| @ -1,64 +1,64 @@ | |||
| # Glorious GMMK Pro / ANSI - Enhanced Keyboard | |||
| Tried to incorporate full featured GMMK Pro keyboard functionality without adding unnecessary features. Included Scroll Lock and Caps LEDs. NKRO is on by default. | |||
| SHIFT and Ctrl keys for scrolling with the rotary, Added Fn-keys for Screen Brightness, NKRO, PowerOff, Suspend, App Shortcuts, and RGB Toggle/Modifications | |||
| Trimmed down the amazing 41 currently built-in RGB effects down to about 13 or so reasonable effects that feel are just enough for your entertainment without being too excessive. | |||
| BIG thank you to [AndreBrait](https://github.com/andrebrait), And of course, @drashna and @filterpaper and the entire discord community. | |||
| * Keymap Creator: [StickAndGum](https://github.com/StickAndGum) | |||
| * Keyboard: [More info on GMMK Pro](https://www.pcgamingrace.com/products/glorious-gmmk-pro-75-barebone-black) | |||
| * Controller [STM32F303CCT6](https://www.st.com/en/microcontrollers-microprocessors/stm32f303.html) | |||
| * Layout: | |||
|  | |||
| Features are as follows: | |||
| Rotary: | |||
| - Default: Volume Up/Down | |||
| - Shift: Mouse Wheel Down/Up | |||
| - Ctrl: Page Down/Up | |||
| Top/Default Layer: | |||
| - Print Screen -> Print Screen (Left of rotary) | |||
| - Delete -> Home (Under Rotary) | |||
| - Right Alt -> Delete (Right of Spacebar) | |||
| - All other keys defaults. | |||
| Fn Layer: | |||
| - Fn + \ -> Bootloader Mode (Can also hold ESC while powering up) - If hit by mistake, just unplug and replug in. | |||
| - Fn + Backspace -> Insert | |||
| - Fn + Print -> Pause/Break | |||
| - Fn + Home -> Scroll Lock (Lights up white!) | |||
| - Fn + Del (right of space) -> Right-Alt key. | |||
| - Fn + RCtrl (right of Fn) -> Menu/App key. | |||
| - Fn + N -> Toggle NKRO (Defaults to Enabled) | |||
| - Fn + End -> Power Off Computer | |||
| - Fn + F12 -> Suspend Computer | |||
| - Fn + F11 -> Wake Computer (Necessary on MAC OS?) | |||
| - Fn + Page Up / Down -> Laptop Screen Brightness Up/Down | |||
| - Fn + F1 - F5 -> Launch Calc, My Comp (Explorer), Media Player, Mail Client, Web Browser Home. | |||
| - Fn + Up, Down, Left, Right Arrows -> Media Play, Stop, Previous, Next respectively. | |||
| - RGB Information: | |||
| - Toggle for RGB via Fn-r (CAPS & SCROLL still Light/Indicate) | |||
| - CAPS: Side Light Rainbow Indicators and Left-side RED Indicators | |||
| - Scroll: Fn-Home (Under Rotary) white indicator. | |||
| - Modifiers identified around most of the edge of keyboard / Side lights accented (Fn-1 looks GREAT IMHO) | |||
| - RGB Modifing (all via Function key) all via wasdqerf (common gaming keys) - easy to remember. | |||
| - Fn + r -> Toggle RGB | |||
| - Fn + w,s -> Brightness Up, Down | |||
| - Fn + a,d -> Cycle Forward/Backward through rgb effects | |||
| - Fn + q -> Increase or Decrease Saturation (use SHIFT key to lower) | |||
| - Fn + e -> Increase or Decrease Hue/Color (use SHIFT key to lower) | |||
| - Fn + f -> Increase or Decrease Speed (Using "F" for Fast!) (Use SHIFT for slower) | |||
| - Fn + ~, 0-9, - = keys (2nd row keys) -> 13 RGB different effects arranged to my liking. Fn-1 is my favorite. | |||
| - Fn + L -> My easter egg... "QMK rocks!" | |||
| - Known issues: | |||
| - The Heatmap and Matrix FrameBuffer effects (Fn - and =) are a bit buggy - F-keys light up when they shouldn't and the Caps/Scroll lights don't turn off properly when using. Just change the effect to something else to fix this. | |||
| - If you find a fix for this, please let me know. | |||
| See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). | |||
| # Glorious GMMK Pro / ANSI - Enhanced Keyboard | |||
| Tried to incorporate full featured GMMK Pro keyboard functionality without adding unnecessary features. Included Scroll Lock and Caps LEDs. NKRO is on by default. | |||
| SHIFT and Ctrl keys for scrolling with the rotary, Added Fn-keys for Screen Brightness, NKRO, PowerOff, Suspend, App Shortcuts, and RGB Toggle/Modifications | |||
| Trimmed down the amazing 41 currently built-in RGB effects down to about 13 or so reasonable effects that feel are just enough for your entertainment without being too excessive. | |||
| BIG thank you to [AndreBrait](https://github.com/andrebrait), And of course, @drashna and @filterpaper and the entire discord community. | |||
| * Keymap Creator: [StickAndGum](https://github.com/StickAndGum) | |||
| * Keyboard: [More info on GMMK Pro](https://www.pcgamingrace.com/products/glorious-gmmk-pro-75-barebone-black) | |||
| * Controller [STM32F303CCT6](https://www.st.com/en/microcontrollers-microprocessors/stm32f303.html) | |||
| * Layout: | |||
|  | |||
| Features are as follows: | |||
| Rotary: | |||
| - Default: Volume Up/Down | |||
| - Shift: Mouse Wheel Down/Up | |||
| - Ctrl: Page Down/Up | |||
| Top/Default Layer: | |||
| - Print Screen -> Print Screen (Left of rotary) | |||
| - Delete -> Home (Under Rotary) | |||
| - Right Alt -> Delete (Right of Spacebar) | |||
| - All other keys defaults. | |||
| Fn Layer: | |||
| - Fn + \ -> Bootloader Mode (Can also hold ESC while powering up) - If hit by mistake, just unplug and replug in. | |||
| - Fn + Backspace -> Insert | |||
| - Fn + Print -> Pause/Break | |||
| - Fn + Home -> Scroll Lock (Lights up white!) | |||
| - Fn + Del (right of space) -> Right-Alt key. | |||
| - Fn + RCtrl (right of Fn) -> Menu/App key. | |||
| - Fn + N -> Toggle NKRO (Defaults to Enabled) | |||
| - Fn + End -> Power Off Computer | |||
| - Fn + F12 -> Suspend Computer | |||
| - Fn + F11 -> Wake Computer (Necessary on MAC OS?) | |||
| - Fn + Page Up / Down -> Laptop Screen Brightness Up/Down | |||
| - Fn + F1 - F5 -> Launch Calc, My Comp (Explorer), Media Player, Mail Client, Web Browser Home. | |||
| - Fn + Up, Down, Left, Right Arrows -> Media Play, Stop, Previous, Next respectively. | |||
| - RGB Information: | |||
| - Toggle for RGB via Fn-r (CAPS & SCROLL still Light/Indicate) | |||
| - CAPS: Side Light Rainbow Indicators and Left-side RED Indicators | |||
| - Scroll: Fn-Home (Under Rotary) white indicator. | |||
| - Modifiers identified around most of the edge of keyboard / Side lights accented (Fn-1 looks GREAT IMHO) | |||
| - RGB Modifing (all via Function key) all via wasdqerf (common gaming keys) - easy to remember. | |||
| - Fn + r -> Toggle RGB | |||
| - Fn + w,s -> Brightness Up, Down | |||
| - Fn + a,d -> Cycle Forward/Backward through rgb effects | |||
| - Fn + q -> Increase or Decrease Saturation (use SHIFT key to lower) | |||
| - Fn + e -> Increase or Decrease Hue/Color (use SHIFT key to lower) | |||
| - Fn + f -> Increase or Decrease Speed (Using "F" for Fast!) (Use SHIFT for slower) | |||
| - Fn + ~, 0-9, - = keys (2nd row keys) -> 13 RGB different effects arranged to my liking. Fn-1 is my favorite. | |||
| - Fn + L -> My easter egg... "QMK rocks!" | |||
| - Known issues: | |||
| - The Heatmap and Matrix FrameBuffer effects (Fn - and =) are a bit buggy - F-keys light up when they shouldn't and the Caps/Scroll lights don't turn off properly when using. Just change the effect to something else to fix this. | |||
| - If you find a fix for this, please let me know. | |||
| See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). | |||