First PR for KBD6x HHKB layout keymap (#4704)

* initial commit for Othi's HHKB layout keymap,
covering multiple modifiers hold and vim-like support and german characters. If there's
any suggestion i can be reached via mnpqraven on github or Othi#6661 on
discord

* added readme.md. TODO: update readme.md

* changed to default quantum keycode for `KC_TRNS`,
removed `PREVENT_STUCK_MODIFIERS`,
fixed tap dance using one shots
TODO: unicode implementation at https://docs.qmk.fm/#/feature_unicode

* keymap documentaion(readme) added

* unicode init
TODO: figure out what made the compose sequence not running

* update unicode and readme

1 files changed, 190 insertions, 0 deletions

diff --git a/keyboards/kbd6x/keymaps/othi/keymap.c b/keyboards/kbd6x/keymaps/othi/keymap.c
new file mode 100644
index 0000000000..1e0fc8ad7e
--- /dev/null
+++ b/keyboards/kbd6x/keymaps/othi/keymap.c
@@ -0,0 +1,190 @@
+/* Copyright 2018 Othi
+ *
+ * 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
+
+// read README.md for rundown of what does what
+
+// #define BL 0
+#define CL 0
+#define NM_MODE 2
+#define VI_MODE 3
+#define FN3 4
+#define ACCENT 5
+#define ACCENT_CAP 6
+
+//Unicode keymaps
+void eeconfig_init_user(void) {
+  set_unicode_input_mode(UC_LNX);
+}
+#define DE_AE     UC(0x00E4)
+#define DE_SS     UC(0x00DF)
+#define DE_OE     UC(0x00F6)
+#define DE_UE     UC(0x00FC)
+#define DE_AE_CAP UC(0x00C4)
+#define DE_OE_CAP UC(0x00D6)
+#define DE_UE_CAP UC(0x00DC)
+
+uint32_t layer_state_set_user(uint32_t state) {
+    switch (biton32(state)) {
+    case NM_MODE:
+        rgblight_setrgb (0x00,  0x66, 0x00);
+        break;
+    case VI_MODE:
+        rgblight_setrgb (0x66,  0x66, 0x00);
+        break;
+    case ACCENT:
+        rgblight_setrgb (0x7A,  0x00, 0xFF);
+        break;
+    case ACCENT_CAP:
+        rgblight_setrgb (0x7A,  0xFF, 0xFF);
+        break;
+    default: //  for any other layers, or the default layer
+        rgblight_setrgb (0xFF,  0x00, 0x00);
+        break;
+    }
+  return state;
+}
+
+//Tap Dance Declarations
+enum {
+  CTL_NM = 0,
+  ALT_NM = 1,
+  SFT_NM = 2,
+  GUI_NM = 3
+};
+
+void dance_CTL_NM_finished (qk_tap_dance_state_t *state, void *user_data) {
+  if (state->count == 1) {
+	set_oneshot_mods(MOD_LCTL);
+  } else {
+    register_code (KC_LCTL);
+	layer_on(NM_MODE);
+  }
+}
+
+void dance_CTL_NM_reset (qk_tap_dance_state_t *state, void *user_data) {
+  if (state->count == 1) {
+    unregister_code (KC_LCTL);
+  } else {
+    unregister_code (KC_LCTL);
+	layer_off(NM_MODE);
+  }
+}
+
+void dance_GUI_NM_finished (qk_tap_dance_state_t *state, void *user_data) {
+  if (state->count == 1) {
+	register_code (KC_LGUI);
+  } else {
+    register_code (KC_LGUI);
+	layer_on(NM_MODE);
+  }
+}
+
+void dance_GUI_NM_reset (qk_tap_dance_state_t *state, void *user_data) {
+  if (state->count == 1) {
+    unregister_code (KC_LGUI);
+  } else {
+    unregister_code (KC_LGUI);
+	layer_off(NM_MODE);
+  }
+}
+
+void dance_ALT_NM_finished (qk_tap_dance_state_t *state, void *user_data) {
+  if (state->count == 1) {
+	register_code (KC_LALT);
+  } else {
+    register_code (KC_LALT);
+	layer_on(NM_MODE);
+  }
+}
+
+void dance_ALT_NM_reset (qk_tap_dance_state_t *state, void *user_data) {
+  if (state->count == 1) {
+    unregister_code (KC_LALT);
+  } else {
+    unregister_code (KC_LALT);
+	layer_off(NM_MODE);
+  }
+}
+
+void dance_SFT_NM_finished (qk_tap_dance_state_t *state, void *user_data) {
+  if (state->count == 1) {
+	register_code (KC_LSFT);
+	set_oneshot_mods(MOD_LSFT);
+  } else {
+    register_code (KC_LSFT);
+	layer_on(NM_MODE);
+  }
+}
+
+void dance_SFT_NM_reset (qk_tap_dance_state_t *state, void *user_data) {
+  if (state->count == 1) {
+    unregister_code (KC_LSFT);
+  } else {
+    unregister_code (KC_LSFT);
+	layer_off(NM_MODE);
+  }
+}
+
+
+qk_tap_dance_action_t tap_dance_actions[] = {
+ [CTL_NM] = ACTION_TAP_DANCE_FN_ADVANCED (NULL, dance_CTL_NM_finished, dance_CTL_NM_reset),
+ [GUI_NM] = ACTION_TAP_DANCE_FN_ADVANCED (NULL, dance_GUI_NM_finished, dance_GUI_NM_reset),
+ [ALT_NM] = ACTION_TAP_DANCE_FN_ADVANCED (NULL, dance_ALT_NM_finished, dance_ALT_NM_reset),
+ [SFT_NM] = ACTION_TAP_DANCE_FN_ADVANCED (NULL, dance_SFT_NM_finished, dance_SFT_NM_reset)
+};
+
+// backup
+// old R3 capslock, LT(NM_MODE,KC_BSPC),
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  [CL] = LAYOUT(
+      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_DEL,
+      MT(MOD_LGUI,KC_TAB),       LT(NM_MODE,KC_Q),    KC_W,    LT(ACCENT,KC_F),    KC_P,    KC_G,    KC_J,    KC_L,    KC_U,    KC_Y,    KC_SCLN,     KC_LBRC, KC_RBRC, KC_BSPC,
+      MT(MOD_LCTL,KC_BSPC),      KC_A,    KC_R,    KC_S,    KC_T,    KC_D,    KC_H,    KC_N,    KC_E,    KC_I,    KC_O,           KC_QUOT, KC_ENT,
+      TD(SFT_NM),                KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_K,    KC_M,    MT(MOD_LCTL,KC_COMM), MT(MOD_LSFT,KC_DOT),  MT(MOD_LALT,KC_SLSH),        LM(CL,MOD_LGUI|MOD_LSFT), TT(NM_MODE),
+      _______, TD(CTL_NM),                     TD(ALT_NM),              		KC_SPC,    LM(CL,MOD_LGUI|MOD_LALT), OSL(ACCENT)    , _______
+      ),
+  [NM_MODE] = LAYOUT(
+      KC_GRV,            KC_MPRV,    KC_MNXT,    KC_MPLY,    KC_END,      _______,     _______,     _______,     _______,     _______,     KC_HOME,    _______,  _______,  RESET, KC_INS,
+      LGUI(KC_TAB),       _______,    LCTL(KC_RGHT),  _______,    _______,    _______,    _______,    KC_UP,    KC_PGUP,    _______,    _______,     _______, TG(CL), KC_DEL,
+      _______,            KC_LEFT,    _______,    KC_RGHT,      _______,    KC_PGDN,    KC_LEFT,   KC_DOWN,   KC_RGHT,     _______,    KC_ENT,  KC_QUOT, KC_LGUI,
+      KC_LSFT,     			_______,    _______,    _______,      _______,    LCTL(KC_LEFT),    _______,    _______,    _______,    _______,    _______,    TG(VI_MODE), TO(CL),
+      _______, TD(CTL_NM),                     TD(ALT_NM),              		KC_SPC,    LM(CL,MOD_LGUI|MOD_LALT), OSL(ACCENT), _______
+      ),
+
+  [VI_MODE] = LAYOUT(
+      KC_GRV,         KC_MPRV,  KC_MNXT, KC_MPLY,    LSFT(KC_END),          KC_F5,     KC_F6,     KC_F7,     KC_F8,     KC_F9,     LSFT(KC_HOME),    KC_F11,  KC_F12,  RESET, KC_INS,
+      LGUI(KC_TAB),     _______,    LSFT(LCTL(KC_RGHT)),  _______,    _______,    _______,    _______,    LSFT(KC_UP),    _______,    _______,    _______,     _______, TG(CL), KC_BSPC,
+      _______,            _______,    _______,    _______,      _______,    _______,    LSFT(LCTL(KC_LEFT)),   LSFT(KC_DOWN),   LSFT(KC_RGHT),     _______,    KC_SCLN,  KC_QUOT, KC_LGUI,
+      KC_LSFT,      	    _______,  _______, _______,      _______,    LSFT(LCTL(KC_LEFT)),    _______,    _______,    _______,    _______,    KC_SLSH,    OSM(MOD_LSFT), TO(CL),
+      _______, TD(CTL_NM),                     TD(ALT_NM),              		KC_SPC,    LM(CL,MOD_LGUI|MOD_LALT), OSL(ACCENT), _______
+      ),
+  [ACCENT] = LAYOUT(
+      _______,       KC_F1,  KC_F2, KC_F3,    KC_F4,     KC_F5,     KC_F6,     KC_F7,     KC_F8,     KC_F9,     KC_F10,    KC_F11,  KC_F12,  _______, _______,
+      _______,         RGB_TOG,    RGB_MODE_PLAIN,  _______,    _______,    _______,    _______,    _______,    DE_UE,    _______,    _______,     _______, _______, _______,
+      _______,            DE_AE,    UC_Z,    DE_SS,      _______,    _______,    _______,   _______,   _______,     _______,    DE_OE,  _______, _______,
+      OSL(ACCENT_CAP),     _______,  _______, _______,      _______,    _______,    _______,    _______,    _______,    _______,        _______, _______, TO(CL),
+      _______,             _______,         _______,            _______,         _______, _______,  _______
+      ),
+  [ACCENT_CAP] = LAYOUT(
+      _______,   _______,  _______, _______,    _______,          _______,     _______,     _______,     _______,     _______,     _______,    _______,  _______,  _______, _______,
+      _______,      _______,    _______,  _______,    _______,    _______,    _______,    _______,    DE_UE_CAP,    _______,    _______,     _______, _______, _______,
+      _______,        DE_AE_CAP,    _______,    DE_SS,      _______,    _______,    _______,   _______,   _______,     _______,    DE_OE_CAP,  _______, TO(CL),
+      _______, 	       _______, _______,      _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______, _______, _______,
+      _______,   _______,         _______,         _______,         _______,   _______,      _______
+      ),
+};
+