PR for keymap sigma-squared

keyboards/bm40hsrgb/keymaps/sigma-squared/config.h

@@ -0,0 +1,78 @@
+// qmk flash -kb bm40hsrgb -km sigma-squared
+
+#pragma once
+
+#define RGBLIGHT_LAYERS
+#define RGBLIGHT_LAYERS_OVERRIDE_RGB_OFF
+#define RGBLIGHT_ANIMATIONS
+
+//#define RGB_MATRIX_STARTUP_VAL RGB_MATRIX_MAXIMUM_BRIGHTNESS
+#define RGBLIGHT_LIMIT_VAL 10
+
+//bootmagic
+#define BOOTMAGIC_KEY_SALT KC_V
+#define BOOTMAGIC_KEY_EEPROM_CLEAR KC_Q
+
+#ifdef RGB_MATRIX_ENABLE
+
+//--------------------------------------------------------------------------------------------------------
+
+//disable broken animations
+#define DISABLE_RGB_MATRIX_ALPHAS_MODS
+#define DISABLE_RGB_MATRIX_GRADIENT_UP_DOWN
+#define DISABLE_RGB_MATRIX_BREATHING
+#define DISABLE_RGB_MATRIX_BAND_SAT
+#define DISABLE_RGB_MATRIX_BAND_VAL
+#define DISABLE_RGB_MATRIX_BAND_PINWHEEL_SAT
+#define DISABLE_RGB_MATRIX_BAND_PINWHEEL_VAL
+#define DISABLE_RGB_MATRIX_BAND_SPIRAL_SAT
+#define DISABLE_RGB_MATRIX_BAND_SPIRAL_VAL
+#define DISABLE_RGB_MATRIX_CYCLE_ALL
+#define DISABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT
+#define DISABLE_RGB_MATRIX_CYCLE_UP_DOWN
+#define DISABLE_RGB_MATRIX_CYCLE_OUT_IN
+#define DISABLE_RGB_MATRIX_CYCLE_OUT_IN_DUAL
+//#define DISABLE_RGB_MATRIX_RAINBOW_MOVING_CHEVRON
+//#define DISABLE_RGB_MATRIX_DUAL_BEACON
+#define DISABLE_RGB_MATRIX_CYCLE_PINWHEEL
+#define DISABLE_RGB_MATRIX_CYCLE_SPIRAL
+//#define DISABLE_RGB_MATRIX_RAINBOW_BEACON
+//#define DISABLE_RGB_MATRIX_RAINBOW_PINWHEELS
+//#define DISABLE_RGB_MATRIX_RAINDROPS
+#define DISABLE_RGB_MATRIX_JELLYBEAN_RAINDROPS // DO NOT ENABLE
+//#define DISABLE_RGB_MATRIX_TYPING_HEATMAP
+//#define DISABLE_RGB_MATRIX_DIGITAL_RAIN
+//#define DISABLE_RGB_MATRIX_SOLID_REACTIVE
+//#define DISABLE_RGB_MATRIX_SOLID_REACTIVE_SIMPLE
+//#define DISABLE_RGB_MATRIX_SOLID_REACTIVE_WIDE
+//#define DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE
+//#define DISABLE_RGB_MATRIX_SOLID_REACTIVE_CROSS
+//#define DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTICROSS
+//#define DISABLE_RGB_MATRIX_SOLID_REACTIVE_NEXUS
+//#define DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS
+//#define DISABLE_RGB_MATRIX_SPLASH
+//#define DISABLE_RGB_MATRIX_MULTISPLASH
+//#define DISABLE_RGB_MATRIX_SOLID_SPLASH
+//#define DISABLE_RGB_MATRIX_SOLID_MULTISPLASH
+
+#undef RGB_MATRIX_STARTUP_MODE
+
+#define RGBLIGHT_HUE_STEP 20
+
+#endif
+
+//--------------------------------------------------------------------------------------------------------
+
+//layout
+#define LAYOUT_sigma2(\
+K00,   K01,   K02,   K03,   K04,   K05,   K06,   K07,   K08,   K09,   K10,   K11,\
+K12,   K13,   K14,   K15,   K16,   K17,   K18,   K19,   K20,   K21,   K22,   K23,\
+K24,   K25,   K26,   K27,   K28,   K29,   K30,   K31,   K32,   K33,   K34,   K35,\
+K36,   K37,   K38,   K39,   K40,       K41,      K42,   KC_43, KC_44, KC_45, K46\
+)\
+LAYOUT_planck_mit(\
+K00,   K01,   K02,   K03,   K04,   K05,   K06,   K07,   K08,   K09,   K10,   K11,\
+K12,   K13,   K14,   K15,   K16,   K17,   K18,   K19,   K20,   K21,   K22,   K23,\
+K24,   K25,   K26,   K27,   K28,   K29,   K30,   K31,   K32,   K33,   K34,   K35,\
+K36,   K37,   K38,   K39,   K40,       K41,      K42,   KC_43, KC_44, KC_45, K46\
+)

keyboards/bm40hsrgb/keymaps/sigma-squared/keymap.c

@@ -0,0 +1,108 @@
+// qmk flash -kb bm40hsrgb -km sigma-squared
+
+#include "sigma-squared.h"
+
+//layer led colors
+
+void rgb_matrix_indicators_user(void) {
+
+//game indicators
+
+if(IS_LAYER_ON(GAME)) {
+  rgb_matrix_set_color(11, 0, 4, 5);
+}
+
+if(IS_LAYER_ON(SECGAME)) {
+  rgb_matrix_set_color(11, 5, 0, 0);
+}
+
+//layer indicators
+
+if(IS_LAYER_ON(NAVR)) {
+  rgb_matrix_set_color(40, 0, 4, 5);
+
+  rgb_matrix_set_color(19, 0, 4, 5);
+  rgb_matrix_set_color(20, 0, 4, 5);
+  rgb_matrix_set_color(21, 0, 4, 5);
+  rgb_matrix_set_color(22, 0, 4, 5);
+}
+
+if(IS_LAYER_ON(MEDR)) {
+  rgb_matrix_set_color(39, 5, 1, 2);
+
+  rgb_matrix_set_color(19, 5, 1, 2);
+
+  rgb_matrix_set_color(22, 5, 1, 2);
+
+  rgb_matrix_set_color(42, 5, 1, 2);
+}
+
+if(IS_LAYER_ON(FUNL)) {
+  rgb_matrix_set_color(43, 5, 0, 0);
+
+  rgb_matrix_set_color(1, 5, 0, 0);
+  rgb_matrix_set_color(2, 5, 0, 0);
+  rgb_matrix_set_color(3, 5, 0, 0);
+  rgb_matrix_set_color(4, 5, 0, 0);
+
+  rgb_matrix_set_color(13, 5, 0, 0);
+  rgb_matrix_set_color(14, 5, 0, 0);
+  rgb_matrix_set_color(15, 5, 0, 0);
+  rgb_matrix_set_color(16, 5, 0, 0);
+
+  rgb_matrix_set_color(25, 5, 0, 0);
+  rgb_matrix_set_color(26, 5, 0, 0);
+  rgb_matrix_set_color(27, 5, 0, 0);
+  rgb_matrix_set_color(28, 5, 0, 0);
+}
+
+if(IS_LAYER_ON(NSL)) {
+  rgb_matrix_set_color(42, 1, 0, 5);
+
+  rgb_matrix_set_color(2, 1, 0, 5);
+  rgb_matrix_set_color(3, 1, 0, 5);
+  rgb_matrix_set_color(4, 1, 0, 5);
+
+  rgb_matrix_set_color(14, 1, 0, 5);
+  rgb_matrix_set_color(15, 1, 0, 5);
+  rgb_matrix_set_color(16, 1, 0, 5);
+
+  rgb_matrix_set_color(26, 1, 0, 5);
+  rgb_matrix_set_color(27, 1, 0, 5);
+  rgb_matrix_set_color(28, 1, 0, 5);
+
+  rgb_matrix_set_color(38, 1, 0, 5);
+  rgb_matrix_set_color(39, 1, 0, 5);
+  rgb_matrix_set_color(40, 1, 0, 5);
+}
+
+if(IS_LAYER_ON(NSSL)) {
+  rgb_matrix_set_color(41, 0, 5, 0.19);
+
+  rgb_matrix_set_color(1, 0, 5, 0.19);
+  rgb_matrix_set_color(2, 0, 5, 0.19);
+  rgb_matrix_set_color(3, 0, 5, 0.19);
+  rgb_matrix_set_color(4, 0, 5, 0.19);
+  rgb_matrix_set_color(5, 0, 5, 0.19);
+
+  rgb_matrix_set_color(13, 0, 5, 0.19);
+  rgb_matrix_set_color(14, 0, 5, 0.19);
+  rgb_matrix_set_color(15, 0, 5, 0.19);
+  rgb_matrix_set_color(16, 0, 5, 0.19);
+  rgb_matrix_set_color(17, 0, 5, 0.19);
+
+  rgb_matrix_set_color(25, 0, 5, 0.19);
+  rgb_matrix_set_color(26, 0, 5, 0.19);
+  rgb_matrix_set_color(27, 0, 5, 0.19);
+  rgb_matrix_set_color(28, 0, 5, 0.19);
+  rgb_matrix_set_color(29, 0, 5, 0.19);
+
+}
+
+//capslock leds
+
+if (host_keyboard_leds() & (1<<USB_LED_CAPS_LOCK)) {
+    rgb_matrix_set_color_all(5, 1.56, 0);
+  }
+
+}

keyboards/bm40hsrgb/keymaps/sigma-squared/readme.md

@@ -0,0 +1,113 @@
+# Sigma Squared
+
+Sigma Squared is an adaptation & modification of the Layout [Miryoku](https://github.com/manna-harbour/qmk_firmware/blob/miryoku/users/manna-harbour_miryoku/miryoku.org#miryoku-) by *manna-harbour*
+
+*manna-harbour* lays out the general principles of the layout as follows:
+
+- Use layers instead of reaching.
+- Use both hands instead of contortions.
+- Use the home positions as much as possible.
+- Make full use of the thumbs.
+- Avoid unnecessary complication.
+
+
+
+Sigma Squared modifies on **Miryoku** in the following ways:
+
+- Added the Mods to the outer most columns to be easily accessed while typing with the pinkies
+- Extended the **NUMBER** layer to include symbols on the right side to allow calcualtion to be typed more easily without haveing to move between layers
+- Added a **GAME** layer to be used for gaming that emulates a more standard keyboard that most games expect
+  - moves *left shift* and *left ctrl* down
+  - *esc* moved to top left
+  - gives access to a **SECOND GAME** layer that contains an Fn row as well as number and arrow keys right under your left fingers
+- Added Shortcuts to the bottom row to reduce the amount of keycombos needed to use commonly needed features
+  - Mission Control, Screenshot, Cycling Apps & Windows
+- Added LED indicators to display what layer is currently active (only active while RGB is turned on)
+
+
+
+### Flashing
+
+- to directly flash to board:
+
+  `qmk flash -kb bm40hsrgb -km sigma-squared`
+
+- to only compile:
+
+  `qmk compile -kb bm40hsrgb -km sigma-squared`
+
+
+
+# Layout
+
+## BASE
+
+Tap the layer keys to use the black legends, hold them to activate the corresponding layer.
+
+The Shortcut keys can be modified to suit your needs, or change them in your OS to match the keys.
+
+If you are using MacOS I recommend swapping your *Ctrl* and *Cmd* keys in system preferences
+
+![img](https://i.imgur.com/xA1xkex.png)
+
+## NAVIGATION
+
+Provides access to all essential navigation keys, comfortably under your home row. Modifiers remain identical to **BASE** layer to be used for navigating lines and words.
+
+*Game Layer* key takes you to the **GAME** layer. *(duh)*
+
+Bottom right keys are used to swap between Virtual Desktops. You might need to modify these to fit your OS.
+
+![img](https://i.imgur.com/bxUJIHY.png)
+
+
+
+## MEDIA
+
+Provides access to all basic media keys, emulating the arrow keys on the home row.
+
+Also gives access to RGB controls.
+
+![img](https://i.imgur.com/1jWOvvH.png)
+
+## NUMBER
+
+Numbers are arranged in a numpad layout beneath home row, with 0 being positioned under the thumb resting position. Layer includes all most commonly needed symbols to reduce amount of layer switching needed to type longer calculations.
+
+Top right key changed to *Back Space* so corrections can be made without leaving layer.
+
+![img](https://i.imgur.com/LGJT3so.png)
+
+## SYMBOL
+
+Symbols are positioned over respective numbers from the **NUMBER** layer.
+
+Mouse keys are positioned similarly under the home row corresponding to the arrow keys.
+
+Also includes *Back Space* key for corrections.
+
+![img](https://i.imgur.com/ihOcdPj.png)
+
+## Fn
+
+Fn keys are arranged in the same layout as the numbers, with *F10* to *F12* added to the left
+
+![img](https://i.imgur.com/bPpI8KN.png)
+
+## GAME
+
+Somewhat emulates a regular layout needed for gaming. Top right key LED will indicate that you are on the **GAME** layer, and can be pressed to exit it. Holding one of the *Second Game* keys will give you access to **SECOND GAME**
+
+![img](https://i.imgur.com/r9KIWLX.png)
+
+## SECOND GAME
+
+Top right key will turn red to indicate you are in the layer
+
+![img](https://i.imgur.com/BLKHfVB.png)
+
+
+
+# Contact
+
+If you have any issues or questions you can reach me through Reddit at u/Signynt or on the QMK Discord