summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJ.Flanagan <jrfhoutx@comcast.net>2021-08-29 14:18:56 -0500
committerGitHub <noreply@github.com>2021-08-29 12:18:56 -0700
commitef7fdee6c803bf92bd6d892326c05ee1f473ad07 (patch)
tree15120e33a3c26b5cf4aa49fe8d019a1dac989d68
parentf87cd8e8a02bf89d05737a19fd54e8ec6f63f90f (diff)
downloadqmk_firmware-ef7fdee6c803bf92bd6d892326c05ee1f473ad07.tar.gz
qmk_firmware-ef7fdee6c803bf92bd6d892326c05ee1f473ad07.zip
[Keyboard] Add Viktus SP Mini (#14069)
Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Drashna Jaelre <drashna@live.com>
-rw-r--r--keyboards/viktus/sp_mini/config.h99
-rw-r--r--keyboards/viktus/sp_mini/info.json85
-rw-r--r--keyboards/viktus/sp_mini/keymaps/default/keymap.c128
-rw-r--r--keyboards/viktus/sp_mini/keymaps/via/keymap.c136
-rw-r--r--keyboards/viktus/sp_mini/keymaps/via/rules.mk2
-rw-r--r--keyboards/viktus/sp_mini/readme.md21
-rw-r--r--keyboards/viktus/sp_mini/rules.mk24
-rw-r--r--keyboards/viktus/sp_mini/sp_mini.c45
-rw-r--r--keyboards/viktus/sp_mini/sp_mini.h41
9 files changed, 581 insertions, 0 deletions
diff --git a/keyboards/viktus/sp_mini/config.h b/keyboards/viktus/sp_mini/config.h
new file mode 100644
index 0000000000..06b8c2f51a
--- /dev/null
+++ b/keyboards/viktus/sp_mini/config.h
@@ -0,0 +1,99 @@
+/*
+Copyright 2012 Jun Wako <wakojun@gmail.com>
+Copyright 2015 Jack Humbert
+
+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 0x5644
+#define PRODUCT_ID 0x534D
+#define DEVICE_VER 0x0001
+#define MANUFACTURER Viktus_Design
+#define PRODUCT SP_Mini
+
+/* key matrix size */
+// Rows are doubled-up
+#define MATRIX_ROWS 10
+#define MATRIX_COLS 8
+
+
+// wiring of each half
+#define MATRIX_ROW_PINS { F0, B5, B4, D7, D6 }
+#define MATRIX_COL_PINS { B6, C6, C7, D4, D2, D3, D5 } // no B7 on left hand
+#define MATRIX_ROW_PINS_RIGHT { F0, B5, B4, D7, D6 }
+#define MATRIX_COL_PINS_RIGHT { B6, C6, C7, D4, D2, D3, D5, B7 }
+
+
+#define DIODE_DIRECTION COL2ROW
+
+/* Split Defines */
+#define SPLIT_USB_DETECT
+#define MASTER_LEFT
+#define USE_I2C
+
+/* define if matrix has ghost */
+//#define MATRIX_HAS_GHOST
+
+/* Set 0 if debouncing isn't needed */
+#define DEBOUNCE 5
+
+
+/* ws2812 RGB LED */
+#define RGB_DI_PIN E6
+#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
+#define RGBLIGHT_EFFECT_TWINKLE
+
+//#define RGBLIGHT_SPLIT
+#define RGBLED_NUM 24 // Number of LEDs
+#define RGBLED_SPLIT { 12, 12 }
+
+
+
+#define ENCODERS_PAD_A {F4}
+#define ENCODERS_PAD_B {F1}
+//#define ENCODERS_PAD_A_RIGHT {F4}
+//#define ENCODERS_PAD_B_RIGHT {F1}
+
+#define ENCODER_RESOLUTIONS { 8, 8 }
+
+/*
+ * 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
+//#define NO_ACTION_MACRO
+//#define NO_ACTION_FUNCTION
diff --git a/keyboards/viktus/sp_mini/info.json b/keyboards/viktus/sp_mini/info.json
new file mode 100644
index 0000000000..5b207ce817
--- /dev/null
+++ b/keyboards/viktus/sp_mini/info.json
@@ -0,0 +1,85 @@
+{
+ "keyboard_name": "sp_mini",
+ "url": "",
+ "maintainer": "jrfhoutx",
+ "width": 16,
+ "height": 5.5,
+ "layouts": {
+ "LAYOUT_all": {
+ "layout": [
+ {"x":0, "y":0},
+ {"x":1.25, "y":0},
+ {"x":2.25, "y":0},
+ {"x":3.25, "y":0},
+ {"x":4.25, "y":0},
+ {"x":5.25, "y":0},
+ {"x":6.25, "y":0},
+ {"x":7.75, "y":0},
+ {"x":8.75, "y":0},
+ {"x":9.75, "y":0},
+ {"x":10.75, "y":0},
+ {"x":11.75, "y":0},
+ {"x":12.75, "y":0},
+ {"x":13.75, "y":0},
+ {"x":15, "y":0},
+
+ {"x":0, "y":1.25},
+ {"label":"Esc", "x":1.25, "y":1.25},
+ {"label":"Q", "x":2.25, "y":1.25},
+ {"label":"W", "x":3.25, "y":1.25},
+ {"label":"E", "x":4.25, "y":1.25},
+ {"label":"R", "x":5.25, "y":1.25},
+ {"label":"T", "x":6.25, "y":1.25},
+ {"label":"Y", "x":7.75, "y":1.25},
+ {"label":"U", "x":8.75, "y":1.25},
+ {"label":"I", "x":9.75, "y":1.25},
+ {"label":"O", "x":10.75, "y":1.25},
+ {"label":"P", "x":11.75, "y":1.25},
+ {"label":"Delete", "x":12.75, "y":1.25},
+ {"label":"Back", "x":13.75, "y":1.25},
+ {"x":15, "y":1.25},
+
+ {"x":0, "y":2.25},
+ {"label":"Tab", "x":1.25, "y":2.25, "w":1.25},
+ {"label":"A", "x":2.5, "y":2.25},
+ {"label":"S", "x":3.5, "y":2.25},
+ {"label":"D", "x":4.5, "y":2.25},
+ {"label":"F", "x":5.5, "y":2.25},
+ {"label":"G", "x":6.5, "y":2.25},
+ {"label":"H", "x":8, "y":2.25},
+ {"label":"J", "x":9, "y":2.25},
+ {"label":"K", "x":10, "y":2.25},
+ {"label":"L", "x":11, "y":2.25},
+ {"label":"\"", "x":12, "y":2.25},
+ {"label":"Enter", "x":13, "y":2.25, "w":1.75},
+ {"x":15, "y":2.25},
+
+ {"x":0, "y":3.25},
+ {"label":"Shift", "x":1.25, "y":3.25, "w":1.75},
+ {"label":"Z", "x":3, "y":3.25},
+ {"label":"X", "x":4, "y":3.25},
+ {"label":"C", "x":5, "y":3.25},
+ {"label":"V", "x":6, "y":3.25},
+ {"label":"B", "x":7, "y":3.25},
+ {"label":"N", "x":8.5, "y":3.25},
+ {"label":"M", "x":9.5, "y":3.25},
+ {"label":"<", "x":10.5, "y":3.25},
+ {"label":">", "x":11.5, "y":3.25},
+ {"label":"Shift", "x":12.5, "y":3.25, "w":1.25},
+ {"label":"\u2191", "x":14, "y":3.5},
+
+ {"x":0, "y":4.25},
+ {"label":"Ctrl", "x":1.25, "y":4.25, "w":1.25},
+ {"label":"LAlt", "x":2.5, "y":4.25},
+ {"label":"LGUI", "x":3.5, "y":4.25},
+ {"label":"Fn1", "x":4.5, "y":4.25, "w":1.25},
+ {"label":"SPFn1", "x":5.75, "y":4.25, "w":2},
+ {"label":"BSFn2", "x":8.25, "y":4.25, "w":2.25},
+ {"label":"Alt", "x":10.5, "y":4.25, "w":1.25},
+ {"label":"Fn2", "x":11.75, "y":4.25},
+ {"label":"\u2190", "x":13, "y":4.5},
+ {"label":"\u2193", "x":14, "y":4.5},
+ {"label":"\u2192", "x":15, "y":4.5}]
+ }
+ }
+}
diff --git a/keyboards/viktus/sp_mini/keymaps/default/keymap.c b/keyboards/viktus/sp_mini/keymaps/default/keymap.c
new file mode 100644
index 0000000000..e01b6083d7
--- /dev/null
+++ b/keyboards/viktus/sp_mini/keymaps/default/keymap.c
@@ -0,0 +1,128 @@
+ /* Copyright 2021 jrfhoutx
+ *
+ * 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
+
+// Each layer gets a name for readability, which is then used in the keymap matrix below.
+// The underscores don't mean anything - you can have a layer called STUFF or any other name.
+// Layer names don't all need to be of the same length, obviously, and you can also skip them
+// entirely and just use numbers.
+
+
+enum custom_layers {
+ _BASE,
+ _FN1,
+ _FN2,
+ _FN3,
+};
+
+enum custom_keycodes {
+ QWERTY = SAFE_RANGE,
+};
+
+#define KC_FN1 MO(_FN1)
+#define KC_FN2 MO(_FN2)
+#define SPFN1 LT(_FN1, KC_SPACE)
+#define BSFN2 LT(_FN2, KC_BSPC)
+
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+ [_BASE] = LAYOUT_all(
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_F24, _______, _______,
+ MO(1), KC_ESC, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_DEL, KC_BSPC, _______,
+ MO(2), KC_TAB, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_QUOT, KC_ENT, _______,
+ _______, KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_RSFT, KC_UP,
+ _______, KC_LCTL, KC_LALT, KC_LGUI, KC_FN1, SPFN1, BSFN2, KC_RALT, KC_FN2, KC_LEFT, KC_DOWN, KC_RGHT
+ ),
+
+ [_FN1] = LAYOUT_all(
+ _______, RESET, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+ _______, 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, _______,
+ _______, RGB_TOG, RGB_HUI, RGB_SAI, RGB_VAI, KC_VOLU, KC_LBRC, KC_RBRC, KC_4, KC_5, KC_6, KC_SCLN, _______, _______,
+ _______, RGB_MOD, RGB_HUD, RGB_SAD, RGB_VAD, KC_VOLD, KC_LCBR, KC_RCBR, KC_1, KC_2, KC_3, _______, KC_UP,
+ _______, _______, _______, _______, _______, _______, KC_DEL, KC_0, _______, KC_LEFT, KC_DOWN, KC_RGHT
+ ),
+
+ [_FN2] = LAYOUT_all(
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+ _______, KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_UNDS, KC_PLUS, _______,
+ _______, _______, _______, _______, KC_INS, KC_PGUP, KC_HOME, _______, _______, _______, _______, KC_COLN, _______, _______,
+ _______, _______, _______, _______, KC_DEL, KC_PGDN, KC_END, _______, _______, _______, _______, _______, KC_UP,
+ _______, _______, _______, _______, _______, KC_DEL, _______, _______, _______, KC_LEFT, KC_DOWN, KC_RGHT
+ ),
+
+ [_FN3] = LAYOUT_all(
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_F24, _______, _______,
+ MO(1), KC_ESC, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_DEL, KC_BSPC, _______,
+ MO(2), KC_TAB, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_QUOT, KC_ENT, _______,
+ _______, KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_RSFT, KC_UP,
+ _______, KC_LCTL, KC_LALT, KC_LGUI, KC_FN1, SPFN1, BSFN2, KC_RALT, KC_FN2, KC_LEFT, KC_DOWN, KC_RGHT
+ )
+
+};
+
+void keyboard_pre_init_user(void) {
+ setPinOutput(F5); // initialize F5 for LED
+ setPinOutput(F6); // initialize F6 for LED
+ setPinOutput(F7); // initialize F7 for LED
+
+}
+
+layer_state_t layer_state_set_user(layer_state_t state) {
+ writePinLow(F5);
+ writePinLow(F6);
+ writePinLow(F7);
+ switch (get_highest_layer(state)) {
+ case _FN1:
+ writePinHigh(F5);
+ break;
+ case _FN2:
+ writePinHigh(F6);
+ break;
+ case _FN3: // replace 'XXXX' with the layer or function name
+ writePinHigh(F7);
+ break;
+ case KC_F24:
+ writePinHigh(F7);
+ writePinHigh(F5);
+ writePinHigh(F6);
+ break;
+ }
+ return state;
+}
+
+
+bool spongebob_mode = false;
+bool spongebob_case = false;
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+ if (spongebob_mode) {
+ switch(keycode) {
+ case KC_A...KC_Z:
+ if (record->event.pressed) {
+ (spongebob_case ^= 1) == 0 ? tap_code16(S(keycode)) : tap_code(keycode);
+ return false; break;
+ }
+ }
+ }
+ switch(keycode) {
+ case KC_F24:
+ if (record->event.pressed) {
+ spongebob_mode ^= 1;
+ }
+ return false; break;
+ }
+ return true;
+}
diff --git a/keyboards/viktus/sp_mini/keymaps/via/keymap.c b/keyboards/viktus/sp_mini/keymaps/via/keymap.c
new file mode 100644
index 0000000000..e1242d5b9c
--- /dev/null
+++ b/keyboards/viktus/sp_mini/keymaps/via/keymap.c
@@ -0,0 +1,136 @@
+ /* Copyright 2021 jrfhoutx
+ *
+ * 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
+
+// Each layer gets a name for readability, which is then used in the keymap matrix below.
+// The underscores don't mean anything - you can have a layer called STUFF or any other name.
+// Layer names don't all need to be of the same length, obviously, and you can also skip them
+// entirely and just use numbers.
+
+
+enum custom_layers {
+ _BASE,
+ _FN1,
+ _FN2,
+ _FN3,
+};
+
+enum custom_keycodes {
+ QWERTY = SAFE_RANGE,
+};
+
+#define KC_FN1 MO(_FN1)
+#define KC_FN2 MO(_FN2)
+#define SPFN1 LT(_FN1, KC_SPACE)
+#define BSFN2 LT(_FN2, KC_BSPC)
+
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+ [_BASE] = LAYOUT_all(
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+ MO(1), KC_ESC, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_DEL, KC_BSPC, _______,
+ MO(2), KC_TAB, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_QUOT, KC_ENT, _______,
+ _______, KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_RSFT, KC_UP,
+ _______, KC_LCTL, KC_LALT, KC_LGUI, KC_FN1, SPFN1, BSFN2, KC_RALT, KC_FN2, KC_LEFT, KC_DOWN, KC_RGHT
+ ),
+
+ [_FN1] = LAYOUT_all(
+ _______, RESET, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+ _______, 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, _______,
+ _______, RGB_TOG, RGB_HUI, RGB_SAI, RGB_VAI, KC_VOLU, KC_LBRC, KC_RBRC, KC_4, KC_5, KC_6, KC_SCLN, _______, _______,
+ _______, RGB_MOD, RGB_HUD, RGB_SAD, RGB_VAD, KC_VOLD, KC_LCBR, KC_RCBR, KC_1, KC_2, KC_3, _______, KC_UP,
+ _______, _______, _______, _______, _______, _______, KC_DEL, KC_0, _______, KC_LEFT, KC_DOWN, KC_RGHT
+ ),
+
+ [_FN2] = LAYOUT_all(
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+ _______, KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_UNDS, KC_PLUS, _______,
+ _______, _______, _______, _______, KC_INS, KC_PGUP, KC_HOME, _______, _______, _______, _______, KC_COLN, _______, _______,
+ _______, _______, _______, _______, KC_DEL, KC_PGDN, KC_END, _______, _______, _______, _______, _______, KC_UP,
+ _______, _______, _______, _______, _______, KC_DEL, _______, _______, _______, KC_LEFT, KC_DOWN, KC_RGHT
+ ),
+
+ [_FN3] = LAYOUT_all(
+ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_F24, _______, _______,
+ MO(1), KC_ESC, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_DEL, KC_BSPC, _______,
+ MO(2), KC_TAB, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_QUOT, KC_ENT, _______,
+ _______, KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_RSFT, KC_UP,
+ _______, KC_LCTL, KC_LALT, KC_LGUI, KC_FN1, SPFN1, BSFN2, KC_RALT, KC_FN2, KC_LEFT, KC_DOWN, KC_RGHT
+ )
+
+};
+
+void keyboard_pre_init_user(void) {
+ setPinOutput(F5); // initialize F5 for LED
+ setPinOutput(F6); // initialize F6 for LED
+ setPinOutput(F7); // initialize F7 for LED
+
+}
+
+layer_state_t layer_state_set_user(layer_state_t state) {
+ switch (get_highest_layer(state)) {
+ case _FN1:
+ writePinHigh(F5);
+ writePinLow(F6);
+ writePinLow(F7);
+ break;
+ case _FN2:
+ writePinHigh(F6);
+ writePinLow(F5);
+ writePinLow(F7);
+ break;
+ case _FN3: // replace 'XXXX' with the layer or function name
+ writePinHigh(F7);
+ writePinLow(F5);
+ writePinLow(F6);
+ break;
+ case KC_F24:
+ writePinHigh(F7);
+ writePinHigh(F5);
+ writePinHigh(F6);
+ break;
+ default:
+ writePinLow(F5);
+ writePinLow(F6);
+ writePinLow(F7);
+ break;
+ }
+ return state;
+}
+
+
+bool spongebob_mode = false;
+bool spongebob_case = false;
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+ if (spongebob_mode) {
+ switch(keycode) {
+ case KC_A...KC_Z:
+ if (record->event.pressed) {
+ (spongebob_case ^= 1) == 0 ? tap_code16(S(keycode)) : tap_code(keycode);
+ return false; break;
+ }
+ }
+ }
+ switch(keycode) {
+ case USER00:
+ if (record->event.pressed) {
+ spongebob_mode ^= 1;
+ }
+ return false; break;
+ }
+ return true;
+}
diff --git a/keyboards/viktus/sp_mini/keymaps/via/rules.mk b/keyboards/viktus/sp_mini/keymaps/via/rules.mk
new file mode 100644
index 0000000000..16d33cd89f
--- /dev/null
+++ b/keyboards/viktus/sp_mini/keymaps/via/rules.mk
@@ -0,0 +1,2 @@
+VIA_ENABLE = yes
+
diff --git a/keyboards/viktus/sp_mini/readme.md b/keyboards/viktus/sp_mini/readme.md
new file mode 100644
index 0000000000..339977be6d
--- /dev/null
+++ b/keyboards/viktus/sp_mini/readme.md
@@ -0,0 +1,21 @@
+# sp_mini
+
+![sp_mini](https://i.imgur.com/ayX0wnXh.jpg)
+
+The SP Mini is a 40% version of the SP-111 created in a collaboration of OneCreativeMind and BlindAssassin111 (Viktus owner). All design done by BlindAssassin111. The layout includes an F Row, left macro column, and arrows. Rotary encoders are supported in the top left and right positions. The board also features three through hole LED indicators and RGB underglow.
+
+The SP Mini has dual ATMEGA32U4 controllers linked with USB Type C. Each PCB half has a single reset button and a standard AVR ISP header.
+
+* Keyboard Maintainer: [jrfhoutx](https://github.com/jrfhoutx)
+* Hardware Supported: SP Mini FE (Founder's Edition), SP Mini LC (Low Cal)
+* Hardware Availability: Viktus Designs, LLC.
+
+Make example for this keyboard (after setting up your build environment):
+
+ make viktus/sp_mini:default
+
+Flashing example for this keyboard:
+
+ make viktus/sp_mini: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/viktus/sp_mini/rules.mk b/keyboards/viktus/sp_mini/rules.mk
new file mode 100644
index 0000000000..43b0ae8e5a
--- /dev/null
+++ b/keyboards/viktus/sp_mini/rules.mk
@@ -0,0 +1,24 @@
+# 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 = no # 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 = yes # USB Nkey Rollover
+BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = yes # Enable keyboard RGB underglow
+BLUETOOTH_ENABLE = no # Enable Bluetooth
+AUDIO_ENABLE = no # Audio output
+SPLIT_KEYBOARD = yes
+ENCODER_ENABLE = yes
diff --git a/keyboards/viktus/sp_mini/sp_mini.c b/keyboards/viktus/sp_mini/sp_mini.c
new file mode 100644
index 0000000000..c2ccc6db2f
--- /dev/null
+++ b/keyboards/viktus/sp_mini/sp_mini.c
@@ -0,0 +1,45 @@
+ /* Copyright 2021 jrfhoutx
+ *
+ * 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 "sp_mini.h"
+
+void keyboard_pre_init_kb(void) {
+ // enable built in pullups to avoid timeouts when right hand not connected
+ setPinInputHigh(D0);
+ setPinInputHigh(D1);
+
+ keyboard_pre_init_user();
+}
+
+#ifdef ENCODER_ENABLE
+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_VOLU);
+ } else {
+ tap_code(KC_VOLD);
+ }
+ }
+ return true;
+}
+#endif
diff --git a/keyboards/viktus/sp_mini/sp_mini.h b/keyboards/viktus/sp_mini/sp_mini.h
new file mode 100644
index 0000000000..6474a4f71e
--- /dev/null
+++ b/keyboards/viktus/sp_mini/sp_mini.h
@@ -0,0 +1,41 @@
+ /* Copyright 2021 jrfhoutx
+ *
+ * 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 ___ KC_NO
+
+#define LAYOUT_all( \
+ L00, L01, L02, L03, L04, L05, L06, R00, R01, R02, R03, R04, R05, R06, R07, \
+ L10, L11, L12, L13, L14, L15, L16, R10, R11, R12, R13, R14, R15, R16, R17, \
+ L20, L21, L22, L23, L24, L25, L26, R20, R21, R22, R23, R24, R26, R27, \
+ L30, L31, L32, L33, L34, L35, L36, R31, R32, R33, R34, R35, R36, \
+ L40, L41, L42, L43, L44, L45, R42, R43, R44, R45, R46, R47 \
+ ) \
+ { \
+ { L00, L01, L02, L03, L04, L05, L06 }, \
+ { L10, L11, L12, L13, L14, L15, L16 }, \
+ { L20, L21, L22, L23, L24, L25, L26 }, \
+ { L30, L31, L32, L33, L34, L35, L36 }, \
+ { L40, L41, L42, L43, L44, L45, ___ }, \
+ { R00, R01, R02, R03, R04, R05, R06, R07}, \
+ { R10, R11, R12, R13, R14, R15, R16, R17}, \
+ { R20, R21, R22, R23, R24, ___, R26, R27}, \
+ { ___, R31, R32, R33, R34, R35, R36, ___}, \
+ { ___, ___, R42, R43, R44, R45, R46, R47} \
+}