summaryrefslogtreecommitdiffstats
path: root/keyboards/projectcain/vault45
diff options
context:
space:
mode:
authorprojectcain <71684775+projectcain@users.noreply.github.com>2021-07-20 00:28:32 -0500
committerGitHub <noreply@github.com>2021-07-19 22:28:32 -0700
commit815c17b726918bdb4ebff2877d83bff72d81c443 (patch)
tree75459832f5f85b6ca771ec7f69959933f4c390db /keyboards/projectcain/vault45
parentb887a1b9957664200363fc8feeb2865464c468a2 (diff)
[Keyboard] Add vault45 (#13119)
* adding my keymap * Update keyboards/projectcain/vault45/keymaps/default/config.h Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/projectcain/vault45/keymaps/default/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/projectcain/vault45/keymaps/default/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/projectcain/vault45/vault45.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/projectcain/vault45/keymaps/default/keymap.c Co-authored-by: Drashna Jaelre <drashna@live.com> * Update readme.md * Update keyboards/projectcain/vault45/keymaps/default/config.h Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keymap.c * Update keyboards/projectcain/vault45/keymaps/default/config.h Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/projectcain/vault45/readme.md Co-authored-by: ridingqwerty <george.g.koenig@gmail.com> * Update info.json * Update keyboards/projectcain/vault45/vault45.c Co-authored-by: ridingqwerty <george.g.koenig@gmail.com> * Update keyboards/projectcain/vault45/readme.md Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/projectcain/vault45/readme.md Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/projectcain/vault45/readme.md Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: ridingqwerty <george.g.koenig@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/projectcain/vault45')
-rw-r--r--keyboards/projectcain/vault45/config.h152
-rw-r--r--keyboards/projectcain/vault45/info.json60
-rw-r--r--keyboards/projectcain/vault45/keymaps/default/config.h24
-rw-r--r--keyboards/projectcain/vault45/keymaps/default/keymap.c59
-rw-r--r--keyboards/projectcain/vault45/keymaps/default/readme.md1
-rw-r--r--keyboards/projectcain/vault45/keymaps/default/rules.mk2
-rw-r--r--keyboards/projectcain/vault45/readme.md21
-rw-r--r--keyboards/projectcain/vault45/rules.mk22
-rw-r--r--keyboards/projectcain/vault45/vault45.c35
-rw-r--r--keyboards/projectcain/vault45/vault45.h40
10 files changed, 416 insertions, 0 deletions
diff --git a/keyboards/projectcain/vault45/config.h b/keyboards/projectcain/vault45/config.h
new file mode 100644
index 0000000000..2cbf55dd0f
--- /dev/null
+++ b/keyboards/projectcain/vault45/config.h
@@ -0,0 +1,152 @@
+/*
+Copyright 2021 projectcain
+
+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"
+
+/* USB Device descriptor parameter */
+#define VENDOR_ID 0xFEED
+#define PRODUCT_ID 0x6060
+#define DEVICE_VER 0x0001
+#define MANUFACTURER projectcain
+#define PRODUCT vault45
+
+/* key matrix size */
+#define MATRIX_ROWS 4
+#define MATRIX_COLS 13
+
+/*
+ * Keyboard Matrix Assignments
+ *
+ * Change this to how you wired your keyboard
+ * COLS: AVR pins used for columns, left to right
+ * ROWS: AVR pins used for rows, top to bottom
+ * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode)
+ * ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode)
+ *
+ */
+#define MATRIX_ROW_PINS { C6, B6, B5, C7 }
+#define MATRIX_COL_PINS { B0, D5, D4, D6, D7, B4, D3, F0, F1, F4, F5, F6, F7 }
+#define UNUSED_PINS
+
+/* COL2ROW, ROW2COL */
+#define DIODE_DIRECTION COL2ROW
+
+/*
+ * Split Keyboard specific options, make sure you have 'SPLIT_KEYBOARD = yes' in your rules.mk, and define SOFT_SERIAL_PIN.
+ */
+#define SOFT_SERIAL_PIN D0 // or D1, D2, D3, E6
+
+//#define LED_NUM_LOCK_PIN B0
+//#define LED_CAPS_LOCK_PIN B1
+//#define LED_SCROLL_LOCK_PIN B2
+//#define LED_COMPOSE_PIN B3
+//#define LED_KANA_PIN B4
+
+//#define BACKLIGHT_PIN B7
+//#define BACKLIGHT_LEVELS 3
+//#define BACKLIGHT_BREATHING
+
+//#define RGB_DI_PIN E2
+//#ifdef RGB_DI_PIN
+//# define RGBLED_NUM 16
+//# define RGBLIGHT_HUE_STEP 8
+//# define RGBLIGHT_SAT_STEP 8
+//# define RGBLIGHT_VAL_STEP 8
+//# define RGBLIGHT_LIMIT_VAL 255 /* The maximum brightness level */
+//# define RGBLIGHT_SLEEP /* If defined, the RGB lighting will be switched off when the host goes to sleep */
+/*== all animations enable ==*/
+//# define RGBLIGHT_ANIMATIONS
+/*== or choose animations ==*/
+//# define RGBLIGHT_EFFECT_BREATHING
+//# define RGBLIGHT_EFFECT_RAINBOW_MOOD
+//# define RGBLIGHT_EFFECT_RAINBOW_SWIRL
+//# define RGBLIGHT_EFFECT_SNAKE
+//# define RGBLIGHT_EFFECT_KNIGHT
+//# define RGBLIGHT_EFFECT_CHRISTMAS
+//# define RGBLIGHT_EFFECT_STATIC_GRADIENT
+//# define RGBLIGHT_EFFECT_RGB_TEST
+//# define RGBLIGHT_EFFECT_ALTERNATING
+/*== customize breathing effect ==*/
+/*==== (DEFAULT) use fixed table instead of exp() and sin() ====*/
+//# define RGBLIGHT_BREATHE_TABLE_SIZE 256 // 256(default) or 128 or 64
+/*==== use exp() and sin() ====*/
+//# define RGBLIGHT_EFFECT_BREATHE_CENTER 1.85 // 1 to 2.7
+//# define RGBLIGHT_EFFECT_BREATHE_MAX 255 // 0 to 255
+//#endif
+
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
+#define DEBOUNCE 5
+
+/* define if matrix has ghost (lacks anti-ghosting diodes) */
+//#define MATRIX_HAS_GHOST
+
+/* 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
+
+/* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
+ * This is useful for the Windows task manager shortcut (ctrl+shift+esc).
+ */
+//#define GRAVE_ESC_CTRL_OVERRIDE
+
+/*
+ * Force NKRO
+ *
+ * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
+ * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
+ * makefile for this to work.)
+ *
+ * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
+ * until the next keyboard reset.
+ *
+ * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
+ * fully operational during normal computer usage.
+ *
+ * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
+ * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
+ * bootmagic, NKRO mode will always be enabled until it is toggled again during a
+ * power-up.
+ *
+ */
+//#define FORCE_NKRO
+
+/*
+ * Feature disable options
+ * These options are also useful to firmware size reduction.
+ */
+
+/* disable debug print */
+//#define NO_DEBUG
+
+/* disable print */
+//#define NO_PRINT
+
+/* disable action features */
+//#define NO_ACTION_LAYER
+//#define NO_ACTION_TAPPING
+//#define NO_ACTION_ONESHOT
+
+/* disable these deprecated features by default */
+#define NO_ACTION_MACRO
+#define NO_ACTION_FUNCTION
+
+/* Bootmagic Lite key configuration */
+//#define BOOTMAGIC_LITE_ROW 0
+//#define BOOTMAGIC_LITE_COLUMN 0
diff --git a/keyboards/projectcain/vault45/info.json b/keyboards/projectcain/vault45/info.json
new file mode 100644
index 0000000000..a9627895c9
--- /dev/null
+++ b/keyboards/projectcain/vault45/info.json
@@ -0,0 +1,60 @@
+{
+ "keyboard_name": "vault 45",
+ "url": "",
+ "maintainer": "projectcain",
+ "width": 13,
+ "height": 4,
+ "layouts": {
+ "LAYOUT": {
+ "layout": [
+ { "label": "Tab", "x": 0, "y": 0 },
+ { "label": "Q", "x": 1, "y": 0 },
+ { "label": "W", "x": 2, "y": 0 },
+ { "label": "E", "x": 3, "y": 0 },
+ { "label": "R", "x": 4, "y": 0 },
+ { "label": "T", "x": 5, "y": 0 },
+ { "label": "Y", "x": 6, "y": 0 },
+ { "label": "U", "x": 7, "y": 0 },
+ { "label": "I", "x": 8, "y": 0 },
+ { "label": "O", "x": 9, "y": 0 },
+ { "label": "P", "x": 10, "y": 0 },
+ { "label": "Back<br>Space", "x": 11, "y": 0 },
+ { "x": 12, "y": 0 },
+ { "label": "Caps", "x": 0, "y": 1, "w": 1.25 },
+ { "label": "A", "x": 1.25, "y": 1 },
+ { "label": "S", "x": 2.25, "y": 1 },
+ { "label": "D", "x": 3.25, "y": 1 },
+ { "label": "F", "x": 4.25, "y": 1 },
+ { "label": "G", "x": 5.25, "y": 1 },
+ { "label": "H", "x": 6.25, "y": 1 },
+ { "label": "J", "x": 7.25, "y": 1 },
+ { "label": "K", "x": 8.25, "y": 1 },
+ { "label": "L", "x": 9.25, "y": 1 },
+ { "label": ":", "x": 10.25, "y": 1 },
+ { "label": "Enter", "x": 11.25, "y": 1, "w": 1.75 },
+ { "label": "Shift", "x": 0, "y": 2, "w": 1.75 },
+ { "label": "Z", "x": 1.75, "y": 2 },
+ { "label": "X", "x": 2.75, "y": 2 },
+ { "label": "C", "x": 3.75, "y": 2 },
+ { "label": "V", "x": 4.75, "y": 2 },
+ { "label": "B", "x": 5.75, "y": 2 },
+ { "label": "N", "x": 6.75, "y": 2 },
+ { "label": "M", "x": 7.75, "y": 2 },
+ { "label": "<", "x": 8.75, "y": 2 },
+ { "label": ">", "x": 9.75, "y": 2 },
+ { "label": "?", "x": 10.75, "y": 2 },
+ { "label": "Shift", "x": 11.75, "y": 2, "w": 1.25 },
+ { "label": "Hyper", "x": 0, "y": 3, "w": 1.25 },
+ { "label": "Super", "x": 1.25, "y": 3 },
+ { "label": "Meta", "x": 2.25, "y": 3, "w": 1.25 },
+ { "label": "Alt", "x": 3.5, "y": 3, "w": 1.25 },
+ { "x": 4.75, "y": 3, "w": 1.75 },
+ { "x": 6.5, "y": 3, "w": 1.75 },
+ { "label": "Meta", "x": 8.25, "y": 3, "w": 1.25 },
+ { "label": "Super", "x": 9.5, "y": 3, "w": 1.25 },
+ { "label": "Fn2", "x": 10.75, "y": 3 },
+ { "label": "Ctrl", "x": 11.75, "y": 3, "w": 1.25 }
+ ]
+ }
+ }
+}
diff --git a/keyboards/projectcain/vault45/keymaps/default/config.h b/keyboards/projectcain/vault45/keymaps/default/config.h
new file mode 100644
index 0000000000..81321715af
--- /dev/null
+++ b/keyboards/projectcain/vault45/keymaps/default/config.h
@@ -0,0 +1,24 @@
+ /* Copyright 2021 projectcain
+ *
+ * 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 ENCODERS_PAD_A { B3, D1 }
+#define ENCODERS_PAD_B { B2, D2 }
+#define ENCODER_RESOLUTION 2
+#define COMBO_COUNT 2
+#define COMBO_TERM 50
+#define TAPPING_FORCE_HOLD
diff --git a/keyboards/projectcain/vault45/keymaps/default/keymap.c b/keyboards/projectcain/vault45/keymaps/default/keymap.c
new file mode 100644
index 0000000000..9307370200
--- /dev/null
+++ b/keyboards/projectcain/vault45/keymaps/default/keymap.c
@@ -0,0 +1,59 @@
+ /* Copyright 2021 projectcain
+ *
+ * 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.
+ * */
+
+#include QMK_KEYBOARD_H
+enum layers{
+ BASE,
+ NUM,
+ SYM,
+ META
+};
+
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+ [BASE] = LAYOUT(
+ KC_ESC, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC, KC_F5,
+ KC_TAB, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_QUOTE, LT(SYM, KC_ENT),
+ RCTL_T(S(KC_9)), KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, S(KC_0),
+ LALT(KC_TAB), LALT(KC_TAB), MO(1), SFT_T(KC_BSPC), KC_SPACE, KC_SPACE, MO(2), KC_LGUI, G(KC_TAB)
+ ),
+
+ [NUM] = LAYOUT(
+ KC_TRNS, KC_PGUP, KC_HOME, KC_UP, KC_END, KC_WBAK, KC_PSLS, KC_7, KC_8, KC_9, KC_PMNS, KC_DEL, RESET,
+ KC_TRNS, KC_PGDN, KC_LEFT, KC_DOWN, KC_RGHT, KC_WFWD, KC_PAST, KC_4, KC_5, KC_6, KC_PPLS, KC_TRNS,
+ KC_LBRC, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_0, KC_1, KC_2, KC_3, KC_PDOT, KC_RBRC,
+ KC_PSCR, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, S(KC_RCTRL), RALT(KC_F4), RALT(KC_F4)
+ ),
+
+ [SYM] = LAYOUT(
+ RGB_TOG, S(KC_GRV), KC_GRV, KC_BSLS, S(KC_BSLS), KC_TRNS, KC_TRNS, S(KC_MINS), KC_EQL, KC_TRNS, C(KC_W), C(KC_T), KC_TRNS,
+ KC_TRNS, S(KC_1), S(KC_2), S(KC_3), S(KC_4), S(KC_5), S(KC_6), S(KC_7), S(KC_8), KC_SCLN, S(KC_SCLN), KC_TRNS,
+ S(KC_LBRC), KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, S(KC_RBRC),
+ KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_CAPSLOCK, KC_NUMLOCK, KC_TRNS
+ ),
+
+};
+
+
+enum combos {
+ KL_SLSH,
+ JK_MINUS
+};
+
+const uint16_t PROGMEM kl_combo[] = {KC_K, KC_L, COMBO_END};
+const uint16_t PROGMEM jk_combo[] = {KC_J, KC_K, COMBO_END};
+
+combo_t key_combos[COMBO_COUNT] = {
+ [KL_SLSH] = COMBO(kl_combo, S(KC_SLSH)),
+ [JK_MINUS] = COMBO(jk_combo, KC_MINUS)
+};
diff --git a/keyboards/projectcain/vault45/keymaps/default/readme.md b/keyboards/projectcain/vault45/keymaps/default/readme.md
new file mode 100644
index 0000000000..ce333c3b81
--- /dev/null
+++ b/keyboards/projectcain/vault45/keymaps/default/readme.md
@@ -0,0 +1 @@
+# The default keymap for vault45
diff --git a/keyboards/projectcain/vault45/keymaps/default/rules.mk b/keyboards/projectcain/vault45/keymaps/default/rules.mk
new file mode 100644
index 0000000000..dca6713d4f
--- /dev/null
+++ b/keyboards/projectcain/vault45/keymaps/default/rules.mk
@@ -0,0 +1,2 @@
+ENCODER_ENABLE = yes
+COMBO_ENABLE = yes \ No newline at end of file
diff --git a/keyboards/projectcain/vault45/readme.md b/keyboards/projectcain/vault45/readme.md
new file mode 100644
index 0000000000..a84feaf224
--- /dev/null
+++ b/keyboards/projectcain/vault45/readme.md
@@ -0,0 +1,21 @@
+# vault45
+
+![vault45](https://i.imgur.com/SYrsbQEh.jpeg)
+
+This is a 40% HHKB-style keyboard inspired by the JD45 with updated bottom row options and rotary encoders.
+
+* Keyboard Maintainer: [projectcain](https://github.com/projectcain)
+* Hardware Supported: Vault 45 PCB
+* Hardware Availability: mechvault.net
+
+To reset the keyboard into bootloader mode, short the two pads labeled "Reset" on the left side of the pcb
+
+Make example for this keyboard (after setting up your build environment):
+
+ make projectcain/vault45:default
+
+Flashing example for this keyboard:
+
+ make projectcain/vault45:default:flash
+
+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/projectcain/vault45/rules.mk b/keyboards/projectcain/vault45/rules.mk
new file mode 100644
index 0000000000..5c0d8f307c
--- /dev/null
+++ b/keyboards/projectcain/vault45/rules.mk
@@ -0,0 +1,22 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader selection
+BOOTLOADER = atmel-dfu
+
+# Build Options
+# change yes to no to disable
+#
+BOOTMAGIC_ENABLE = lite # Virtual DIP switch configuration
+MOUSEKEY_ENABLE = yes # Mouse keys
+EXTRAKEY_ENABLE = yes # Audio control and System control
+CONSOLE_ENABLE = no # Console for debug
+COMMAND_ENABLE = no # Commands for debug and configuration
+# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
+SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend
+# if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
+NKRO_ENABLE = no # USB Nkey Rollover
+BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow
+BLUETOOTH_ENABLE = no # Enable Bluetooth
+AUDIO_ENABLE = no # Audio output
diff --git a/keyboards/projectcain/vault45/vault45.c b/keyboards/projectcain/vault45/vault45.c
new file mode 100644
index 0000000000..fa82335492
--- /dev/null
+++ b/keyboards/projectcain/vault45/vault45.c
@@ -0,0 +1,35 @@
+/* Copyright 2021 projectcain
+ *
+ * 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 "vault45.h"
+
+bool encoder_update_kb(uint8_t index, bool clockwise) {
+ if (!encoder_update_user(index, clockwise)) { return false; }
+ if (index == 0) { /* First encoder */
+ if (clockwise) {
+ tap_code(KC_PGDN);
+ } else {
+ tap_code(KC_PGUP);
+ }
+ } else if (index == 1) { /* Second encoder */
+ if (clockwise) {
+ tap_code(KC_DOWN);
+ } else {
+ tap_code(KC_UP);
+ }
+ }
+ return true;
+}
diff --git a/keyboards/projectcain/vault45/vault45.h b/keyboards/projectcain/vault45/vault45.h
new file mode 100644
index 0000000000..031de0003a
--- /dev/null
+++ b/keyboards/projectcain/vault45/vault45.h
@@ -0,0 +1,40 @@
+/* Copyright 2021 projectcain
+ *
+ * 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 "quantum.h"
+
+/* This is a shortcut to help you visually see your layout.
+ *
+ * The first section contains all of the arguments representing the physical
+ * layout of the board and position of the keys.
+ *
+ * The second converts the arguments into a two-dimensional array which
+ * represents the switch matrix.
+ */
+#define LAYOUT( \
+ K000, K001, K002, K003, K004, K005, K006, K007, K008, K009, K010, K011, K012, \
+ K100, K101, K102, K103, K104, K105, K106, K107, K108, K109, K110, K112, \
+ K200, K202, K203, K204, K205, K206, K207, K208, K209, K210, K211, K212, \
+ K301, K302, K304, K305, K306, K307, K308, K310, K311 \
+) \
+{ \
+ { K000, K001, K002, K003, K004, K005, K006, K007, K008, K009, K010, K011, K012 }, \
+ { K100, K101, K102, K103, K104, K105, K106, K107, K108, K109, K110, KC_NO, K112 }, \
+ { K200, KC_NO, K202, K203, K204, K205, K206, K207, K208, K209, K210, K211, K212 }, \
+ { KC_NO, K301, K302, KC_NO, K304, K305, K306, K307, K308, KC_NO, K310, K311, KC_NO }, \
+}