[Keymap] Add snowskeleton preonic layout (#19357)

Co-authored-by: Drashna Jaelre <drashna@live.com>

4 files changed, 231 insertions, 0 deletions

diff --git a/keyboards/preonic/keymaps/snowskeleton/config.h b/keyboards/preonic/keymaps/snowskeleton/config.h
new file mode 100644
index 0000000000..7ad61e44c8
--- /dev/null
+++ b/keyboards/preonic/keymaps/snowskeleton/config.h
@@ -0,0 +1,30 @@
+/* Copyright 2015-2021 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
+
+#ifdef AUDIO_ENABLE
+#define STARTUP_SONG SONG(PREONIC_SOUND)
+// #define STARTUP_SONG SONG(NO_SOUND) // uncomment to silence startup sounds
+
+#endif
+#define MUSIC_MASK (keycode != KC_NO)
+#define MIDI_BASIC
+
+
+#define ENCODERS_PAD_A { B12 }
+#define ENCODERS_PAD_B { B13 }
+#define ENCODER_RESOLUTION 4
diff --git a/keyboards/preonic/keymaps/snowskeleton/keymap.c b/keyboards/preonic/keymaps/snowskeleton/keymap.c
new file mode 100644
index 0000000000..030adf8cbb
--- /dev/null
+++ b/keyboards/preonic/keymaps/snowskeleton/keymap.c
@@ -0,0 +1,178 @@
+/* Copyright 2015-2021 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/>.
+ */
+
+#include QMK_KEYBOARD_H
+#include "muse.h"
+
+enum preonic_layers {
+  _QWERTY_MACOS,
+  _LOWER,
+  _RAISE,
+  _ADJUST
+};
+
+enum preonic_keycodes {
+  QWERTY_MACOS = SAFE_RANGE,
+  LOWER,
+  RAISE,
+  BACKLIT
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+/* Qwerty Mac
+ * ┌──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┐
+ * │ Esc  │  F1  │  F2  │  F3  │  F4  │  F5  │  F6  │  F7  │  F8  │  F9  │  F10 │ Bksp │
+ * ├──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┤
+ * │   `  │   Q  │   W  │   E  │   R  │   T  │   Y  │   U  │   I  │   O  │   P  │  \   │
+ * ├──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┤
+ * │ Tab  │   A  │   S  │   D  │   F  │   G  │   H  │   J  │   K  │   L  │   ;  │   '  │
+ * ├──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┤
+ * │ Shft │   Z  │   X  │   C  │   V  │   B  │   N  │   M  │   ,  │   .  │   /  │ Shft │
+ * ├──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┤
+ * │ Play │ Ctrl │ Alt  │ Gui  │Lower │    Space    │Raise │ Left │ Down │  Up  │ Right│
+ * └──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┘
+ */
+[_QWERTY_MACOS] = LAYOUT_preonic_grid(
+  KC_ESC,  KC_F1,   KC_F2,   KC_F3,   KC_F4, KC_F5,  KC_F6,  KC_F7, KC_F8,   KC_F9,   KC_F10,  KC_BSPC,
+  KC_GRV,  KC_Q,    KC_W,    KC_E,    KC_R,  KC_T,   KC_Y,   KC_U,  KC_I,    KC_O,    KC_P,    KC_BSLS,
+  KC_TAB,  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_N,   KC_M,  KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT,
+  KC_MPLY, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT
+),
+
+
+/* RAISE
+ * ┌──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┐
+ * │      │  F11 │  F12 │  F13 │  F14 │  F15 │  F16 │  F17 │  F18 │  F19 │  F20 │      │
+ * ├──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┤
+ * │   `  │   1  │   2  │   3  │   4  │   5  │   6  │   7  │   8  │   9  │   0  │  Del │
+ * ├──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┤
+ * │  Del │      │      │      │      │      │ Left │ Down │  Up  │ Right│      │  \   │
+ * ├──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┤
+ * │ Shft │      │      │      │      │      │      │      │      │      │      │Enter │
+ * ├──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┤
+ * │      │      │      │      │      │      │      │      │      │      │      │      │
+ * └──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┘
+ */
+[_RAISE] = LAYOUT_preonic_grid(
+  _______, KC_F11,  KC_F12,  KC_F13,  KC_F14,  KC_F15,  KC_F16,  KC_F17,  KC_F18,  KC_F19,  KC_F20,  _______,
+  KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_DELETE,
+  KC_DEL,  _______, _______, _______, _______, _______, KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT, _______, KC_BSLS,
+  KC_LSFT, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_ENTER,
+  _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
+),
+
+
+/* LOWER
+ * ┌──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┐
+ * │      │      │      │      │      │      │      │      │      │      │      │      │
+ * ├──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┤
+ * │  ~   │  !   │  @   │  #   │  $   │  %   │  ^   │  &   │  *   │  (   │  )   │  Del │
+ * ├──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┤
+ * │  Del │  F1  │  F2  │  F3  │  F4  │  F5  │  F6  │  -   │      │  [   │  ]   │  \   │
+ * ├──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┤
+ * │Enter │  F7  │  F8  │  F9  │  F10 │  F11 │  F12 │  +   │  =   │  {   │  }   │ Shft │
+ * ├──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┤
+ * │      │      │      │      │      │      │      │      │      │      │      │      │
+ * └──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┘
+ */
+[_LOWER] = LAYOUT_preonic_grid(
+  _______,  _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+  KC_TILD,  KC_EXLM, KC_AT,   KC_HASH, KC_DLR,  KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_DELETE,
+  KC_DEL,   KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_MINS, KC_UNDS, KC_LBRC, KC_RBRC, KC_BSLS,
+  KC_ENTER, KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  KC_PLUS, KC_EQL,  KC_LCBR, KC_RCBR, KC_RSFT,
+  _______,  _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
+),
+
+/* ADJUST
+ * ┌──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┬──────┐
+ * │      │      │      │      │      │      │      │      │      │      │      │      │
+ * ├──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┤
+ * │      │BOOT  │DBTOGG│AUTOGG│      │      │      │      │  Ins │      │      │  Del │
+ * ├──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┤
+ * │ Caps │      │      │      │      │AGTOGG│      │      │      │      │      │      │
+ * ├──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┤
+ * │      │      │  Del │      │      │      │      │      │      │      │      │      │
+ * ├──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┼──────┤
+ * │      │      │      │      │      │      │      │      │      │      │      │      │
+ * └──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┴──────┘
+ */
+[_ADJUST] = LAYOUT_preonic_grid(
+  _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
+  _______, QK_BOOT, DB_TOGG, AU_TOGG, _______, _______, _______, _______, KC_INS,  _______, _______, KC_DELETE,
+  KC_CAPS, _______, _______, _______, _______, AG_TOGG, _______, _______, _______, _______, _______, _______,
+  _______, _______, KC_DEL,  _______, _______, _______, _______, _______, _______, _______, _______, _______,
+  _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
+)
+
+
+};
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+  switch (keycode) {
+        case LOWER:
+          if (record->event.pressed) {
+            layer_on(_LOWER);
+            update_tri_layer(_LOWER, _RAISE, _ADJUST);
+          } else {
+            layer_off(_LOWER);
+            update_tri_layer(_LOWER, _RAISE, _ADJUST);
+          }
+          return false;
+          break;
+        case RAISE:
+          if (record->event.pressed) {
+            layer_on(_RAISE);
+            update_tri_layer(_LOWER, _RAISE, _ADJUST);
+          } else {
+            layer_off(_RAISE);
+            update_tri_layer(_LOWER, _RAISE, _ADJUST);
+          }
+          return false;
+          break;
+        case BACKLIT:
+          if (record->event.pressed) {
+            register_code(KC_RSFT);
+            #ifdef BACKLIGHT_ENABLE
+              backlight_step();
+            #endif
+            #ifdef RGBLIGHT_ENABLE
+              rgblight_step();
+            #endif
+            #ifdef __AVR__
+            writePinLow(E6);
+            #endif
+          } else {
+            unregister_code(KC_RSFT);
+            #ifdef __AVR__
+            writePinHigh(E6);
+            #endif
+          }
+          return false;
+          break;
+      }
+    return true;
+};
+
+#if defined(ENCODER_MAP_ENABLE)
+const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][2] = {
+    [_QWERTY_MACOS] = { ENCODER_CCW_CW(KC_VOLU, KC_VOLD) },
+    [_LOWER] = { ENCODER_CCW_CW(_______, _______) },
+    [_RAISE] = { ENCODER_CCW_CW(KC_BRMU, KC_BRMD) },
+    [_ADJUST] = { ENCODER_CCW_CW(_______, _______) },
+};
+#endif
diff --git a/keyboards/preonic/keymaps/snowskeleton/readme.md b/keyboards/preonic/keymaps/snowskeleton/readme.md
new file mode 100644
index 0000000000..76a1dda003
--- /dev/null
+++ b/keyboards/preonic/keymaps/snowskeleton/readme.md
@@ -0,0 +1,20 @@
+# Snowskeleton Preonic Layout (with Rotery Encoder)
+This layout aims to optimize several corner cases where the default layout falls short.
+This is a opinionated layout, designed for efficient coding in English.
+As such, several internationalizations have been removed,
+and you may wish to add them back in when adjusting to your language.
+
+Special notes:
+
+the Enter key is only accessable through alternate layers,
+but there it is available on both sides of the board (depending on the layer).
+
+Numbers and their coorisponding symbols (1 and !, 2 and @, etc) can be typed several ways.
+Each is available on its own layer,
+while still following Shift key convention.
+
+Vim-like arrow keys on Raise layer.
+
+Instead of having a separate layout for Windows,
+I only support swapping the Gui and Alt keys.
+This provides 99% of the functionality without requiring the maintainence of two separate layouts.
diff --git a/keyboards/preonic/keymaps/snowskeleton/rules.mk b/keyboards/preonic/keymaps/snowskeleton/rules.mk
new file mode 100644
index 0000000000..da6657c8bd
--- /dev/null
+++ b/keyboards/preonic/keymaps/snowskeleton/rules.mk
@@ -0,0 +1,3 @@
+SRC += muse.c
+ENCODER_ENABLE = yes
+ENCODER_MAP_ENABLE = yes