Add vnmm keymaps and userspace (#20446)

Co-authored-by: Pablo Martínez <58857054+elpekenin@users.noreply.github.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>

8 files changed, 338 insertions, 0 deletions

diff --git a/users/vnmm/config.h b/users/vnmm/config.h
new file mode 100644
index 0000000000..3642c5784c
--- /dev/null
+++ b/users/vnmm/config.h
@@ -0,0 +1,70 @@
+/*
+ * 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
+
+// All of these config options can be changed by keyboard in their config.h
+// These are all just the defaults I like for most of my keyboards
+
+#ifndef RGB_MATRIX_TIMEOUT
+// If the keyboard is unused for 20 minutes then just turn off RGB
+#    define RGB_MATRIX_TIMEOUT 1200000 // 20 minutes (20 * 60 * 1000ms)
+
+#endif
+
+#ifndef CAPS_LOCK_INDICATOR_COLOR
+// When caps lock is pressed, the letter keys, caps lock, and both shift keys, will light up this color.
+#    define CAPS_LOCK_INDICATOR_COLOR RGB_RED
+#endif
+
+#ifndef SHIFT_INDICATOR_COLOR
+// If defined also light up alphabet keys when either shift is held
+#    define SHIFT_INDICATOR_COLOR RGB_WHITE
+#endif
+
+#ifndef CAPS_LOCK_INDICATOR_OTHER
+// When caps lock is pressed, all other keys will light up this color
+// #define CAPS_LOCK_INDICATOR_OTHER RGB_WHITE
+#endif
+
+#ifndef CAPS_LOCK_INDICATOR_LIGHT_ALPHAS
+// All alphabet keys will light up, othe rwise just caps lock.
+#    define CAPS_LOCK_INDICATOR_LIGHT_ALPHAS
+#endif
+
+#ifndef FN_LAYER_TRANSPARENT_KEYS_COLOR
+// Keys not defined in the current layer will use this color
+#    define FN_LAYER_TRANSPARENT_KEYS_COLOR RGB_OFF
+#endif
+
+// Keys defined in the current layer will use this color
+#ifndef FN_LAYER_KEYS_COLOR
+// #define FN_LAYER_KEYS_COLOR RGB_WHITE
+#endif
+
+#ifndef CURRENT_LAYER_INDICATOR_COLOR
+// If a key on a FN layer changes the default layer to the current layer, light up this color
+#    define CURRENT_LAYER_INDICATOR_COLOR RGB_WHITE
+#endif
+
+#ifndef NKRO_INDICATOR_COLOR
+// If NKRO is enabled, the key on the fn layer that toggles it will light up this color
+#    define NKRO_INDICATOR_COLOR RGB_WHITE
+#endif
+
+// Don't light up my whole room when the pc is asleep
+#ifndef RGB_DISABLE_WHEN_USB_SUSPENDED
+#    define RGB_DISABLE_WHEN_USB_SUSPENDED
+#endif
diff --git a/users/vnmm/keymap_user.h b/users/vnmm/keymap_user.h
new file mode 100644
index 0000000000..2262910bcc
--- /dev/null
+++ b/users/vnmm/keymap_user.h
@@ -0,0 +1,41 @@
+/* Copyright 2021
+ *
+ * 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
+
+#ifdef DYNAMIC_KEYMAP_LAYER_COUNT
+#undef DYNAMIC_KEYMAP_LAYER_COUNT
+#endif
+#define DYNAMIC_KEYMAP_LAYER_COUNT 5
+
+#define WIN_F MO(WIN_FN)
+#define MAC_F MO(MAC_FN)
+#define EXT_F MO(EXTRA_FN)
+
+#define DF_WIN DF(WIN_BASE)
+#define DF_MAC DF(MAC_BASE)
+
+// clang-format off
+
+enum layers {
+    WIN_BASE,
+    MAC_BASE,
+    WIN_FN,
+    MAC_FN,
+    EXTRA_FN
+};
+
+// clang-format on
diff --git a/users/vnmm/readme.md b/users/vnmm/readme.md
new file mode 100644
index 0000000000..637e92c063
--- /dev/null
+++ b/users/vnmm/readme.md
@@ -0,0 +1,10 @@
+# Vnmm's stuff
+
+This keymap builds on archrovisual's but with some changes and uses the default key placements
+
+## Features
+
+-   Alphabet keys light up red when caps lock is on or shift is on
+-   Pressing FN shows keys that have a definition
+-   Via enabled
+-   Quick reset with fn+space
diff --git a/users/vnmm/rgb_matrix_user.c b/users/vnmm/rgb_matrix_user.c
new file mode 100644
index 0000000000..c85f86782e
--- /dev/null
+++ b/users/vnmm/rgb_matrix_user.c
@@ -0,0 +1,140 @@
+/*
+ *
+ * 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/>.
+ */
+
+#include QMK_KEYBOARD_H
+#include "rgb_matrix_user.h"
+#include "keymap_user.h"
+
+keypos_t led_index_key_position[RGB_MATRIX_LED_COUNT];
+
+#ifdef SHIFT_INDICATOR_COLOR
+#    define is_shift_pressed (get_mods() & MOD_MASK_SHIFT)
+#else
+#    define is_shift_pressed false
+#endif
+
+void rgb_matrix_init_user(void) {
+    // Set up led_index_key_position
+    for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
+        for (uint8_t col = 0; col < MATRIX_COLS; col++) {
+            uint8_t led_index = g_led_config.matrix_co[row][col];
+            if (led_index != NO_LED) {
+                led_index_key_position[led_index] = (keypos_t){.row = row, .col = col};
+            }
+        }
+    }
+}
+
+bool rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
+    uint8_t current_layer = get_highest_layer(layer_state);
+    bool    caps          = host_keyboard_led_state().caps_lock;
+    switch (current_layer) {
+        case WIN_BASE:
+        case MAC_BASE:
+            // Light up letters if caps and light up letters and numbers if shift. If shift and caps light up just numbers.
+#ifdef CAPS_LOCK_INDICATOR_COLOR
+            if (caps && !is_shift_pressed) {
+                rgb_matrix_set_color_by_keycode(led_min, led_max, current_layer, is_caps_lock_indicator, CAPS_LOCK_INDICATOR_COLOR);
+#    ifdef CAPS_LOCK_INDICATOR_OTHER
+                rgb_matrix_set_color_by_not_keycode(led_min, led_max, current_layer, is_caps_lock_indicator, CAPS_LOCK_INDICATOR_OTHER);
+#    endif
+            }
+#    ifdef SHIFT_INDICATOR_COLOR
+            else if (is_shift_pressed && !caps) {
+                // Light up letters and other shift affected keys
+                rgb_matrix_set_color_by_keycode(led_min, led_max, current_layer, is_shift_indicator, SHIFT_INDICATOR_COLOR);
+                rgb_matrix_set_color_by_keycode(led_min, led_max, current_layer, is_caps_lock_indicator, CAPS_LOCK_INDICATOR_COLOR);
+            } else if (is_shift_pressed && caps) {
+                // Only shift affected keys light up
+                rgb_matrix_set_color_by_keycode(led_min, led_max, current_layer, is_shift_indicator, SHIFT_INDICATOR_COLOR);
+            }
+#    endif // SHIFT_INDICATOR_COLOR
+#endif     // CAPS_LOCK_INDICATOR_COLOR
+            break;
+        default:
+#ifdef FN_LAYER_TRANSPARENT_KEYS_COLOR
+            rgb_matrix_set_color_by_keycode(led_min, led_max, current_layer, is_transparent, FN_LAYER_TRANSPARENT_KEYS_COLOR);
+#endif
+#ifdef FN_LAYER_KEYS_COLOR
+            rgb_matrix_set_color_by_not_keycode(led_min, led_max, current_layer, is_transparent, FN_LAYER_KEYS_COLOR);
+#endif
+#ifdef CURRENT_LAYER_INDICATOR_COLOR
+            rgb_matrix_set_color_by_keycode(led_min, led_max, current_layer, is_default_layer, CURRENT_LAYER_INDICATOR_COLOR);
+#endif
+#ifdef NKRO_INDICATOR_COLOR
+            if (keymap_config.nkro) {
+                rgb_matrix_set_color_by_keycode(led_min, led_max, current_layer, is_nkro_indicator, NKRO_INDICATOR_COLOR);
+            }
+#endif
+            break;
+    }
+    return false;
+}
+
+// set color of keys that match the keycode
+void rgb_matrix_set_color_by_keycode(uint8_t led_min, uint8_t led_max, uint8_t layer, bool (*is_keycode)(uint16_t), uint8_t red, uint8_t green, uint8_t blue) {
+    for (uint8_t i = led_min; i < led_max; i++) {
+        uint16_t keycode = keymap_key_to_keycode(layer, led_index_key_position[i]);
+        if ((*is_keycode)(keycode)) {
+            rgb_matrix_set_color(i, red, green, blue);
+        }
+    }
+}
+
+// set color of all leds that are not a certain keycode
+void rgb_matrix_set_color_by_not_keycode(uint8_t led_min, uint8_t led_max, uint8_t layer, bool (*is_keycode)(uint16_t), uint8_t red, uint8_t green, uint8_t blue) {
+    for (uint8_t i = led_min; i < led_max; i++) {
+        uint16_t keycode = keymap_key_to_keycode(layer, led_index_key_position[i]);
+        if (!(*is_keycode)(keycode)) {
+            rgb_matrix_set_color(i, red, green, blue);
+        }
+    }
+}
+
+// check if keycode is a letter or shift or caps lock
+bool is_caps_lock_indicator(uint16_t keycode) {
+#ifdef CAPS_LOCK_INDICATOR_LIGHT_ALPHAS
+    return (KC_A <= keycode && keycode <= KC_Z) || keycode == KC_CAPS || keycode == KC_LSFT || keycode == KC_RSFT;
+#else
+    return keycode == KC_CAPS;
+#endif
+}
+
+// check if keycode is the DF to default layer
+#ifdef CURRENT_LAYER_INDICATOR_COLOR
+bool is_default_layer(uint16_t keycode) {
+    return keycode == DF(get_highest_layer(default_layer_state));
+}
+#endif
+
+// check if keycode is the NKRO toggle
+#ifdef NKRO_INDICATOR_COLOR
+bool is_nkro_indicator(uint16_t keycode) {
+    return keycode == NK_TOGG;
+}
+#endif
+
+// check if keycode is transparent
+bool is_transparent(uint16_t keycode) {
+    return keycode == KC_TRNS;
+}
+
+// check if keycode is affected by shift on the number row
+#ifdef SHIFT_INDICATOR_COLOR
+bool is_shift_indicator(uint16_t keycode) {
+    return (KC_1 <= keycode && keycode <= KC_0) || keycode == KC_MINS || keycode == KC_EQL || keycode == KC_GRV || keycode == KC_BSLS || keycode == KC_LBRC || keycode == KC_RBRC || keycode == KC_SCLN || keycode == KC_QUOT || keycode == KC_COMM || keycode == KC_DOT || keycode == KC_SLSH || keycode == QK_GESC || keycode == KC_LSFT || keycode == KC_RSFT;
+}
+#endif
diff --git a/users/vnmm/rgb_matrix_user.h b/users/vnmm/rgb_matrix_user.h
new file mode 100644
index 0000000000..7fe3d8229a
--- /dev/null
+++ b/users/vnmm/rgb_matrix_user.h
@@ -0,0 +1,28 @@
+/*
+ *
+ * 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
+
+void rgb_matrix_init_user(void);
+
+void rgb_matrix_set_color_by_keycode(uint8_t led_min, uint8_t led_max, uint8_t layer, bool (*is_keycode)(uint16_t), uint8_t red, uint8_t green, uint8_t blue);
+void rgb_matrix_set_color_by_not_keycode(uint8_t led_min, uint8_t led_max, uint8_t layer, bool (*is_keycode)(uint16_t), uint8_t red, uint8_t green, uint8_t blue);
+
+bool is_default_layer(uint16_t keycode);
+bool is_nkro_indicator(uint16_t keycode);
+bool is_caps_lock_indicator(uint16_t keycode);
+bool is_transparent(uint16_t keycode);
+bool is_shift_indicator(uint16_t keycode);
diff --git a/users/vnmm/rules.mk b/users/vnmm/rules.mk
new file mode 100644
index 0000000000..2b601fd3e5
--- /dev/null
+++ b/users/vnmm/rules.mk
@@ -0,0 +1,5 @@
+SRC += vnmm.c
+
+ifeq ($(strip $(RGB_MATRIX_ENABLE)), yes)
+    SRC += rgb_matrix_user.c
+endif
diff --git a/users/vnmm/vnmm.c b/users/vnmm/vnmm.c
new file mode 100644
index 0000000000..a4d4a7928e
--- /dev/null
+++ b/users/vnmm/vnmm.c
@@ -0,0 +1,23 @@
+/*
+ *
+ * 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/>.
+ */
+
+#include "vnmm.h"
+
+void keyboard_post_init_user(void) {
+#ifdef RGB_MATRIX_ENABLE
+    rgb_matrix_init_user();
+#endif
+}
\ No newline at end of file
diff --git a/users/vnmm/vnmm.h b/users/vnmm/vnmm.h
new file mode 100644
index 0000000000..03723c3deb
--- /dev/null
+++ b/users/vnmm/vnmm.h
@@ -0,0 +1,21 @@
+/*
+ *
+ * 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
+
+#include "keymap_user.h"
+#ifdef RGB_MATRIX_ENABLE
+#    include "rgb_matrix_user.h"
+#endif
\ No newline at end of file