summaryrefslogtreecommitdiff
path: root/keyboards/tokyokeyboard
diff options
context:
space:
mode:
authorJames <13719009+quadcube@users.noreply.github.com>2021-02-22 11:46:08 +0800
committerGitHub <noreply@github.com>2021-02-21 19:46:08 -0800
commit37e14fd02bd71ffd32fe381b10ce72f2b85b4049 (patch)
treee5840a51cefac215297178ad46d632c71bb9da40 /keyboards/tokyokeyboard
parent36999494d6eee6d5f7e6795899131a7aca782c32 (diff)
[Keyboard] Tokyo Keyboard alix40 initial commit (#11918)
Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: QuadCube <quadcube@QuadCube-Mac-mini.local>
Diffstat (limited to 'keyboards/tokyokeyboard')
-rw-r--r--keyboards/tokyokeyboard/alix40/alix40.c15
-rw-r--r--keyboards/tokyokeyboard/alix40/alix40.h29
-rw-r--r--keyboards/tokyokeyboard/alix40/config.h71
-rw-r--r--keyboards/tokyokeyboard/alix40/info.json242
-rw-r--r--keyboards/tokyokeyboard/alix40/keymaps/default/keymap.c73
-rw-r--r--keyboards/tokyokeyboard/alix40/keymaps/via/keymap.c47
-rw-r--r--keyboards/tokyokeyboard/alix40/keymaps/via/rules.mk2
-rw-r--r--keyboards/tokyokeyboard/alix40/readme.md22
-rw-r--r--keyboards/tokyokeyboard/alix40/rules.mk26
9 files changed, 527 insertions, 0 deletions
diff --git a/keyboards/tokyokeyboard/alix40/alix40.c b/keyboards/tokyokeyboard/alix40/alix40.c
new file mode 100644
index 0000000000..af0f361199
--- /dev/null
+++ b/keyboards/tokyokeyboard/alix40/alix40.c
@@ -0,0 +1,15 @@
+/*
+Copyright 2021 quadcube <james@quadcube.xyz>
+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 "alix40.h"
diff --git a/keyboards/tokyokeyboard/alix40/alix40.h b/keyboards/tokyokeyboard/alix40/alix40.h
new file mode 100644
index 0000000000..4a322a10b4
--- /dev/null
+++ b/keyboards/tokyokeyboard/alix40/alix40.h
@@ -0,0 +1,29 @@
+/*
+Copyright 2021 quadcube <james@quadcube.xyz>
+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"
+
+#define LAYOUT_40_alix( \
+ K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, \
+ K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, \
+ K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, \
+ K30, K31, K33, K34, K35, K36, K37, K38, K3A, K3B \
+) { \
+ { K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B }, \
+ { K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B }, \
+ { K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B }, \
+ { K30, K31, KC_NO, K33, K34, K35, K36, K37, K38, KC_NO, K3A, K3B } \
+}
diff --git a/keyboards/tokyokeyboard/alix40/config.h b/keyboards/tokyokeyboard/alix40/config.h
new file mode 100644
index 0000000000..ec6f98d549
--- /dev/null
+++ b/keyboards/tokyokeyboard/alix40/config.h
@@ -0,0 +1,71 @@
+/*
+Copyright 2021 quadcube <james@quadcube.xyz>
+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 0x5143 // QC
+#define PRODUCT_ID 0x4134 // A4
+#define DEVICE_VER 0x0001
+#define MANUFACTURER quadcube
+#define PRODUCT alix40
+
+/* key matrix size */
+#define MATRIX_ROWS 4
+#define MATRIX_COLS 12
+
+/* number of backlight levels */
+#define BACKLIGHT_PIN B7
+#ifdef BACKLIGHT_PIN
+#define BACKLIGHT_LEVELS 31
+#define BACKLIGHT_BREATHING
+#endif
+
+/* COL2ROW or ROW2COL */
+#define DIODE_DIRECTION ROW2COL
+
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
+#define DEBOUNCE 5
+
+/* key matrix pins */
+#define MATRIX_ROW_PINS { D7, C6, C7, B5 }
+#define MATRIX_COL_PINS { F7, F6, F5, F4, F1, F0, D0, D1, D2, D3, D5, D6 }
+#define UNUSED_PINS
+
+/* 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
+
+#define RGB_DI_PIN B0
+#ifdef RGB_DI_PIN
+#define RGBLIGHT_ANIMATIONS
+#define RGBLED_NUM 12
+#define RGBLIGHT_HUE_STEP 10
+#define RGBLIGHT_SAT_STEP 10
+#define RGBLIGHT_VAL_STEP 10
+#endif
+
+/* For Production */
+#define QMK_ESC_OUTPUT F7 // usually COL
+#define QMK_ESC_INPUT D7 // usually ROW
+
+/* Bluetooth */
+#define AdafruitBleResetPin D4
+#define AdafruitBleCSPin B4
+#define AdafruitBleIRQPin E6
+#define BATTERY_LEVEL_PIN B6
diff --git a/keyboards/tokyokeyboard/alix40/info.json b/keyboards/tokyokeyboard/alix40/info.json
new file mode 100644
index 0000000000..dbc0f5cbfd
--- /dev/null
+++ b/keyboards/tokyokeyboard/alix40/info.json
@@ -0,0 +1,242 @@
+{
+ "keyboard_name": "alix40",
+ "url": "https://tokyokeyboard.com/",
+ "maintainer": "qmk",
+ "width": 12,
+ "height": 4,
+ "layouts": {
+ "LAYOUT_40_alix": {
+ "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": 7.5,
+ "y": 0
+ },
+ {
+ "label": "U",
+ "x": 8.5,
+ "y": 0
+ },
+ {
+ "label": "I",
+ "x": 9.5,
+ "y": 0
+ },
+ {
+ "label": "O",
+ "x": 10.5,
+ "y": 0
+ },
+ {
+ "label": "P",
+ "x": 11.5,
+ "y": 0
+ },
+ {
+ "label": "`",
+ "x": 12.5,
+ "y": 0
+ },
+ {
+ "label": "Esc",
+ "x": 0.25,
+ "y": 1
+ },
+ {
+ "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": 7.75,
+ "y": 1
+ },
+ {
+ "label": "J",
+ "x": 8.75,
+ "y": 1
+ },
+ {
+ "label": "K",
+ "x": 9.75,
+ "y": 1
+ },
+ {
+ "label": "L",
+ "x": 10.75,
+ "y": 1
+ },
+ {
+ "label": ";",
+ "x": 11.75,
+ "y": 1
+ },
+ {
+ "label": "'",
+ "x": 12.75,
+ "y": 1
+ },
+ {
+ "label": "Shift",
+ "x": 0.75,
+ "y": 2
+ },
+ {
+ "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": "Enter",
+ "x": 7.25,
+ "y": 2
+ },
+ {
+ "label": "N",
+ "x": 7.25,
+ "y": 2
+ },
+ {
+ "label": "M",
+ "x": 7.25,
+ "y": 2
+ },
+ {
+ "label": ",",
+ "x": 7.25,
+ "y": 2
+ },
+ {
+ "label": ".",
+ "x": 7.25,
+ "y": 2
+ },
+ {
+ "label": "/",
+ "x": 7.25,
+ "y": 2
+ },
+ {
+ "label": "Ctrl",
+ "x": 0.5,
+ "y": 3
+ },
+ {
+ "label": "Alt",
+ "x": 1.5,
+ "y": 3
+ },
+ {
+ "label": "Gui",
+ "x": 3.75,
+ "y": 3
+ },
+ {
+ "label": "NO",
+ "x": 4.75,
+ "y": 3
+ },
+ {
+ "label": "Bksp",
+ "x": 5.75,
+ "y": 3
+ },
+ {
+ "label": "Space",
+ "x": 7.25,
+ "y": 3
+ },
+ {
+ "label": "NO",
+ "x": 8.25,
+ "y": 3
+ },
+ {
+ "label": "Gui",
+ "x": 9.25,
+ "y": 3
+ },
+ {
+ "label": "[",
+ "x": 11.5,
+ "y": 3
+ },
+ {
+ "label": "]",
+ "x": 12.5,
+ "y": 3
+ }
+ ]
+ }
+ }
+}
diff --git a/keyboards/tokyokeyboard/alix40/keymaps/default/keymap.c b/keyboards/tokyokeyboard/alix40/keymaps/default/keymap.c
new file mode 100644
index 0000000000..ae8f1d0ad0
--- /dev/null
+++ b/keyboards/tokyokeyboard/alix40/keymaps/default/keymap.c
@@ -0,0 +1,73 @@
+/*
+Copyright 2021 quadcube <james@quadcube.xyz>
+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
+
+/*
+ * Default Alix Layout
+ */
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+ /* 0: Default layer
+┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐
+│ Tab │ Q │ W │ E │ R │ T │ Y │ U │ I │ O │ P │ ` │
+├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
+│ Esc │ A │ S │ D │ F │ G │ H │ J │ K │ L │ ; │ ' │
+├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
+│Shift│ Z │ X │ C │ V │ B │Enter│ N │ M │ , │ . │ / │
+├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
+│Ctrl │ Alt │ │ Gui │█████│Bksp │Space│█████│ Gui │ │ [ │ ] │
+└─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┘
+ */
+[0] = LAYOUT_40_alix(
+ KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_GRV,
+ KC_ESC, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
+ KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_ENT, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH,
+ KC_LCTL, KC_RALT, KC_LGUI,KC_NO, LT(1, KC_BSPC), LT(2, KC_SPC), KC_NO, KC_RGUI, KC_LBRC, KC_RBRC
+),
+/* 1: Lower Layer
+┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐
+│ ~ │ ! │ @ │ # │ $ │ % │ ^ │ & │ * │ ( │ ) │ | │
+├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
+│ DEL | F1 | F2 | F3 | F4 | F5 │Left │Down │ Up │Right│ ; │ ' │
+├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
+│Shift│ F6 │ F7 │ F8 │ F9 │ F10 │Enter|Next |Vol- |Vol+ | Play│ / │
+├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
+│Ctrl │ Alt │ │ Gui │█████│Bksp │Space│█████│ Gui │ │ _ │ + │
+└─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┘
+ */
+[1]= LAYOUT_40_alix(
+ KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_PIPE,
+ KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT, KC_SCLN, KC_QUOT,
+ KC_LSFT, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_ENT, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY, KC_SLSH,
+ KC_LCTL, KC_RALT, KC_LGUI, KC_NO, LT(1, KC_BSPC), LT(2, KC_SPC), KC_NO, KC_RGUI, KC_UNDS, KC_PLUS
+),
+
+/* 2: Raise Layer
+┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐
+│ ~ │ 1 │ 2 │ 3 │ 4 │ 5 │ 6 │ 7 │ 8 │ 9 │ 0 │ \ │
+├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
+│ DEL │ F1 │ F2 │ F3 │ F4 │ F5 │Left │Down │ Up │Right│ ; │ ' │
+├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
+│Shift│ F6 │ F7 │ F8 │ F9 │ F10 │Enter│Next │PgDn │PgUp │Home │ End │
+├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
+│Ctrl │ Alt │ │ Gui │█████│Bksp │Space│█████│ Gui │ │ - │ = │
+└─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┘
+ */
+[2]= LAYOUT_40_alix(
+ KC_TILD, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSLS,
+ KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT, KC_SCLN, KC_QUOT,
+ KC_LSFT, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_ENT, KC_MNXT, KC_PGDN, KC_PGUP, KC_HOME, KC_END,
+ KC_LCTL, KC_RALT, KC_LGUI, KC_NO, LT(1, KC_BSPC), LT(2, KC_SPC), KC_NO, KC_RGUI, KC_MINS, KC_EQL
+),
+};
diff --git a/keyboards/tokyokeyboard/alix40/keymaps/via/keymap.c b/keyboards/tokyokeyboard/alix40/keymaps/via/keymap.c
new file mode 100644
index 0000000000..7bd0915913
--- /dev/null
+++ b/keyboards/tokyokeyboard/alix40/keymaps/via/keymap.c
@@ -0,0 +1,47 @@
+/*
+Copyright 2021 quadcube <james@quadcube.xyz>
+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 BL 0
+#define FN 1
+/*
+ * Default alix40 Layout
+ */
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+[BL] = LAYOUT_40_alix(
+ KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_GRV,
+ KC_ESC, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
+ KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_ENT, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH,
+ KC_LCTL, KC_RALT, KC_LGUI,KC_NO, LT(1, KC_BSPC), LT(2, KC_SPC), KC_NO, KC_RGUI, KC_LBRC, KC_RBRC),
+
+[FN]= LAYOUT_40_alix(
+ KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_PIPE,
+ KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT, KC_SCLN, KC_QUOT,
+ KC_LSFT, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_ENT, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY, KC_SLSH,
+ KC_LCTL, KC_RALT, KC_LGUI, KC_NO, LT(1, KC_BSPC), LT(2, KC_SPC), KC_NO, KC_RGUI, KC_UNDS, KC_PLUS),
+
+[2]= LAYOUT_40_alix(
+ KC_TILD, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSLS,
+ KC_DEL, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT, KC_SCLN, KC_QUOT,
+ KC_LSFT, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_ENT, KC_MNXT, KC_PGDN, KC_PGUP, KC_HOME, KC_END,
+ KC_LCTL, KC_RALT, KC_LGUI, KC_NO, LT(1, KC_BSPC), LT(2, KC_SPC), KC_NO, KC_RGUI, KC_MINS, KC_EQL),
+
+[3]= LAYOUT_40_alix(
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______),
+};
diff --git a/keyboards/tokyokeyboard/alix40/keymaps/via/rules.mk b/keyboards/tokyokeyboard/alix40/keymaps/via/rules.mk
new file mode 100644
index 0000000000..36b7ba9cbc
--- /dev/null
+++ b/keyboards/tokyokeyboard/alix40/keymaps/via/rules.mk
@@ -0,0 +1,2 @@
+VIA_ENABLE = yes
+LTO_ENABLE = yes
diff --git a/keyboards/tokyokeyboard/alix40/readme.md b/keyboards/tokyokeyboard/alix40/readme.md
new file mode 100644
index 0000000000..b3db0c2107
--- /dev/null
+++ b/keyboards/tokyokeyboard/alix40/readme.md
@@ -0,0 +1,22 @@
+# alix40
+​
+![alix40](https://i2.wp.com/tokyokeyboard.com/wp-content/uploads/2020/08/hello-alix.png)
+​
+Minimal hacker style mechanical keyboard designed in Tokyo. Cherry MX compatible. More Info at [Tokyo Keyboard](http://tokyokeyboard.com).
+​
+* Keyboard Maintainer: [quadcube](https://github.com/quadcube)
+* Hardware Supported: alix40 rev1
+* Hardware Availability: [Tokyo Keyboard](http://tokyokeyboard.com)
+​
+Make example for this keyboard (after setting up your build environment):
+​
+ make tokyokeyboard/alix40:default
+​
+See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.
+
+Note:
+1. Be very careful and gentle when disassembling the PCB from the bottom case
+2. alix40 battery power switch (shown in the image below) is used to toggle battery usage (on: battery will be charged when USB is connected, keyboard will be on when USB is disconnected/off:battery will not be charged when USB is connected, keyboard will be off when USB is disconnected)
+![alix40pwrtoggle](https://i.imgur.com/zr0DODl.jpg)
+3. Install the slider on the battery power switch (bundled together with the 3M feets)
+4. Underglow RGBs are switched off when alix40 is running on battery power (hardware feature to extend battery usage time)
diff --git a/keyboards/tokyokeyboard/alix40/rules.mk b/keyboards/tokyokeyboard/alix40/rules.mk
new file mode 100644
index 0000000000..66097b63e7
--- /dev/null
+++ b/keyboards/tokyokeyboard/alix40/rules.mk
@@ -0,0 +1,26 @@
+# MCU name
+MCU = atmega32u4
+
+# Processor frequency
+F_CPU = 8000000
+
+# Bootloader selection
+BOOTLOADER = atmel-dfu
+
+# Build Options
+# change yes to no to disable
+#
+BOOTMAGIC_ENABLE = lite # Virtual DIP switch configuration
+MOUSEKEY_ENABLE = no # Mouse keys
+EXTRAKEY_ENABLE = yes # Audio control and System control
+CONSOLE_ENABLE = no # Console for debug
+COMMAND_ENABLE = yes # 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
+BLUETOOTH = AdafruitBLE