added addcninblue's layout (#2049)

* added addcninblue's layout

* vim layer

3 files changed, 230 insertions, 0 deletions

diff --git a/keyboards/satan/keymaps/addcninblue/keymap.c b/keyboards/satan/keymaps/addcninblue/keymap.c
new file mode 100644
index 000000000..9034d04d5
--- /dev/null
+++ b/keyboards/satan/keymaps/addcninblue/keymap.c
@@ -0,0 +1,196 @@
+#include "satan.h"
+#include "rgblight.h"
+
+#define _DEFAULT 0
+#define _FN 1
+#define _VIM 10
+#define _VIM_SHIFT 11
+#define _VIM_CONTROL 12
+
+enum custom_keycodes {
+  DYNAMIC_MACRO_RANGE = SAFE_RANGE,
+  a_MACRO,
+  A_MACRO,
+  I_MACRO,
+  O_MACRO,
+};
+
+#define KC_PREV_WORD LCTL(KC_LEFT)
+#define KC_NEXT_WORD LCTL(KC_RIGHT)
+#define KC_UNDO LCTL(KC_Z)
+#define KC_CUT LCTL(KC_X)
+#define KC_COPY LCTL(KC_C)
+#define KC_PASTE LCTL(KC_V)
+
+#include "dynamic_macro.h"
+
+static uint8_t old_layer = 0;
+
+// Fillers to make layering more clear
+#define ______ KC_TRNS
+#define XXXXXX KC_NO
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+/* Qwerty gui/alt/space/alt/gui
+ * ,-----------------------------------------------------------------------------------------.
+ * | Esc |  1  |  2  |  3  |  4  |  5  |  6  |  7  |  8  |  9  |  0  |  -  |  =  |  \  |  `  |
+ * |-----------------------------------------------------------------------------------------+
+ * | Tab    |  Q  |  W  |  E  |  R  |  T  |  Y  |  U  |  I  |  O  |  P  |  [  |  ]  |  Bksp  |
+ * |-----------------------------------------------------------------------------------------+
+ * | Ctrl    |  A  |  S  |  D  |  F  |  G  |  H  |  J  |  K  |  L  |  ;  |  '  |    Enter    |
+ * |-----------------------------------------------------------------------------------------+
+ * | Shift     |  Z  |  X  |  C  |  V  |  B  |  N  |  M  |  ,  |  .  |  /  | RShift    | VIM |
+ * |-----------------------------------------------------------------------------------------+
+ *         | FN  | LAlt  |               Space                | RAlt   |RGUI |
+ *         `-----------------------------------------------------------------'
+ */
+  [_DEFAULT] = KEYMAP_HHKB( /* Basic QWERTY */
+      KC_GESC , KC_1    , KC_2    , KC_3   , KC_4    , KC_5    , KC_6   , KC_7     , KC_8    , KC_9   , KC_0    , KC_MINS , KC_EQL   , KC_BSLS , KC_GRV , \
+      KC_TAB  , KC_Q    , KC_W    , KC_E   , KC_R    , KC_T    , KC_Y   , KC_U     , KC_I    , KC_O   , KC_P    , KC_LBRC , KC_RBRC  , KC_BSPC , \
+      KC_LCTL , KC_A    , KC_S    , KC_D   , KC_F    , KC_G    , KC_H   , KC_J     , KC_K    , KC_L   , KC_SCLN , KC_QUOT , KC_ENT   , \
+      KC_LSFT , KC_Z    , KC_X    , KC_C   , KC_V    , KC_B    , KC_N   , KC_M     , KC_COMM , KC_DOT , KC_SLSH , KC_RSFT , TO(_VIM) , \
+      ______  , MO(_FN) , KC_LALT , KC_SPC , KC_RALT , KC_RGUI , ______ , ______ \
+      ),
+
+/* FN Layer
+ * ,-----------------------------------------------------------------------------------------.
+ * |GRAVE| F1  | F2  | F3  | F4  | F5  | F6  | F7  | F8  | F9  | F10 | F11 | F12 | Ins | Del |
+ * |-----------------------------------------------------------------------------------------+
+ * |  CAPS  | Vol-| Mute| Vol+|MAC+ |MAC  |MAC- | PgUp| Home|     |Print| Up  |     | Del    |
+ * |-----------------------------------------------------------------------------------------+
+ * |  Ctrl   | End |     | PgDn|     |     | Left| Down| Up  |Right| Left|Right|    Enter    |
+ * |-----------------------------------------------------------------------------------------+
+ * |  Shift    | Prev| Play| Next| BL- | BL  | BL+ |     |     |     | Down| RShift    | DEF |
+ * |-----------------------------------------------------------------------------------------+
+ *         |       | LAlt  |             Space               | RAlt  | Reset |
+ *         `-----------------------------------------------------------------'
+ */
+  [_FN] = KEYMAP_HHKB( /* Layer 2 */
+      KC_GRAVE , KC_F1   , KC_F2   , KC_F3   , KC_F4          , KC_F5           , KC_F6        , KC_F7    , KC_F8   , KC_F9    , KC_F10  , KC_F11  , KC_F12       , KC_INS , KC_DEL , \
+      KC_CAPS  , KC_VOLD , KC_MUTE , KC_VOLU , DYN_REC_START1 , DYN_MACRO_PLAY1 , DYN_REC_STOP , KC_PGUP  , KC_HOME , ______   , KC_PSCR , KC_UP   , ______       , KC_DEL , \
+      KC_LCTL  , KC_END  , ______  , KC_PGDN , ______         , ______          , KC_LEFT      , KC_DOWN  , KC_UP   , KC_RIGHT , KC_LEFT , KC_RGHT , KC_ENT       , \
+      KC_LSFT  , KC_MPRV , KC_MPLY , KC_MNXT , BL_DEC         , BL_TOGG         , BL_INC       , ______   , ______  , ______   , KC_DOWN , KC_RSFT , TO(_DEFAULT) , \
+      ______   , ______  , KC_LALT , KC_SPC  , KC_RALT        , RESET           , ______       , ______ \
+      ),
+
+/* VIM Layer
+ * ,-----------------------------------------------------------------------------------------.
+ * | DEF |  1  |  2  |  3  |  4  |  5  |  6  |  7  |  8  |  9  |  0  |  -  |  =  |  \  |  `  |
+ * |-----------------------------------------------------------------------------------------+
+ * |        |     | WORD| WORD|     |     | COPY| UNDO| DEF |ENTER|PASTE|     |     | Del    |
+ * |-----------------------------------------------------------------------------------------+
+ * | V_Ctrl  |a_ins|     |     |     |     | Left| Down| Up  |Right|     |     |    Enter    |
+ * |-----------------------------------------------------------------------------------------+
+ * |  V_Shift  |     |     |     |     | PREV|     |     |     |     |     | RShift    | Def |
+ * |-----------------------------------------------------------------------------------------+
+ *         |       | LAlt  |             Space               | RAlt  |       |
+ *         `-----------------------------------------------------------------'
+ */
+  [_VIM] = KEYMAP_HHKB( /* Layer 10 */
+      TO(_DEFAULT)     , KC_1    , KC_2         , KC_3         , KC_4    , KC_5         , KC_6    , KC_7     , KC_8         , KC_9     , KC_0     , KC_MINS , KC_EQL       , KC_BSLS , KC_GRV , \
+      XXXXXX           , XXXXXX  , KC_NEXT_WORD , KC_NEXT_WORD , XXXXXX  , XXXXXX       , KC_COPY , KC_UNDO  , TO(_DEFAULT) , KC_ENTER , KC_PASTE , XXXXXX  , XXXXXX       , KC_DEL  , \
+      MO(_VIM_CONTROL) , a_MACRO , XXXXXX       , XXXXXX       , XXXXXX  , XXXXXX       , KC_LEFT , KC_DOWN  , KC_UP        , KC_RIGHT , XXXXXX   , XXXXXX  , KC_ENTER     , \
+      MO(_VIM_SHIFT)   , XXXXXX  , XXXXXX       , XXXXXX       , XXXXXX  , KC_PREV_WORD , XXXXXX  , XXXXXX   , XXXXXX       , XXXXXX   , XXXXXX   , KC_RSFT , TO(_DEFAULT) , \
+      XXXXXX           , XXXXXX  , KC_LALT      , KC_SPC       , KC_RALT , XXXXXX       , XXXXXX  , XXXXXX \
+      ),
+
+/* VIM Layer
+ * ,-----------------------------------------------------------------------------------------.
+ * | DEF |  1  |  2  |  3  |  4  |  5  |  6  |  7  |  8  |  9  |  0  |  -  |  =  |  \  |  `  |
+ * |-----------------------------------------------------------------------------------------+
+ * |        |     | WORD| WORD|     |     |     |     |I_ins|ENTER|     |     |     | Del    |
+ * |-----------------------------------------------------------------------------------------+
+ * |         |A_ins|     |     |     |     | Left| Down| Up  |Right|     |     |    Enter    |
+ * |-----------------------------------------------------------------------------------------+
+ * |           |     |     |     |     | PREV|     |     |     |     |     | RShift    | Def |
+ * |-----------------------------------------------------------------------------------------+
+ *         |       | LAlt  |             Space               | RAlt  |       |
+ *         `-----------------------------------------------------------------'
+ */
+  [_VIM_SHIFT] = KEYMAP_HHKB( /* Layer 11 */
+      TO(_DEFAULT) , KC_1    , KC_2         , KC_3         , KC_4    , KC_5         , KC_6    , KC_7     , KC_8    , KC_9     , KC_0   , KC_MINS , KC_EQL       , KC_BSLS , KC_GRV , \
+      XXXXXX       , XXXXXX  , KC_NEXT_WORD , KC_NEXT_WORD , XXXXXX  , XXXXXX       , XXXXXX  , XXXXXX   , I_MACRO , O_MACRO  , XXXXXX , XXXXXX  , XXXXXX       , KC_DEL  , \
+      XXXXXX       , A_MACRO , XXXXXX       , KC_PGDN      , XXXXXX  , XXXXXX       , KC_LEFT , KC_DOWN  , KC_UP   , KC_RIGHT , XXXXXX , XXXXXX  , KC_ENTER     , \
+      XXXXXX       , XXXXXX  , XXXXXX       , XXXXXX       , XXXXXX  , KC_PREV_WORD , XXXXXX  , XXXXXX   , XXXXXX  , XXXXXX   , XXXXXX , KC_RSFT , TO(_DEFAULT) , \
+      XXXXXX       , XXXXXX  , KC_LALT      , KC_SPC       , KC_RALT , RESET        , XXXXXX  , XXXXXX \
+      ),
+
+/* FN Layer
+ * ,-----------------------------------------------------------------------------------------.
+ * |     | F1  | F2  | F3  | F4  | F5  | F6  | F7  | F8  | F9  | F10 | F11 | F12 | Ins | Del |
+ * |-----------------------------------------------------------------------------------------+
+ * |        | Vol-| Mute| Vol+|     |     |     | PgUp| Ins |     |Print| Up  |     | Del    |
+ * |-----------------------------------------------------------------------------------------+
+ * |  Ctrl   | App |     | PgDn|     |     | Left| Down| Up  |Right| Left|Right|    Enter    |
+ * |-----------------------------------------------------------------------------------------+
+ * |  Shift    | Prev| Play| Next| BL- | BL  | BL+ |     |     |     | Down| RShift    | Def |
+ * |-----------------------------------------------------------------------------------------+
+ *         |       | LAlt  |             Space               | RAlt  | Reset |
+ *         `-----------------------------------------------------------------'
+ */
+  [_VIM_CONTROL] = KEYMAP_HHKB( /* Layer 12 */
+      TO(_DEFAULT) , KC_1    , KC_2         , KC_3         , KC_4    , KC_5         , KC_6    , KC_7     , KC_8    , KC_9     , KC_0   , KC_MINS , KC_EQL       , KC_BSLS , KC_GRV , \
+      XXXXXX       , XXXXXX  , KC_NEXT_WORD , KC_NEXT_WORD , XXXXXX  , XXXXXX       , XXXXXX  , XXXXXX   , I_MACRO , O_MACRO  , XXXXXX , XXXXXX  , XXXXXX       , KC_DEL  , \
+      XXXXXX       , A_MACRO , XXXXXX       , KC_PGDN      , XXXXXX  , XXXXXX       , KC_LEFT , KC_DOWN  , KC_UP   , KC_RIGHT , XXXXXX , XXXXXX  , KC_ENTER     , \
+      XXXXXX       , XXXXXX  , XXXXXX       , XXXXXX       , XXXXXX  , KC_PREV_WORD , XXXXXX  , XXXXXX   , XXXXXX  , XXXXXX   , XXXXXX , KC_RSFT , TO(_DEFAULT) , \
+      XXXXXX       , XXXXXX  , KC_LALT      , KC_SPC       , KC_RALT , RESET        , XXXXXX  , XXXXXX \
+      )            ,
+};
+
+void persistent_default_layer_set(uint16_t default_layer) {
+  eeconfig_update_default_layer(default_layer);
+  default_layer_set(default_layer);
+}
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+    if (!process_record_dynamic_macro(keycode, record)) {
+        return false;
+    }
+    if (record->event.pressed) {
+        switch(keycode) {
+            case a_MACRO:
+                SEND_STRING(SS_TAP(X_RIGHT));
+                layer_off(_VIM);
+                return false;
+                break;
+            case A_MACRO:
+                SEND_STRING(SS_TAP(X_END));
+                layer_off(_VIM_SHIFT);
+                layer_off(_VIM);
+                return false;
+                break;
+            case I_MACRO:
+                SEND_STRING(SS_TAP(X_HOME));
+                layer_off(_VIM_SHIFT);
+                layer_off(_VIM);
+                return false;
+                break;
+            case O_MACRO:
+                SEND_STRING(SS_TAP(X_ENTER));
+                layer_off(_VIM_SHIFT);
+                layer_off(_VIM);
+                return false;
+                break;
+        }
+    }
+    return true;
+}
+
+void matrix_scan_user(void) {
+  uint8_t layer = biton32(layer_state);
+
+  if (old_layer != layer) {
+    switch (layer) {
+      case _DEFAULT:
+      case _FN:
+        backlight_set(1);
+      break;
+      case _VIM:
+      case _VIM_SHIFT:
+      case _VIM_CONTROL:
+        backlight_set(4);
+      break;
+    }
+    old_layer = layer;
+  }
+};
diff --git a/keyboards/satan/keymaps/addcninblue/readme.md b/keyboards/satan/keymaps/addcninblue/readme.md
new file mode 100644
index 000000000..7e6520534
--- /dev/null
+++ b/keyboards/satan/keymaps/addcninblue/readme.md
@@ -0,0 +1,13 @@
+# Addcninblue's HHKB-ish Layout
+
+Inspired by Dbroqua's layout
+
+[Layer 1](http://www.keyboard-layout-editor.com/#/gists/0e7798cb81c8f76baa5066ec1c34df8e): pretty standard layout. Shift + esc = ~, unlike normal hhkb.
+[Layer 2](http://www.keyboard-layout-editor.com/#/gists/096099221ac48d4d0c84a2b859bbb7c0): Vim-like layout.
+[Layer Vim](http://www.keyboard-layout-editor.com/#/gists/73b27b51c5e18d7999cc5fa39b4f3389) : vim layout until exit layout
+
+## Programming Instructions:
+Enter into programming mode and run the following command:
+```
+$ sudo make satan:addcninblue:dfu
+```
diff --git a/keyboards/satan/keymaps/addcninblue/rules.mk b/keyboards/satan/keymaps/addcninblue/rules.mk
new file mode 100644
index 000000000..c2937fd57
--- /dev/null
+++ b/keyboards/satan/keymaps/addcninblue/rules.mk
@@ -0,0 +1,21 @@
+# Build Options
+#   change to "no" to disable the options, or define them in the Makefile in
+#   the appropriate keymap folder that will get included automatically
+#
+BOOTMAGIC_ENABLE = no      # Virtual DIP switch configuration(+1000)
+MOUSEKEY_ENABLE = no       # Mouse keys(+4700)
+EXTRAKEY_ENABLE = yes      # Audio control and System control(+450)
+CONSOLE_ENABLE = no        # Console for debug(+400)
+COMMAND_ENABLE = no        # Commands for debug and configuration
+SLEEP_LED_ENABLE = no      # Enables your LED to breathe while your computer is sleeping.
+NKRO_ENABLE = yes          # Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ # nkro-doesnt-work
+BACKLIGHT_ENABLE = yes     # Enable keyboard backlight functionality
+MIDI_ENABLE = no           # MIDI controls
+AUDIO_ENABLE = no          # Audio output on port C6
+UNICODEMAP_ENABLE = no     # This allows sending unicode symbols using X(<unicode>) in your keymap.
+UNICODE_ENABLE = no        # Unicode
+UCIS_ENABLE = no           # Keep in mind that not all will work (See WinCompose for details on Windows).
+BLUETOOTH_ENABLE = no      # Enable Bluetooth with the Adafruit EZ-Key HID
+RGBLIGHT_ENABLE = no       # Enable WS2812 RGB underlight.  Do not enable this with audio at the same time.
+SLEEP_LED_ENABLE = no      # Breathing sleep LED during USB suspend
+API_SYSEX_ENABLE = no      # This enables using the Quantum SYSEX API to send strings