[Keymap] Mekberg kbd6x keymap (#7061)

* First draft of my layout * Improved layout and cleanup of files * Update keymap and add rules * Add keymap.h with permissive_hold setting * Rename keymap.h to correct name config.h * Add next/prev and special lock key to Fn layer * Use correct modifier in MY_LOCK command * Removed unnecessary filler defines * Add build instructions to README * Move RGB controls to more logical up/down key positions, move next/prev controls, remove del from Fn layer * Fix wrong placeholders and fix up formatting * Remove unused code * Clarify comments on custom defines * Update keyboards/kbdfans/kbd6x/keymaps/mekberg/rules.mk Co-Authored-By: fauxpark <fauxpark@gmail.com>
author: Endemoniada <martin@mekberg.se> 2019-10-19 02:37:16 +0200
committer: Drashna Jaelre <drashna@live.com> 2019-10-18 17:37:16 -0700
commit: 1b1e0977e020b3b381f874144aed31d0664d88d2 (patch)
tree: dacc24c74d3c1f886a78734017507e28f5378fbd
parent: d263579781bd550e0ef21a5a102f790afd588c7c (diff)
download: qmk_firmware-1b1e0977e020b3b381f874144aed31d0664d88d2.tar.gz
qmk_firmware-1b1e0977e020b3b381f874144aed31d0664d88d2.zip
4 files changed, 119 insertions, 0 deletions
diff --git a/keyboards/kbdfans/kbd6x/keymaps/mekberg/config.h b/keyboards/kbdfans/kbd6x/keymaps/mekberg/config.h
new file mode 100644
index 000000000..d29180a5a
--- /dev/null
+++ b/keyboards/kbdfans/kbd6x/keymaps/mekberg/config.h
@@ -0,0 +1,5 @@
+#pragma once
+// Define some configuration for modtap behavior
+// #define TAPPING_TERM 150
+#define PERMISSIVE_HOLD
diff --git a/keyboards/kbdfans/kbd6x/keymaps/mekberg/keymap.c b/keyboards/kbdfans/kbd6x/keymaps/mekberg/keymap.c
new file mode 100644
index 000000000..f3be99263
--- /dev/null
+++ b/keyboards/kbdfans/kbd6x/keymaps/mekberg/keymap.c
@@ -0,0 +1,98 @@
+/* Copyright 2018 MechMerlin
+ *
+ * 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
+// #define MY_LOCK C(A(KC_L))      // Mac: Custom lock hotkey in BTT
+#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] = {
+  [0] = LAYOUT(
+//  ┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
+//  |        |        |        |        |        |        |        |        |        |        |        |        |        |        |       |
+      KC_ESC,  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_NUHS,
+//  |─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────|
+//  |    1,5u    |        |        |        |        |        |        |        |        |        |        |        |        |     1,5u   |
+     LT(2,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,
+//  |─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────|
+//  |     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(1),
+//  └─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
+//                   |        |   1,25u    |                                                        |   1,25u    |        |
+         XXXXXXX,     KC_LGUI,   KC_LALT,                         KC_SPACE,                            KC_RALT,   KC_RGUI,      XXXXXXX
+//                   └────────────────────────────────────────────────────────────────────────────────────────────────────┘
+  ),
+//  Fn layer, left hand free
+//  F-keys, RGB controls, media controls, Keyboard functions
+  [1] = LAYOUT(
+//  ┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
+//  |        |        |        |        |        |        |        |        |        |        |        |        |        |        |       |
+      KC_GRV,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12, _______,  RESET,
+//  |─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────|
+//  |    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
+//                   └────────────────────────────────────────────────────────────────────────────────────────────────────┘
+  ),
+//  Left Tab-Hold layer, right hand free
+//  Nav-keys
+  [2] = LAYOUT(
+//  ┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
+//  |        |        |        |        |        |        |        |        |        |        |        |        |        |        |       |
+     _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,  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
+//                   └────────────────────────────────────────────────────────────────────────────────────────────────────┘
+  ),
+};
diff --git a/keyboards/kbdfans/kbd6x/keymaps/mekberg/readme.md b/keyboards/kbdfans/kbd6x/keymaps/mekberg/readme.md
new file mode 100644
index 000000000..febe2e1d6
--- /dev/null
+++ b/keyboards/kbdfans/kbd6x/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 kbdfans/kbd6x:mekberg`
+To build and immediately flash: `make clean && make kbdfans/kbd6x:mekberg:dfu`
diff --git a/keyboards/kbdfans/kbd6x/keymaps/mekberg/rules.mk b/keyboards/kbdfans/kbd6x/keymaps/mekberg/rules.mk
new file mode 100644
index 000000000..257214607
--- /dev/null
+++ b/keyboards/kbdfans/kbd6x/keymaps/mekberg/rules.mk
@@ -0,0 +1,2 @@
+NKRO_ENABLE = yes            # USB Nkey Rollover
+CONSOLE_ENABLE = no        # Console for debug
author	Endemoniada <martin@mekberg.se>	2019-10-19 02:37:16 +0200
committer	Drashna Jaelre <drashna@live.com>	2019-10-18 17:37:16 -0700
commit	1b1e0977e020b3b381f874144aed31d0664d88d2 (patch)
tree	dacc24c74d3c1f886a78734017507e28f5378fbd
parent	d263579781bd550e0ef21a5a102f790afd588c7c (diff)
download	qmk_firmware-1b1e0977e020b3b381f874144aed31d0664d88d2.tar.gz qmk_firmware-1b1e0977e020b3b381f874144aed31d0664d88d2.zip

diff --git a/keyboards/kbdfans/kbd6x/keymaps/mekberg/config.h b/keyboards/kbdfans/kbd6x/keymaps/mekberg/config.h new file mode 100644 index 000000000..d29180a5a --- /dev/null +++ b/keyboards/kbdfans/kbd6x/keymaps/mekberg/config.h
@@ -0,0 +1,5 @@
	1	#pragma once
	2
	3	// Define some configuration for modtap behavior
	4	// #define TAPPING_TERM 150
	5	#define PERMISSIVE_HOLD


diff --git a/keyboards/kbdfans/kbd6x/keymaps/mekberg/keymap.c b/keyboards/kbdfans/kbd6x/keymaps/mekberg/keymap.c new file mode 100644 index 000000000..f3be99263 --- /dev/null +++ b/keyboards/kbdfans/kbd6x/keymaps/mekberg/keymap.c
@@ -0,0 +1,98 @@
	1	/* Copyright 2018 MechMerlin
	2	*
	3	* This program is free software: you can redistribute it and/or modify
	4	* it under the terms of the GNU General Public License as published by
	5	* the Free Software Foundation, either version 2 of the License, or
	6	* (at your option) any later version.
	7	*
	8	* This program is distributed in the hope that it will be useful,
	9	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	10	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	11	* GNU General Public License for more details.
	12	*
	13	* You should have received a copy of the GNU General Public License
	14	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	15	*/
	16	#include QMK_KEYBOARD_H
	17
	18	// #define MY_LOCK C(A(KC_L)) // Mac: Custom lock hotkey in BTT
	19	#define MY_LOCK C(LCMD(KC_L)) // Mac: Custom lock hotkey in BTT (when Alt/Command have been swapped in macOS)
	20
	21	/*
	22	KBD6x ANSI physical layout
	23	1u == 8chars
	24	┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
	25	\| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \|
	26	\|─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────\|
	27	\| 1,5u \| \| \| \| \| \| \| \| \| \| \| \| \| 1,5u \|
	28	\|─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────\|
	29	\| 1,75u \| \| \| \| \| \| \| \| \| \| \| \| 1,25u \|
	30	\|─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────\|
	31	\| 2,25u \| \| \| \| \| \| \| \| \| \| \| 1,75u \| \|
	32	└─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
	33	\| \| 1,25u \| \| 1,25u \| \|
	34	└────────────────────────────────────────────────────────────────────────────────────────────────────┘
	35	*/
	36
	37	const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
	38	[0] = LAYOUT(
	39	// ┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
	40	// \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \|
	41	KC_ESC, 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_NUHS,
	42	// \|─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────\|
	43	// \| 1,5u \| \| \| \| \| \| \| \| \| \| \| \| \| 1,5u \|
	44	LT(2,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,
	45	// \|─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────\|
	46	// \| 1,75u \| \| \| \| \| \| \| \| \| \| \| \| 1,25u \|
	47	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,
	48	// \|─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────\|
	49	// \| 1,25u \| \| \| \| \| \| \| \| \| \| \| 1,75u \| \|
	50	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(1),
	51	// └─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
	52	// \| \| 1,25u \| \| 1,25u \| \|
	53	XXXXXXX, KC_LGUI, KC_LALT, KC_SPACE, KC_RALT, KC_RGUI, XXXXXXX
	54	// └────────────────────────────────────────────────────────────────────────────────────────────────────┘
	55	),
	56
	57	// Fn layer, left hand free
	58	// F-keys, RGB controls, media controls, Keyboard functions
	59	[1] = LAYOUT(
	60	// ┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
	61	// \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \|
	62	KC_GRV, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, _______, RESET,
	63	// \|─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────\|
	64	// \| 1,5u \| \| \| \| \| \| \| \| \| \| \| \| \| 1,5u \|
	65	_______, _______, _______, _______, RGB_TOG, RGB_HUI, RGB_SAI, RGB_VAI, _______, _______, _______, _______, _______, _______,
	66	// \|─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────\|
	67	// \| 1,75u \| \| \| \| \| \| \| \| \| \| \| \| 1,25u \|
	68	KC_RCTL, KC_VOLD, KC_VOLU, KC_MUTE, RGB_MOD, RGB_HUD, RGB_SAD, RGB_VAD, _______, _______, _______, _______, MY_LOCK,
	69	// \|─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────\|
	70	// \| 1,25u \| \| \| \| \| \| \| \| \| \| \| 1,75u \| \|
	71	_______, BL_TOGG, BL_INC, BL_DEC, BL_STEP, _______, _______, _______, KC_MRWD, KC_MFFD, _______, _______, _______,
	72	// └─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
	73	// \| \| 1,25u \| \| 1,25u \| \|
	74	XXXXXXX, _______, _______, KC_MPLY, _______, _______, XXXXXXX
	75	// └────────────────────────────────────────────────────────────────────────────────────────────────────┘
	76	),
	77
	78	// Left Tab-Hold layer, right hand free
	79	// Nav-keys
	80	[2] = LAYOUT(
	81	// ┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
	82	// \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \|
	83	_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_INS, KC_BSPC,
	84	// \|─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────\|
	85	// \| 1,5u \| \| \| \| \| \| \| \| \| \| \| \| \| 1,5u \|
	86	_______, _______, _______, _______, _______, _______, KC_END, KC_PGDN, KC_UP, KC_PGUP, KC_HOME, _______, _______, KC_DEL,
	87	// \|─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────\|
	88	// \| 1,75u \| \| \| \| \| \| \| \| \| \| \| \| 1,25u \|
	89	_______, _______, _______, _______, _______, _______, _______, KC_LEFT, KC_DOWN, KC_RGHT, _______, _______, _______,
	90	// \|─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────\|
	91	// \| 1,25u \| \| \| \| \| \| \| \| \| \| \| 1,75u \| \|
	92	_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
	93	// └─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
	94	// \| \| 1,25u \| \| 1,25u \| \|
	95	XXXXXXX, _______, _______, _______, _______, _______, XXXXXXX
	96	// └────────────────────────────────────────────────────────────────────────────────────────────────────┘
	97	),
	98	};


diff --git a/keyboards/kbdfans/kbd6x/keymaps/mekberg/readme.md b/keyboards/kbdfans/kbd6x/keymaps/mekberg/readme.md new file mode 100644 index 000000000..febe2e1d6 --- /dev/null +++ b/keyboards/kbdfans/kbd6x/keymaps/mekberg/readme.md
@@ -0,0 +1,14 @@
	1	# General Information
	2
	3	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.
	4
	5	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.
	6
	7	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).
	8
	9
	10	# Build instructions
	11
	12	To simply build the firmware file: `make clean && make kbdfans/kbd6x:mekberg`
	13
	14	To build and immediately flash: `make clean && make kbdfans/kbd6x:mekberg:dfu`


diff --git a/keyboards/kbdfans/kbd6x/keymaps/mekberg/rules.mk b/keyboards/kbdfans/kbd6x/keymaps/mekberg/rules.mk new file mode 100644 index 000000000..257214607 --- /dev/null +++ b/keyboards/kbdfans/kbd6x/keymaps/mekberg/rules.mk
@@ -0,0 +1,2 @@
	1	NKRO_ENABLE = yes # USB Nkey Rollover
	2	CONSOLE_ENABLE = no # Console for debug