[Keyboard] Add Jabberwocky v2 and reorganize (qmk#19014)

Co-authored-by: Drashna Jaelre <[email protected]> Co-authored-by: Ryan <[email protected]>
elpekenin · Dec 7, 2022 · e108d68 · e108d68
1 parent a692223
commit e108d68
Show file tree

Hide file tree

Showing 20 changed files with 646 additions and 19 deletions.
diff --git a/keyboards/nopunin10did/jabberwocky/config.h → ...ards/nopunin10did/jabberwocky/v1/config.h b/keyboards/nopunin10did/jabberwocky/config.h → ...ards/nopunin10did/jabberwocky/v1/config.h
diff --git a/keyboards/nopunin10did/jabberwocky/info.json → ...rds/nopunin10did/jabberwocky/v1/info.json b/keyboards/nopunin10did/jabberwocky/info.json → ...rds/nopunin10did/jabberwocky/v1/info.json
@@ -1,15 +1,15 @@
 {
     "keyboard_name": "Jabberwocky",
     "manufacturer": "NoPunIn10Did",
-    "url": "https://github.com/qmk/qmk_firmware/tree/master/keyboards/nopunin10did/railroad",
+    "url": "https://github.com/qmk/qmk_firmware/tree/master/keyboards/nopunin10did/jabberwocky/v1",
     "maintainer": "NoPunIn10Did",
     "usb": {
         "vid": "0x4E50",
         "pid": "0x4A57",
         "device_version": "0.0.1"
     },
     "layouts": {
-        "LAYOUT_rh_any": {
+        "LAYOUT_rh": {
             "layout": [
                 {"x":0.75,   "y":0.25,  "label":"Esc"},
                 {"x":2.25,   "y":0.25,  "label":"F1"},

diff --git a/...0did/jabberwocky/keymaps/default/keymap.c → ...d/jabberwocky/v1/keymaps/default/keymap.c b/...0did/jabberwocky/keymaps/default/keymap.c → ...d/jabberwocky/v1/keymaps/default/keymap.c
@@ -18,7 +18,7 @@
 
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 
-[0] = LAYOUT_rh_any(
+[0] = LAYOUT_rh(
 
 KC_ESC ,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_PSCR,KC_SCRL,KC_INS ,KC_DEL ,KC_HOME,KC_END ,KC_PGUP,KC_PGDN,    
         KC_GRV ,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_BSPC,KC_BSPC,        KC_NUM ,KC_PSLS,KC_PAST,KC_PMNS,    
@@ -28,7 +28,7 @@ KC_LSFT,KC_LSFT,KC_Z   ,KC_X   ,KC_C   ,KC_V   ,KC_B   ,MO(1),  MO(1),  KC_N   ,
         KC_LCTL,KC_LGUI,        KC_LALT,KC_MENU,KC_SPC ,                KC_SPC ,        KC_ALGR,        KC_RGUI,KC_RCTL,KC_LEFT,KC_DOWN,KC_RGHT,        KC_P0  ,KC_P0  ,KC_PDOT,KC_PENT),   
 
 
-[1] = LAYOUT_rh_any(
+[1] = LAYOUT_rh(
 QK_BOOT  ,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,                XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,    
         XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,                XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,        XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,    
         XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,QK_BOOT  ,XXXXXXX,                XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,                XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,     

diff --git a/keyboards/nopunin10did/jabberwocky/v1/keymaps/nopunin10did/keymap.c b/keyboards/nopunin10did/jabberwocky/v1/keymaps/nopunin10did/keymap.c
@@ -0,0 +1,50 @@
+/* Copyright 2021 W. Alex Ronke, a.k.a. NoPunIn10Did ([email protected])
+ *
+ * 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 LSA_DEL LSA_T(KC_DEL)
+#define RALTHOM RALT_T(KC_HOME)
+#define RWINEND RGUI_T(KC_END)
+#define RCTLEND RCTL_T(KC_END)
+#define LSHNUBS LSFT_T(KC_NUBS)
+#define RSHF_RO RSFT_T(KC_INT1)
+#define FN_CALC LT(1,KC_CALC)
+#define FN_MENU LT(1,KC_MENU)
+#define FN_PENT LT(1,KC_PENT)
+#define CTALDEL LCA(KC_DEL)
+#define JPYEN   KC_INT3
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+[0] = LAYOUT_rh(
+
+KC_ESC ,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_HOME,KC_END ,KC_PGUP,KC_PGDN,KC_DEL ,KC_INS ,KC_PSCR,KC_BSPC,
+        KC_GRV ,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_BSPC,KC_BSPC,        KC_EQL ,KC_PSLS,KC_PAST,KC_PMNS,
+        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_BSLS,                KC_P7  ,KC_P8  ,KC_P9  ,KC_PPLS,
+        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_ENT ,                KC_P4  ,KC_P5  ,KC_P6  ,KC_PPLS,
+KC_LSFT,KC_LSFT,KC_Z   ,KC_X   ,KC_C   ,KC_V   ,KC_B   ,LSA_DEL,FN_CALC,KC_N   ,KC_M   ,KC_COMM,KC_DOT ,KC_SLSH,KC_RSFT,KC_RSFT,KC_UP  ,                KC_P1  ,KC_P2  ,KC_P3  ,FN_PENT,
+        KC_LCTL,KC_LGUI,        KC_LALT,FN_MENU,KC_SPC ,                RALTHOM,        RALTHOM,        RWINEND,RCTLEND,KC_LEFT,KC_DOWN,KC_RGHT,        KC_P0  ,KC_P0  ,KC_PDOT,FN_PENT),
+
+
+[1] = LAYOUT_rh_any(
+QK_BOOT,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,                XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,KC_F13 ,KC_F14 ,KC_F15 ,KC_F16 ,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,
+        XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,                XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,        KC_NUM ,XXXXXXX,XXXXXXX,XXXXXXX,
+        XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,QK_BOOT,XXXXXXX,                XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,JPYEN  ,                XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,
+        KC_CAPS,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,                XXXXXXX,XXXXXXX,XXXXXXX,KC_SCRL,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,                XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,
+LSHNUBS,LSHNUBS,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,KC_BRK ,CTALDEL,_______,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,XXXXXXX,RSHF_RO,RSHF_RO,XXXXXXX,                XXXXXXX,XXXXXXX,XXXXXXX,_______,
+        _______,_______,        _______,_______,XXXXXXX,                _______,        _______,        _______,_______,XXXXXXX,XXXXXXX,XXXXXXX,        XXXXXXX,XXXXXXX,KC_PCMM,_______)
+};
diff --git a/keyboards/nopunin10did/jabberwocky/v1/keymaps/via/keymap.c b/keyboards/nopunin10did/jabberwocky/v1/keymaps/via/keymap.c
@@ -0,0 +1,46 @@
+/* Copyright 2021 W. Alex Ronke, a.k.a. NoPunIn10Did ([email protected])
+ *
+ * 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
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+[0] = LAYOUT_lh(
+
+KC_HOME,KC_END ,KC_PGUP,KC_PGDN,KC_ESC ,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_PSCR,KC_SCRL,KC_INS ,KC_DEL ,
+KC_NUM ,KC_PSLS,KC_PAST,KC_PMNS,        KC_GRV ,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_BSPC,KC_BSPC,        
+KC_P7  ,KC_P8  ,KC_P9  ,KC_PPLS,        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_BSLS,                
+KC_P4  ,KC_P5  ,KC_P6  ,KC_PPLS,        KC_CAPS,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_ENT ,                
+KC_P1  ,KC_P2  ,KC_P3  ,KC_PENT,KC_LSFT,KC_LSFT,KC_Z   ,KC_X   ,KC_C   ,KC_V   ,KC_B   ,MO(1),  MO(1),  KC_N   ,KC_M   ,KC_COMM,KC_DOT ,KC_SLSH,KC_RSFT,KC_RSFT,KC_UP  ,                
+KC_P0  ,KC_P0  ,KC_PDOT,KC_PENT,        KC_LCTL,KC_LGUI,        KC_LALT,KC_MENU,KC_SPC ,                KC_SPC ,        KC_ALGR,        KC_RGUI,KC_RCTL,KC_LEFT,KC_DOWN,KC_RGHT)        ,
+
+
+[1] = LAYOUT_lh(
+_______,_______,_______,_______,QK_BOOT,_______,_______,_______,_______,_______,_______,                _______,_______,_______,_______,_______,_______,_______,_______,_______,_______,
+_______,_______,_______,_______,        _______,_______,_______,_______,_______,_______,                _______,_______,_______,_______,_______,_______,_______,_______,_______,        
+_______,_______,_______,_______,        _______,_______,_______,_______,QK_BOOT,_______,                _______,_______,_______,_______,_______,_______,_______,_______,                
+_______,_______,_______,_______,        _______,_______,_______,_______,_______,_______,                _______,_______,_______,_______,_______,_______,_______,_______,                
+_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,                
+_______,_______,_______,_______,        _______,_______,        _______,_______,_______,                _______,        _______,        _______,_______,_______,_______,_______)        ,
+
+[2] = LAYOUT_lh(
+_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,                _______,_______,_______,_______,_______,_______,_______,_______,_______,_______,
+_______,_______,_______,_______,        _______,_______,_______,_______,_______,_______,                _______,_______,_______,_______,_______,_______,_______,_______,_______,        
+_______,_______,_______,_______,        _______,_______,_______,_______,_______,_______,                _______,_______,_______,_______,_______,_______,_______,_______,                
+_______,_______,_______,_______,        _______,_______,_______,_______,_______,_______,                _______,_______,_______,_______,_______,_______,_______,_______,                
+_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,                
+_______,_______,_______,_______,        _______,_______,        _______,_______,_______,                _______,        _______,        _______,_______,_______,_______,_______)
+};
diff --git a/...jabberwocky/keymaps/nopunin10did/rules.mk → ...10did/jabberwocky/v1/keymaps/via/rules.mk b/...jabberwocky/keymaps/nopunin10did/rules.mk → ...10did/jabberwocky/v1/keymaps/via/rules.mk
diff --git a/keyboards/nopunin10did/jabberwocky/readme.md → ...rds/nopunin10did/jabberwocky/v1/readme.md b/keyboards/nopunin10did/jabberwocky/readme.md → ...rds/nopunin10did/jabberwocky/v1/readme.md
@@ -6,14 +6,16 @@ A full-size, columnar-staggered, Alice-style keyboard. The Jabberwocky comes in
 * Dexterous (with numpad on the right side, pictured above)
 * Sinister (with numpad on the left side)
 
-Both the Dexterous and Sinister use the same firmware.  The numpad and the four keys above it are simply transposed from the right to the left side of the board.
+Both the v1 Dexterous and v1 Sinister use the same firmware.  The numpad and the four keys above it are simply transposed from the right to the left side of the board.
 
 For more information, join the [NoPunIn10Key Discord](https://discord.gg/sku2Y6w).
 
 * Keyboard Maintainer: [Alex Ronke](https://nopunin10did.com/), also known as [NoPunIn10Did](https://github.com/NoPunIn10Did)
-* Hardware Supported: Dexterous Jabberwocky and Sinister Jabberwocky (2021 March)
+* Hardware Supported: Dexterous Jabberwocky and Sinister Jabberwocky v1 (2021 March)
 * Hardware Availability: Currently by request only
 
+**The v1 firmware is not compatible with any of the second-generation v2 Jabberwocky PCBs. Please use the [v2 firmware](../v2/readme.md) instead.**
+
 To reset the board into bootloader mode, do one of the following:
 
 * If loaded with the default layout, use Function-Escape or Function-R *(the function buttons are the 1u keys next to B and N)*
@@ -23,6 +25,6 @@ To reset the board into bootloader mode, do one of the following:
 
 Make example for this keyboard (after setting up your build environment):
 
-    make nopunin10did/jabberwocky:default
+    make nopunin10did/jabberwocky/v1:default
 
 See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
diff --git a/keyboards/nopunin10did/jabberwocky/rules.mk → ...ards/nopunin10did/jabberwocky/v1/rules.mk b/keyboards/nopunin10did/jabberwocky/rules.mk → ...ards/nopunin10did/jabberwocky/v1/rules.mk
diff --git a/...ds/nopunin10did/jabberwocky/jabberwocky.c → keyboards/nopunin10did/jabberwocky/v1/v1.c b/...ds/nopunin10did/jabberwocky/jabberwocky.c → keyboards/nopunin10did/jabberwocky/v1/v1.c
@@ -1,4 +1,4 @@
-/* Copyright 2021 W. Alex Ronke, a.k.a. NoPunIn10Did ([email protected])
+/* Copyright 2022 W. Alex Ronke, a.k.a. NoPunIn10Did ([email protected])
  *
  * 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
@@ -14,4 +14,4 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "jabberwocky.h"
+#include "v1.h"
diff --git a/...ds/nopunin10did/jabberwocky/jabberwocky.h → keyboards/nopunin10did/jabberwocky/v1/v1.h b/...ds/nopunin10did/jabberwocky/jabberwocky.h → keyboards/nopunin10did/jabberwocky/v1/v1.h
@@ -1,4 +1,4 @@
-/* Copyright 2021 W. Alex Ronke, a.k.a. NoPunIn10Did ([email protected])
+/* Copyright 2022 W. Alex Ronke, a.k.a. NoPunIn10Did ([email protected])
  *
  * 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
@@ -18,7 +18,7 @@
 
 #include "quantum.h"
 
-#define LAYOUT_rh_any( \
+#define LAYOUT_rh( \
 	K0007, K0101, K0100, K0201, K0200, K0301, K0300,               K0400, K0401, K0500, K0501, K0600, K0601, K0700, K0701, K0000, K0001, K0800, K0801, K0900, K0901, \
            K0004, K0102, K0103, K0202, K0203, K0302,               K0402, K0403, K0502, K0503, K0602, K0603, K0702, K0703, K0002,        K0802, K0803, K0902, K0903, \
            K0006, K0104, K0105, K0204, K0205, K0304,               K0404, K0405, K0504, K0505, K0604, K0605, K0704, K0705,               K0804, K0805, K0904, K0905, \
@@ -41,7 +41,7 @@
 	{ KC_NO, KC_NO, KC_NO, K0311, K0411, K0511, K0611, K0711, K0811, K0911 }  \
 }
 
-#define LAYOUT_lh_any( \
+#define LAYOUT_lh( \
 	K0800, K0801, K0900, K0901, K0007, K0101, K0100, K0201, K0200, K0301, K0300,               K0400, K0401, K0500, K0501, K0600, K0601, K0700, K0701, K0000, K0001,  \
     K0802, K0803, K0902, K0903,        K0004, K0102, K0103, K0202, K0203, K0302,               K0402, K0403, K0502, K0503, K0602, K0603, K0702, K0703, K0002,         \
     K0804, K0805, K0904, K0905,        K0006, K0104, K0105, K0204, K0205, K0304,               K0404, K0405, K0504, K0505, K0604, K0605, K0704, K0705,                \

diff --git a/keyboards/nopunin10did/jabberwocky/v2/config.h b/keyboards/nopunin10did/jabberwocky/v2/config.h
@@ -0,0 +1,50 @@
+/* Copyright 2022 W. Alex Ronke, a.k.a. NoPunIn10Did ([email protected])
+ *
+ * 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
+
+#include "config_common.h"
+
+/* key matrix size */
+#define MATRIX_ROWS         12
+#define MATRIX_COLS         10
+
+/* key matrix pins */
+#define MATRIX_ROW_PINS     { B2, B3, B1, D4, B4, D1, E6, B0, F0, F1, F4, F5 }
+#define MATRIX_COL_PINS     { D0, D2, D3, D5, B5, D7, F6, F7, C7, B6 }
+
+/* LED Configuration */
+#define BACKLIGHT_PINS          {D6}
+// To have all lights shine uniformly, add C6 and B7 to the list above, then undefine the constants below.
+#define LED_NUM_LOCK_PIN        C6
+#define LED_CAPS_LOCK_PIN       B7
+
+#define BACKLIGHT_LEVELS        6
+
+/* COL2ROW or ROW2COL */
+#define DIODE_DIRECTION     COL2ROW
+
+/* Set 0 if debouncing isn't needed */
+#define DEBOUNCE            5
+
+/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
+#define LOCKING_SUPPORT_ENABLE
+
+/* Locking resynchronize hack */
+#define LOCKING_RESYNC_ENABLE
+
+/* Reducing layer count to 3 for via support */
+#define DYNAMIC_KEYMAP_LAYER_COUNT  3