add `scotto` community layouts and userspace (#21097)

Co-authored-by: Joe Scotto <me@joescotto.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Joe Scotto <contact@joescotto.com>

7 files changed, 330 insertions, 0 deletions

diff --git a/users/scotto/config.h b/users/scotto/config.h
new file mode 100644
index 0000000000..34fe069d6e
--- /dev/null
+++ b/users/scotto/config.h
@@ -0,0 +1,25 @@
+/*
+Copyright 2023 Joe Scotto
+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
+
+// config added when Tap Dance is enabled
+#ifdef TAP_DANCE_ENABLE
+#    ifdef TAPPING_TERM
+#        undef TAPPING_TERM
+#        define TAPPING_TERM 135
+#    endif
+#    define TAPPING_TERM_PER_KEY
+#    define PERMISSIVE_HOLD
+#endif
diff --git a/users/scotto/readme.md b/users/scotto/readme.md
new file mode 100644
index 0000000000..f7fdeb24c4
--- /dev/null
+++ b/users/scotto/readme.md
@@ -0,0 +1,17 @@
+# Scotto
+
+Applies to layouts:
+- LAYOUT_ortho_4x10
+- LAYOUT_split_3x5_2
+- LAYOUT_split_3x5_3
+
+### QWERTY
+
+Scotto's default functional layout is Colemak. To compile this layout in QWERTY (US English), append compile command with `KEYMAP=QWERTY` environment variable.
+```
+qmk compile -kb <keyboardName> -km scotto -e KEYMAP=QWERTY
+```
+Example for [Scotto34](/keyboards/scottokeebs/scotto34):
+```
+qmk compile -kb scottokeebs/scotto34 -km scotto -e KEYMAP=QWERTY
+```
diff --git a/users/scotto/rules.mk b/users/scotto/rules.mk
new file mode 100644
index 0000000000..50a0196675
--- /dev/null
+++ b/users/scotto/rules.mk
@@ -0,0 +1,11 @@
+SRC += scotto.c
+
+TAP_DANCE_ENABLE = yes
+
+ifeq ($(strip $(TAP_DANCE_ENABLE)), yes)
+    SRC += tap_dance.c
+endif
+
+ifneq ($(strip $(KEYMAP)),)
+    OPT_DEFS += -DKEYMAP_$(KEYMAP)
+endif
diff --git a/users/scotto/scotto.c b/users/scotto/scotto.c
new file mode 100644
index 0000000000..41520973c6
--- /dev/null
+++ b/users/scotto/scotto.c
@@ -0,0 +1,15 @@
+/*
+Copyright 2023 Joe Scotto
+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 "scotto.h"
diff --git a/users/scotto/scotto.h b/users/scotto/scotto.h
new file mode 100644
index 0000000000..023906852e
--- /dev/null
+++ b/users/scotto/scotto.h
@@ -0,0 +1,69 @@
+/*
+Copyright 2023 Joe Scotto
+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 QMK_KEYBOARD_H
+
+#ifdef TAP_DANCE_ENABLE
+    #include "tap_dance.h"
+#endif
+
+// Assign rows of keycodes to a single def each 
+#define __QWERTY1__       KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P
+#define __QWERTY2__       KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_BSPC
+#define __QWERTY3a_       LSFT_T(KC_Z), KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, RSFT_T(KC_SLSH)
+#define __QWERTY3b_       KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH
+
+#define __COLEMAK1__      KC_Q, KC_W, KC_F, KC_P, KC_G, KC_J, KC_L, KC_U, KC_Y, KC_BSPC
+#define __COLEMAK2__      KC_A, KC_R, KC_S, KC_T, KC_D, KC_H, KC_N, KC_E, KC_I, KC_O
+#define __COLEMAK3a_      LSFT_T(KC_Z), KC_X, KC_C, KC_V, KC_B, KC_K, KC_M, KC_COMM, KC_DOT, RSFT_T(KC_SLSH)
+#define __COLEMAK3b_      KC_Z, KC_X, KC_C, KC_V, KC_B, KC_K, KC_M, KC_COMM, KC_DOT, KC_SLSH
+
+#define ______________SYM_MEDIA_NAV1______________      KC_UNDS, KC_MINS, KC_PLUS, KC_EQL,  KC_COLN, KC_GRV, KC_MRWD, KC_MPLY, KC_MFFD, KC_DEL
+#define ______________SYM_MEDIA_NAV2______________      KC_LCBR, KC_LPRN, KC_RPRN, KC_RCBR, KC_PIPE, KC_ESC, KC_LEFT, KC_UP, KC_DOWN, KC_RGHT
+#define ______________SYM_MEDIA_NAV3______________      LSFT_T(KC_LBRC), KC_QUOT, KC_DQUO, KC_RBRC, KC_SCLN, KC_TILD, KC_VOLD, KC_MUTE, KC_VOLU, RSFT_T(KC_BSLS)
+
+#define _________________NUM_SYM1_________________      KC_EXLM, KC_AT, KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_CAPS, KC_BSPC
+#define _________________NUM_SYM2_________________      KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0
+#define _________________NUM_SYM3a________________      KC_LSFT, KC_NO, KC_NO, KC_NO, MO(3), KC_NO, KC_NO, KC_COMM, KC_DOT, RSFT_T(KC_SLSH)
+#define _________________NUM_SYM3b________________      KC_LSFT, KC_NO, KC_NO, KC_NO, MO(8), KC_NO, KC_NO, KC_COMM, KC_DOT, RSFT_T(KC_SLSH)
+
+#define ________________FUNC_SYS1a________________      KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, TO(5), TO(4)
+#define ________________FUNC_SYS1b________________      KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, TO(4), TO(5), TO(0)
+#define ________________FUNC_SYS2_________________      KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10
+#define ________________FUNC_SYS3_________________      KC_F11, KC_NO, KC_NO, QK_BOOT, KC_TRNS, KC_NO, KC_NO, KC_NO, KC_NO, KC_F12
+
+#define _______THUMB6_1_______      TD(TD_LCTL_ESC_SPOTLIGHT_EMOJI), KC_LALT, LGUI_T(KC_SPC), LT(1, KC_TAB), LT(2, KC_ENT), TD(TD_LCTL_ESC_SPOTLIGHT_EMOJI)
+#define _______THUMB6_4_______      TD(TD_LALT_ESC_WINDOWS_EMOJI), KC_LALT, LCTL_T(KC_SPC), LT(6, KC_TAB), LT(7, KC_ENT), TD(TD_LALT_ESC_WINDOWS_EMOJI)
+#define _______THUMB6_5_______      TD(TD_LALT_ESC_WINDOWS_EMOJI), KC_LCTL, KC_SPC, LT(6, KC_TAB), LT(7, KC_ENT), TD(TD_LALT_ESC_WINDOWS_EMOJI)
+#define _____THUMB6_TRNS______      KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS
+
+#define _______THUMB4_1_______      TD(TD_ESC_LALT_LCTL_SPOTLIGHT_EMOJI), LGUI_T(KC_SPC), LT(1, KC_TAB), LT(2, KC_ENT)
+#define _______THUMB4_4_______      TD(TD_ESC_LCTL_LALT_WINDOWS_EMOJI), LCTL_T(KC_SPC), LT(6, KC_TAB), LT(7, KC_ENT)
+#define _______THUMB4_5_______      KC_LCTL, KC_SPC, LT(6, KC_TAB), LT(7, KC_ENT)
+#define _____THUMB4_TRNS______      KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS
+
+// set functional layout
+#if defined (KEYMAP_QWERTY)
+    #define _________________KEYMAP1__________________ __QWERTY1__
+    #define _________________KEYMAP2__________________ __QWERTY2__
+    #define _________________KEYMAP3a_________________ __QWERTY3a_
+    #define _________________KEYMAP3b_________________ __QWERTY3b_
+#else
+    #define _________________KEYMAP1__________________ __COLEMAK1__
+    #define _________________KEYMAP2__________________ __COLEMAK2__
+    #define _________________KEYMAP3a_________________ __COLEMAK3a_
+    #define _________________KEYMAP3b_________________ __COLEMAK3b_
+#endif
diff --git a/users/scotto/tap_dance.c b/users/scotto/tap_dance.c
new file mode 100644
index 0000000000..e618384334
--- /dev/null
+++ b/users/scotto/tap_dance.c
@@ -0,0 +1,154 @@
+/*
+Copyright 2023 Joe Scotto
+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 "tap_dance.h"
+#include "scotto.h"
+
+// Create an instance of 'td_tap_t' for the 'x' tap dance.
+static td_tap_t xtap_state = {
+    .is_press_action = true,
+    .state = TD_NONE
+};
+
+td_state_t cur_dance(tap_dance_state_t *state) {
+    if (state->count == 1) {
+        if (state->interrupted || !state->pressed) {
+            return TD_SINGLE_TAP;
+        } else {
+            return TD_SINGLE_HOLD;
+        }
+    } else if (state->count == 2) {
+        if (state->interrupted || !state->pressed) {
+            return TD_DOUBLE_TAP;
+        } else {
+            return TD_DOUBLE_HOLD;
+        }
+    } else if (state->count == 3) {
+        if (state->interrupted || !state->pressed) {
+        return TD_TRIPLE_TAP;
+        } else {
+            return TD_TRIPLE_HOLD;
+        }
+    }   
+
+    return TD_UNKNOWN;
+}
+
+void td_esc_lalt_lctl_spotlight_emoji_finished(tap_dance_state_t *state, void *user_data) {
+    xtap_state.state = cur_dance(state);
+    switch (xtap_state.state) {
+        case TD_SINGLE_TAP: tap_code(KC_ESC); break;
+        case TD_SINGLE_HOLD: register_code(KC_LALT); break;
+        case TD_DOUBLE_HOLD: register_code(KC_LCTL); break;
+        case TD_DOUBLE_TAP: tap_code16(G(KC_SPC)); break;
+        case TD_TRIPLE_TAP: tap_code16(C(G(KC_SPC))); break;
+        default: break;
+    }
+}
+
+void td_esc_lalt_lctl_spotlight_emoji_reset(tap_dance_state_t *state, void *user_data) {
+    switch (xtap_state.state) {
+        case TD_SINGLE_TAP: unregister_code(KC_ESC); break;
+        case TD_SINGLE_HOLD: unregister_code(KC_LALT); break;
+        case TD_DOUBLE_HOLD: unregister_code(KC_LCTL); break;
+        default: break;
+    }
+    xtap_state.state = TD_NONE;
+}
+
+void td_esc_lctl_lalt_windows_emoji_finished(tap_dance_state_t *state, void *user_data) {
+    xtap_state.state = cur_dance(state);
+    switch (xtap_state.state) {
+        case TD_SINGLE_TAP: tap_code16(KC_ESC); break;
+        case TD_SINGLE_HOLD: register_code(KC_LCTL); break;
+        case TD_DOUBLE_HOLD: register_code(KC_LALT); break;
+        case TD_DOUBLE_TAP: tap_code(KC_LGUI); break;
+        case TD_TRIPLE_TAP: tap_code16(G(KC_DOT)); break;
+        default: break;
+    }
+}
+
+void td_esc_lctl_lalt_windows_emoji_reset(tap_dance_state_t *state, void *user_data) {
+    switch (xtap_state.state) {
+        case TD_SINGLE_TAP: unregister_code(KC_ESC); break;
+        case TD_SINGLE_HOLD: unregister_code(KC_LCTL); break;
+        case TD_DOUBLE_HOLD: unregister_code(KC_LALT); break;
+        default: break;
+    }
+    xtap_state.state = TD_NONE;
+}
+
+void td_lalt_esc_windowr_emoji_finished(tap_dance_state_t *state, void *user_data) {
+    xtap_state.state = cur_dance(state);
+    switch (xtap_state.state) {
+        case TD_SINGLE_TAP: register_code(KC_ESC); break;
+        case TD_SINGLE_HOLD: register_code(KC_LALT); break;
+        case TD_DOUBLE_TAP: tap_code(KC_LGUI); break;
+        case TD_TRIPLE_TAP: tap_code16(G(KC_DOT)); break;
+        default: break;
+    }
+}
+
+void td_lalt_esc_windowr_emoji_reset(tap_dance_state_t *state, void *user_data) {
+    switch (xtap_state.state) {
+        case TD_SINGLE_TAP: unregister_code(KC_ESC); break;
+        case TD_SINGLE_HOLD: unregister_code(KC_LALT); break;
+        default: break;
+    }
+    xtap_state.state = TD_NONE;
+}
+
+void td_lctl_esc_spotlight_emoji_finished(tap_dance_state_t *state, void *user_data) {
+    xtap_state.state = cur_dance(state);
+    switch (xtap_state.state) {
+        case TD_SINGLE_TAP: register_code(KC_ESC); break;
+        case TD_SINGLE_HOLD: register_code(KC_LCTL); break;
+        case TD_DOUBLE_TAP: tap_code16(G(KC_SPC)); break;
+        case TD_TRIPLE_TAP: tap_code16(C(G(KC_SPC))); break;
+        default: break;
+    }
+}
+
+void td_lctl_esc_spotlight_emoji_reset(tap_dance_state_t *state, void *user_data) {
+    switch (xtap_state.state) {
+        case TD_SINGLE_TAP: unregister_code(KC_ESC); break;
+        case TD_SINGLE_HOLD: unregister_code(KC_LCTL); break;
+        default: break;
+    }
+    xtap_state.state = TD_NONE;
+}
+
+ // Tap Dance definitions
+tap_dance_action_t tap_dance_actions[] = {
+    [TD_LCTL_ESC_SPOTLIGHT_EMOJI] = ACTION_TAP_DANCE_FN_ADVANCED(NULL, td_lctl_esc_spotlight_emoji_finished, td_lctl_esc_spotlight_emoji_reset),
+    [TD_LALT_ESC_WINDOWS_EMOJI] = ACTION_TAP_DANCE_FN_ADVANCED(NULL, td_lalt_esc_windowr_emoji_finished, td_lalt_esc_windowr_emoji_reset),
+    [TD_ESC_LALT_LCTL_SPOTLIGHT_EMOJI] = ACTION_TAP_DANCE_FN_ADVANCED(NULL, td_esc_lalt_lctl_spotlight_emoji_finished, td_esc_lalt_lctl_spotlight_emoji_reset),
+    [TD_ESC_LCTL_LALT_WINDOWS_EMOJI] = ACTION_TAP_DANCE_FN_ADVANCED(NULL, td_esc_lctl_lalt_windows_emoji_finished, td_esc_lctl_lalt_windows_emoji_reset),
+};
+
+uint16_t get_tapping_term(uint16_t keycode, keyrecord_t *record) {
+    switch (keycode) {
+        case TD(TD_LCTL_ESC_SPOTLIGHT_EMOJI) :
+        case TD(TD_LALT_ESC_WINDOWS_EMOJI) :
+        case TD(TD_ESC_LALT_LCTL_SPOTLIGHT_EMOJI) :
+        case TD(TD_ESC_LCTL_LALT_WINDOWS_EMOJI) :
+        case LGUI_T(KC_SPC) :
+        case LT(1, KC_SPC) :
+        case LT(1, KC_TAB) :
+        case LT(2, KC_ENT) :
+            return 200;
+        default:
+            return TAPPING_TERM;
+    }
+};
diff --git a/users/scotto/tap_dance.h b/users/scotto/tap_dance.h
new file mode 100644
index 0000000000..4082d2b9fb
--- /dev/null
+++ b/users/scotto/tap_dance.h
@@ -0,0 +1,39 @@
+/*
+Copyright 2023 Joe Scotto
+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 "scotto.h"
+
+typedef enum {
+    TD_NONE = 0,
+    TD_UNKNOWN,
+    TD_SINGLE_HOLD,
+    TD_DOUBLE_HOLD,
+    TD_TRIPLE_HOLD,
+    TD_SINGLE_TAP,
+    TD_DOUBLE_TAP,
+    TD_TRIPLE_TAP
+} td_state_t;
+
+typedef struct {
+    bool is_press_action;
+    td_state_t state;
+} td_tap_t;
+
+enum {
+    TD_LCTL_ESC_SPOTLIGHT_EMOJI = 0,
+    TD_LALT_ESC_WINDOWS_EMOJI,
+    TD_ESC_LALT_LCTL_SPOTLIGHT_EMOJI,
+    TD_ESC_LCTL_LALT_WINDOWS_EMOJI
+};