[Keymap] add ai03/polaris:mekberg (#10508)

* Add keymap for Polaris

* Change back to KC_NUBS for <> key

* Add GPL header from default files

* Change to new way of flashing in readme

4 files changed, 135 insertions, 0 deletions

diff --git a/keyboards/ai03/polaris/keymaps/mekberg/config.h b/keyboards/ai03/polaris/keymaps/mekberg/config.h
new file mode 100644
index 0000000000..ef8caf8709
--- /dev/null
+++ b/keyboards/ai03/polaris/keymaps/mekberg/config.h
@@ -0,0 +1,22 @@
+/*
+Copyright 2019 Ryota Goto
+
+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
+
+// Define some configuration for modtap behavior
+// #define TAPPING_TERM 150
+#define PERMISSIVE_HOLD
diff --git a/keyboards/ai03/polaris/keymaps/mekberg/keymap.c b/keyboards/ai03/polaris/keymaps/mekberg/keymap.c
new file mode 100644
index 0000000000..fce03adfbe
--- /dev/null
+++ b/keyboards/ai03/polaris/keymaps/mekberg/keymap.c
@@ -0,0 +1,97 @@
+/* Copyright 2019 Ryota Goto
+ *
+ * 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
+
+enum layer_names {
+    _BASE,
+    _NAV,
+    _FN
+};
+
+#define MY_LOCK C(LCMD(KC_L))      // Mac: Custom lock hotkey in BTT (when Alt/Command have been swapped in macOS)
+
+/*
+KBD6x ANSI physical layout
+1u == 8chars
+    ┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
+    |        |        |        |        |        |        |        |        |        |        |        |        |        |        |       |
+    |─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────|
+    |    1,5u    |        |        |        |        |        |        |        |        |        |        |        |        |     1,5u   |
+    |─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────|
+    |     1,75u    |        |        |        |        |        |        |        |        |        |        |        |        1,25u      |
+    |─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────|
+    |       2,25u      |        |        |        |        |        |        |        |        |        |        |     1,75u     |        |
+    └─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
+                 |        |   1,25u    |                                                        |   1,25u    |        |
+                 └────────────────────────────────────────────────────────────────────────────────────────────────────┘
+*/
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  [_BASE] = LAYOUT_60_tsangan_hhkb(
+//  ┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
+//  |        |        |        |        |        |        |        |        |        |        |        |        |        |        |       |
+      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_NUBS, KC_RBRC,
+//  |─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────|
+//  |    1,5u    |        |        |        |        |        |        |        |        |        |        |        |        |     1,5u   |
+  LT(_NAV,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_NUHS,   KC_BSPC,
+//  |─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────|
+//  |     1,75u    |        |        |        |        |        |        |        |        |        |        |        |        1,25u      |
+         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,
+//  |─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────|
+//  |   1,25u          |        |        |        |        |        |        |        |        |        |        |     1,75u     |        |
+           KC_LSFT,       KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,   KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH,    KC_RSFT,     MO(_FN),
+//  └─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
+//                   |        |   1,25u    |                                                        |   1,25u    |        |
+         XXXXXXX,     KC_LGUI,   KC_LALT,                         KC_SPACE,                            KC_RALT,   KC_RGUI,      XXXXXXX
+//                   └────────────────────────────────────────────────────────────────────────────────────────────────────┘
+  ),
+  [_NAV] = LAYOUT_60_tsangan_hhkb(
+//  ┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
+//  |        |        |        |        |        |        |        |        |        |        |        |        |        |        |       |
+     _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,  KC_INS, KC_BSPC,
+//  |─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────|
+//  |    1,5u    |        |        |        |        |        |        |        |        |        |        |        |        |     1,5u   |
+      _______,    _______, _______, _______, _______, _______, KC_END,  KC_PGDN, KC_UP,   KC_PGUP, KC_HOME, _______, _______,    KC_DEL,
+//  |─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────|
+//  |     1,75u    |        |        |        |        |        |        |        |        |        |        |        |        1,25u      |
+       _______,     _______, _______, _______, _______, _______, _______, KC_LEFT, KC_DOWN, KC_RGHT, _______, _______,       _______,
+//  |─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────|
+//  |   1,25u          |        |        |        |        |        |        |        |        |        |        |     1,75u     |        |
+          _______,      _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,    _______,     _______,
+//  └─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
+//                   |        |   1,25u    |                                                        |   1,25u    |        |
+         XXXXXXX,     _______,  _______,                         _______,                             _______,    _______,      XXXXXXX
+//                   └────────────────────────────────────────────────────────────────────────────────────────────────────┘
+  ),
+  [_FN] = LAYOUT_60_tsangan_hhkb(
+//  ┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
+//  |        |        |        |        |        |        |        |        |        |        |        |        |        |        |       |
+      RESET,   KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12, _______, _______,
+//  |─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────|
+//  |    1,5u    |        |        |        |        |        |        |        |        |        |        |        |        |     1,5u   |
+      _______,   _______,  _______, _______, RGB_TOG, RGB_HUI, RGB_SAI, RGB_VAI, _______, _______, _______, _______, _______,   _______,
+//  |─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────|
+//  |     1,75u    |        |        |        |        |        |        |        |        |        |        |        |        1,25u      |
+        KC_RCTL,    KC_VOLD, KC_VOLU, KC_MUTE, RGB_MOD, RGB_HUD, RGB_SAD, RGB_VAD, _______, _______, _______, _______,       MY_LOCK,
+//  |─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────|
+//  |   1,25u          |        |        |        |        |        |        |        |        |        |        |     1,75u     |        |
+          _______,      BL_TOGG,  BL_INC,  BL_DEC, BL_STEP, _______, _______, _______, KC_MRWD, KC_MFFD, _______,    _______,     _______,
+//  └─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
+//                   |        |   1,25u    |                                                        |   1,25u    |        |
+         XXXXXXX,     _______,  _______,                          KC_MPLY,                            _______,    _______,      XXXXXXX
+//                   └────────────────────────────────────────────────────────────────────────────────────────────────────┘
+  ),
+};
diff --git a/keyboards/ai03/polaris/keymaps/mekberg/readme.md b/keyboards/ai03/polaris/keymaps/mekberg/readme.md
new file mode 100644
index 0000000000..b9ae9642f5
--- /dev/null
+++ b/keyboards/ai03/polaris/keymaps/mekberg/readme.md
@@ -0,0 +1,14 @@
+# General Information
+
+This is more or less a HHKB base layout, but with completely different Fn layers. I don't use most of the HHKB secondary key positions because, honestly, they make no sense to me at all.
+
+Fn key layer is focused mostly on keyboard firmware features (like RGB) as well as some of the necessary alternate functions. It also hold media controls, F-keys and Reset.
+
+Left Tab-Hold layer is focused on nav cluster functionality, and turns Backspace into Delete (and moves Backspace up into the top right 1u position).
+
+
+# Build instructions
+
+To simply build the firmware file: `make clean && make ai03/polaris:mekberg`
+
+To build and immediately flash: `make clean && make ai03/polaris:mekberg:flash`
diff --git a/keyboards/ai03/polaris/keymaps/mekberg/rules.mk b/keyboards/ai03/polaris/keymaps/mekberg/rules.mk
new file mode 100644
index 0000000000..e47bb9e6df
--- /dev/null
+++ b/keyboards/ai03/polaris/keymaps/mekberg/rules.mk
@@ -0,0 +1,2 @@
+BACKLIGHT_ENABLE = no      # Disable keyboard backlight functionality
+RGBLIGHT_ENABLE = no       # Disable keyboard RGB underglow