Add macOS-friendly keymap for GMMK Pro (ANSI) (#14333)

* Add macOS keymap for GMMK Pro (ANSI)

* Change macOS keymap directory name to lowercase

* Add toggleable layer with alternative keymap for function row

* Update readme

1 files changed, 80 insertions, 0 deletions

diff --git a/keyboards/gmmk/pro/ansi/keymaps/macos/config.h b/keyboards/gmmk/pro/ansi/keymaps/macos/config.h
new file mode 100644
index 0000000000..799c5d9593
--- /dev/null
+++ b/keyboards/gmmk/pro/ansi/keymaps/macos/config.h
@@ -0,0 +1,80 @@
+/* Copyright 2021 zvuc <https://github.com/zvuc>
+ *
+ * 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
+
+// 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_DISABLE_TIMEOUT 1200000     // 20 minutes (20 * 60 * 1000ms)
+
+// #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
+
+// Effects
+    #define RGB_MATRIX_FRAMEBUFFER_EFFECTS  // Heatmap, Rain
+    #define RGB_MATRIX_KEYPRESSES           // REACTIVE, SPLASH modes
+
+    // Disable effects you don't like.
+    // Soon, you'll have to explicitly enable effects you want: https://github.com/qmk/qmk_firmware/pull/13758
+    // #define DISABLE_RGB_MATRIX_SOLID_COLOR,             // Static single hue, no speed support
+    // #define DISABLE_RGB_MATRIX_ALPHAS_MODS,             // Static dual hue, speed is hue for secondary hue
+    // #define DISABLE_RGB_MATRIX_GRADIENT_UP_DOWN,        // Static gradient top to bottom, speed controls how much gradient changes
+    // #define DISABLE_RGB_MATRIX_GRADIENT_LEFT_RIGHT,     // Static gradient left to right, speed controls how much gradient changes
+    // #define DISABLE_RGB_MATRIX_BREATHING,               // Single hue brightness cycling animation
+    // #define DISABLE_RGB_MATRIX_BAND_SAT,                // Single hue band fading saturation scrolling left to right
+    // #define DISABLE_RGB_MATRIX_BAND_VAL,                // Single hue band fading brightness scrolling left to right
+    // #define DISABLE_RGB_MATRIX_BAND_PINWHEEL_SAT,       // Single hue 3 blade spinning pinwheel fades saturation
+    // #define DISABLE_RGB_MATRIX_BAND_PINWHEEL_VAL,       // Single hue 3 blade spinning pinwheel fades brightness
+    // #define DISABLE_RGB_MATRIX_BAND_SPIRAL_SAT,         // Single hue spinning spiral fades saturation
+    // #define DISABLE_RGB_MATRIX_BAND_SPIRAL_VAL,         // Single hue spinning spiral fades brightness
+    // #define DISABLE_RGB_MATRIX_CYCLE_ALL,               // Full keyboard solid hue cycling through full gradient
+    // #define DISABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT,        // Full gradient scrolling left to right
+    // #define DISABLE_RGB_MATRIX_CYCLE_UP_DOWN,           // Full gradient scrolling top to bottom
+    // #define DISABLE_RGB_MATRIX_CYCLE_OUT_IN,            // Full gradient scrolling out to in
+    // #define DISABLE_RGB_MATRIX_CYCLE_OUT_IN_DUAL,       // Full dual gradients scrolling out to in
+    // #define DISABLE_RGB_MATRIX_RAINBOW_MOVING_CHEVRON,  // Full gradent Chevron shapped scrolling left to right
+    // #define DISABLE_RGB_MATRIX_CYCLE_PINWHEEL,          // Full gradient spinning pinwheel around center of keyboard
+    // #define DISABLE_RGB_MATRIX_CYCLE_SPIRAL,            // Full gradient spinning spiral around center of keyboard
+    // #define DISABLE_RGB_MATRIX_DUAL_BEACON,             // Full gradient spinning around center of keyboard
+    // #define DISABLE_RGB_MATRIX_RAINBOW_BEACON,          // Full tighter gradient spinning around center of keyboard
+    // #define DISABLE_RGB_MATRIX_RAINBOW_PINWHEELS,       // Full dual gradients spinning two halfs of keyboard
+    // #define DISABLE_RGB_MATRIX_RAINDROPS,               // Randomly changes a single key's hue
+    // #define DISABLE_RGB_MATRIX_JELLYBEAN_RAINDROPS,     // Randomly changes a single key's hue and saturation
+    // #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
+
+    // Framebuffer effects
+    // #define DISABLE_RGB_MATRIX_TYPING_HEATMAP,          // How hot is your WPM!
+    // #define DISABLE_RGB_MATRIX_DIGITAL_RAIN,            // That famous computer simulation
+
+    // Reactive effects
+    // #define DISABLE_RGB_MATRIX_SOLID_REACTIVE_SIMPLE,      // Pulses keys hit to hue & value then fades value out
+    // #define DISABLE_RGB_MATRIX_SOLID_REACTIVE,             // Static single hue, pulses keys hit to shifted hue then fades to current hue
+    // #define DISABLE_RGB_MATRIX_SOLID_REACTIVE_WIDE         // Hue & value pulse near a single key hit then fades value out
+    // #define DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE    // Hue & value pulse near multiple key hits then fades value out
+    // #define DISABLE_RGB_MATRIX_SOLID_REACTIVE_CROSS        // Hue & value pulse the same column and row of a single key hit then fades value out
+    // #define DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTICROSS   // Hue & value pulse the same column and row of multiple key hits then fades value out
+    // #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
+    // #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
+    // #define DISABLE_RGB_MATRIX_SPLASH,                     // Full gradient & value pulse away from a single key hit then fades value out
+    // #define DISABLE_RGB_MATRIX_MULTISPLASH,                // Full gradient & value pulse away from multiple key hits then fades value out
+    // #define DISABLE_RGB_MATRIX_SOLID_SPLASH,               // Hue & value pulse away from a single key hit then fades value out
+    // #define DISABLE_RGB_MATRIX_SOLID_MULTISPLASH,          // Hue & value pulse away from multiple key hits then fades value out
+
+#endif