Preonic Ergodox-Like Mac keymap: Bucktooth (#2553)

* Preonic Ergodox-Like Mac keymap: Bucktooth

This is a layout unlike most Preonics, it is taken partially from
Ergodox and classic C64 keyboards with a ton of Mac-specific features.

* Fix Mouse Left keycode

4 files changed, 209 insertions, 0 deletions

diff --git a/keyboards/preonic/keymaps/bucktooth/config.h b/keyboards/preonic/keymaps/bucktooth/config.h
new file mode 100644
index 000000000..b98883120
--- /dev/null
+++ b/keyboards/preonic/keymaps/bucktooth/config.h
@@ -0,0 +1,9 @@
+#ifndef CONFIG_USER_H
+#define CONFIG_USER_H
+
+#include "../../config.h"
+
+#define FORCE_NKRO 1
+#define PREVENT_STUCK_MODIFIERS
+
+#endif
diff --git a/keyboards/preonic/keymaps/bucktooth/keymap.c b/keyboards/preonic/keymaps/bucktooth/keymap.c
new file mode 100644
index 000000000..d135db487
--- /dev/null
+++ b/keyboards/preonic/keymaps/bucktooth/keymap.c
@@ -0,0 +1,125 @@
+#include "preonic.h"
+#include "action_layer.h"
+#ifdef AUDIO_ENABLE
+  #include "audio.h"
+#endif
+
+// Each layer gets a name for readability, which is then used in the keymap matrix below.
+#define L_QWERTSPLITLY 0
+#define L_FN 1
+
+// Fillers to make layering more clear
+#define _______ KC_TRNS
+#define XXXXXXX KC_NO
+
+// Defines for Mac specific key accelerators used in map. Some of these are very awkward to type.
+// These are the default bindings for Mac, some of which may be turned off or changed, check your
+// settings in System Preferences
+#define LS_TAB LSFT(KC_TAB) // Shift-TAB
+#define MF_MENU LCTL(KC_F2) // Move focus to menu bar default keybinding in MacOS
+#define MF_DOCK LCTL(KC_F3) // Move focus to dock
+#define MF_TOOL LCTL(KC_F5) // Move focus to window toolbar
+#define MF_STAT LCTL(KC_F8) // Move focus to status bar side of menu bar
+#define MF_DRWR LALT(LGUI(KC_QUOTE)) // Move focus to window drawer
+#define MF_LPAD LALT(LGUI(KC_Q)) // Show Launchpad
+#define MF_NOTI LALT(LGUI(LCTL(KC_B))) // Show Notification Center
+#define MF_DASH LALT(LGUI(LCTL(KC_C))) // Show Dashboard
+#define MF_HELP LSFT(LGUI(KC_SLASH)) // Position in menu Help search box
+
+// Momentary/Tap Combos used by this layout
+#define LT_FNESC LT(L_FN, KC_ESC) // ESC when tapped, Fn layer when held
+#define MT_RGENT MT(MOD_RGUI, KC_ENTER) // Enter when tapped, right GUI when held
+#define LT_FNLFT LT(L_FN, KC_LEFT) // Left when tapped, Fn layer when held
+#define MT_RSDOT MT(MOD_RSFT, KC_DOT) // Dot when tapped, right shift when held
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+/* QwertSplitly
+ * ,-----------------------------------------------------------------------------------.
+ * |   1  |   2  |   3  |   4  |   5  |   -  |   =  |   6  |   7  |   8  |   9  |   0  |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * |   Q  |   W  |   E  |   R  |   T  |   [  |   ]  |   Y  |   U  |   I  |   O  |   P  |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * |   A  |   S  |   D  |   F  |   G  |   `  |   '  |   H  |   J  |   K  |   L  |   ;  |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * |LShift|   Z  |   X  |   C  |   V  |   B  |   \  |   /  |   N  |   M  |   ,  |./RSft|
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * |ESC/fn|LCtrl | LOpt | LCmd |Space | Tab  | BkSp |Space |En/Cmd|<-/fn |CRSR v|CRSR->|
+ * `-----------------------------------------------------------------------------------'
+ */
+[L_QWERTSPLITLY] = {
+  {KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_MINUS,KC_EQL,  KC_6,    KC_7,    KC_8,    KC_9,    KC_0,   },
+  {KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_LBRC, KC_RBRC, KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,   },
+  {KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_GRAVE,KC_QUOTE,KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN },
+  {KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_BSLS, KC_SLASH,KC_N,    KC_M,    KC_COMM, MT_RSDOT},
+  {LT_FNESC,KC_LCTL, KC_LALT, KC_LGUI, KC_SPC,  KC_TAB,  KC_BSPC, KC_SPC,  MT_RGENT,LT_FNLFT,KC_DOWN, KC_RIGHT}
+},
+
+/* Fn
+ * ,-----------------------------------------------------------------------------------.
+ * |  F1  |  F2  |  F3  |  F4  |  F5  | Vol- | Vol+ |  F6  |  F7  |  F8  |  F9  |  F10 |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * |  F11 |  F12 |  F13 |  F14 |  F15 |Track-|Track+|M:WhUp|M:Lclk| M:Up |M:Rclk| PgUp |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * | Caps |^LPad |^DashB|^Help |^Drawr| Mute | |>|| |M:WhDn|M:Left|M:Down|M:Rght| PgDn |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * |RShift|^Menu |^SMenu|^Dock |^Tools|^Notif|  Ins |M:Slow|M:Norm|M:Fast| Home | End  |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * |[ESC] |RCtrl | ROpt | RCmd |Space |Sh-Tab|  Del |Space |PadEnt| [fn] |  Up  | Left |
+ * `-----------------------------------------------------------------------------------'
+ */
+[L_FN] = {
+  {KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_VOLD, KC_VOLU, KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10  },
+  {KC_F11,  KC_F12,  KC_F13,  KC_F14,  KC_F15,  KC_MRWD, KC_MFFD, KC_WH_U, KC_BTN1, KC_MS_U, KC_BTN2, KC_PGUP },
+  {KC_CAPS, MF_LPAD, MF_DASH, MF_HELP, MF_DRWR, KC_MUTE, KC_MPLY, KC_WH_D, KC_MS_L, KC_MS_D, KC_MS_R, KC_PGDN },
+  {KC_RSFT, MF_MENU, MF_STAT, MF_DOCK, MF_TOOL, MF_NOTI, KC_INS,  KC_ACL0, KC_ACL1, KC_ACL2, KC_HOME, KC_END  },
+  {_______, KC_RCTL, KC_RALT, KC_RGUI, _______, LS_TAB,  KC_DEL,  _______, KC_PENT, _______, KC_UP,   KC_LEFT }
+}
+
+};
+
+#ifdef AUDIO_ENABLE
+float tone_startup[][2] = {
+  {NOTE_C5, 8},
+  {NOTE_E6, 4},
+  {NOTE_D6, 16},
+  {NOTE_G6, 8}
+};
+
+float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
+
+float music_scale[][2]     = SONG(MUSIC_SCALE_SOUND);
+#endif
+
+void matrix_init_user(void) {
+    #ifdef AUDIO_ENABLE
+        startup_user();
+    #endif
+}
+
+#ifdef AUDIO_ENABLE
+
+void startup_user()
+{
+    _delay_ms(20); // gets rid of tick
+    PLAY_SONG(tone_startup);
+}
+
+void shutdown_user()
+{
+    PLAY_SONG(tone_goodbye);
+    _delay_ms(150);
+    stop_all_notes();
+}
+
+void music_on_user(void)
+{
+    music_scale_user();
+}
+
+void music_scale_user(void)
+{
+    PLAY_SONG(music_scale);
+}
+
+#endif
diff --git a/keyboards/preonic/keymaps/bucktooth/readme.md b/keyboards/preonic/keymaps/bucktooth/readme.md
new file mode 100644
index 000000000..a1bda9f6a
--- /dev/null
+++ b/keyboards/preonic/keymaps/bucktooth/readme.md
@@ -0,0 +1,55 @@
+# Bucktooth v1.0 (Mac)
+
+Bucktooth is an alternate layout that pushes the letters to the edges and puts most punctuation in the center. It's derived in part from my experience with Ergodox boards. I call the main layer layout QWERTSplitlY, you may notice the right side punctuation moving to the center and the control keys missing from the left.
+
+## Split QWERTY: Unorthodox
+
+     QwertSplitly
+     ,-----------------------------------------------------------------------------------.
+     |   1  |   2  |   3  |   4  |   5  |   -  |   =  |   6  |   7  |   8  |   9  |   0  |
+     |------+------+------+------+------+------+------+------+------+------+------+------|
+     |   Q  |   W  |   E  |   R  |   T  |   [  |   ]  |   Y  |   U  |   I  |   O  |   P  |
+     |------+------+------+------+------+-------------+------+------+------+------+------|
+     |   A  |   S  |   D  |   F  |   G  |   `  |   '  |   H  |   J  |   K  |   L  |   ;  |
+     |------+------+------+------+------+------|------+------+------+------+------+------|
+     |LShift|   Z  |   X  |   C  |   V  |   B  |   \  |   /  |   N  |   M  |   ,  |./RSft|
+     |------+------+------+------+------+------+------+------+------+------+------+------|
+     |ESC/fn|LCtrl | LOpt | LCmd |Space | Tab  | BkSp |Space |En/Cmd|<-/fn |CRSR v|CRSR->|
+     `-----------------------------------------------------------------------------------'
+
+
+It is a bit of a departure from normal Preonic layouts. You will notice that the bottom letter row is shifted right, and this is both an accomodation for the left shift and because I could never get used to C being directly under D and some other similar staggered keyboard tendencies. If you are used to the default ortho layouts you may want to adjust this back; but, you may find that it is slightly easier to move between a typical staggered layout and ortho boards in this layout. Plus, having a dedicated shift is a good thing, even though the dot key does double duty as a right shift.
+
+That left shift is the only control or modifier key on the top four rows. All the modifiers and control keys are in the bottom row. Most Ergodox boards put the braces ({}[]) in the center and keep the hands apart. The hands aren't very far apart in this layout but you can imagine moving between this layout and the Ergodox easily, if you can get used to the lack of the extra 1.5U columns on the left and right!
+
+With all control keys on the bottom row, the ESC key now lives in the bottom left and on my keyboard I actually put a very heavy keyswitch in that space to keep me from hitting it accidentally instead of ctrl. Hold it down and it becomes fn. I usually hit it with my whole hand since it is in the corner, without moving my fingers down to it.
+
+## Function Layer
+
+There are no raise and lower or multiple function pages. The Preonic has enough keys to avoid more than a single function page, and I prefer to have spacebars for both thumbs so the "Bucktooth" name comes from the typical keyset with darker function keys and lighter alphas and space keys giving the keyboard fang-like appearance where the two spaces are.
+
+
+     Fn
+     ,-----------------------------------------------------------------------------------.
+     |  F1  |  F2  |  F3  |  F4  |  F5  | Vol- | Vol+ |  F6  |  F7  |  F8  |  F9  |  F10 |
+     |------+------+------+------+------+------+------+------+------+------+------+------|
+     |  F11 |  F12 |  F13 |  F14 |  F15 |Track-|Track+|M:WhUp|M:Lclk| M:Up |M:Rclk| PgUp |
+     |------+------+------+------+------+-------------+------+------+------+------+------|
+     | Caps |^LPad |^DashB|^Help |^Drawr| Mute | |>|| |M:WhDn|M:Left|M:Down|M:Rght| PgDn |
+     |------+------+------+------+------+------|------+------+------+------+------+------|
+     |RShift|^Menu |^SMenu|^Dock |^Tools|^Notif|  Ins |M:Slow|M:Norm|M:Fast| Home | End  |
+     |------+------+------+------+------+------+------+------+------+------+------+------|
+     |[ESC] |RCtrl | ROpt | RCmd |Space |Sh-Tab|  Del |Space |PadEnt| [fn] |  Up  | Left |
+     `-----------------------------------------------------------------------------------'
+
+### Cursor Keys
+
+The cursor keys are a design I stole from the old Commodore computers which had DOWN and RIGHT keys on the bottom right part of the board. When shifted, they would move the cursor in the opposite direction, and Commodore saved two keys. Since shifted arrows are a common use case in selecting text, emulating this exactly is not desirable so the fn key is placed next to the cursor down and right keys and holding down fn will reverse their meaning. Unlike the Commodore keys they will not invert just by releasing fn but it is close. Because QMK supports it I also allow use the tap mode for fn to move the cursor left, so only going up requires the fn. This is surely the weirdest part of the layout for most people. As someone who learned to type on a Commodore keyboard, it is second nature to me!
+
+### Mac Keyboard navigation Combo Macros
+
+On Fn layer ZXCVB and SDFG keys I have set up the default key bindings for Mac OS Keyboard Focus keys since they are obscure and require FKeys mostly. They are pretty convenient for using the keyboard to search the menus, go to the dock, etc. Some like the one to jump to a window's toolbar and the one to jump to a window's accessory drawer are less commonly used.
+
+___
+
+Contributed to QMK and released with the QMK license by J. Eric Mason, 3/16/2018
diff --git a/keyboards/preonic/keymaps/bucktooth/rules.mk b/keyboards/preonic/keymaps/bucktooth/rules.mk
new file mode 100644
index 000000000..3e87d41d3
--- /dev/null
+++ b/keyboards/preonic/keymaps/bucktooth/rules.mk
@@ -0,0 +1,20 @@
+
+
+BOOTMAGIC_ENABLE = no       # Virtual DIP switch configuration(+1000)
+MOUSEKEY_ENABLE = yes       # Mouse keys(+4700)
+EXTRAKEY_ENABLE = yes       # Audio control and System control(+450)
+CONSOLE_ENABLE = no         # Console for debug(+400)
+COMMAND_ENABLE = yes        # Commands for debug and configuration
+NKRO_ENABLE = yes           # Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
+BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
+MIDI_ENABLE = no            # MIDI controls
+AUDIO_ENABLE = yes          # Audio output on port C6
+UNICODE_ENABLE = no         # Unicode
+BLUETOOTH_ENABLE = no       # Enable Bluetooth with the Adafruit EZ-Key HID
+RGBLIGHT_ENABLE = no        # Enable WS2812 RGB underlight.  Do not enable this with audio at the same time.
+
+SLEEP_LED_ENABLE = no    # Breathing sleep LED during USB suspend
+
+ifndef QUANTUM_DIR
+	include ../../../../Makefile
+endif