DCompact Update 1 (#3202)

* Add Plover layer to DCompact from Planck default

* Fix up and update DCompact READMEs

* Add missing Steno features

* Switch flags to re-enable extrakeys

* Fix compilation bug in Chimera layout

diff --git a/keyboards/chimera_ortho/keymaps/dcompact/README.md b/keyboards/chimera_ortho/keymaps/dcompact/README.md
index 04cb4fcb6e1c63ee80576f3f5a7d2104830b4534..18c23d66eda2c2fd514c00f9c6e84fa11524903d 100644 (file)
--- a/keyboards/chimera_ortho/keymaps/dcompact/README.md
+++ b/keyboards/chimera_ortho/keymaps/dcompact/README.md
@@ -1,6 +1,6 @@
 # DCompact Layout
 
-**Dvorak, Layered, Mouse-Enabled, Compact**
+**Dvorak, Layered, Mouse-Enabled, Compact -- Plover coming soon!?!~**
 
 _See [the layout source](keymap.c) for the actual layout_
 
@@ -11,7 +11,7 @@ layout:
 
 - Provide minimal travel distance when typing English or coding
 - Consistent muscle memory translation from standard QWERTY
-- Statless typing experience
+- Stateless typing experience
 - OS-agnostic features, macros, and key placement
 - Minimize dependence on mouse usage
 
@@ -34,10 +34,10 @@ merge with those in the keyboard folder_
 
 ## Relevant Links
 
-- !(Online Dvorak Layout Trainer)[https://learn.dvorak.nl/]
-- !(Dvorak Wikipedia Page)[https://en.wikipedia.org/wiki/Dvorak_Simplified_Keyboard]
-- !(QMK Docs)[https://docs.qmk.fm/#/]
-- !(QMK KeyCode Reference)[https://docs.qmk.fm/#/keycodes]
+- ![Online Dvorak Layout Trainer](https://learn.dvorak.nl/)
+- ![Dvorak Wikipedia Page](https://en.wikipedia.org/wiki/Dvorak_Simplified_Keyboard)
+- ![QMK Docs](https://docs.qmk.fm/#/)
+- ![QMK KeyCode Reference](https://docs.qmk.fm/#/keycodes)
 
 ## Contact
 

diff --git a/keyboards/chimera_ortho/keymaps/dcompact/keymap.c b/keyboards/chimera_ortho/keymaps/dcompact/keymap.c
index eab8db22c438f9615ca2346df26ecafd3a66b552..74c3a25cda09cdba47519648b064f996aacdcca0 100644 (file)
--- a/keyboards/chimera_ortho/keymaps/dcompact/keymap.c
+++ b/keyboards/chimera_ortho/keymaps/dcompact/keymap.c
@@ -95,8 +95,8 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
   ),
 };
 
-# These control the color of the LED on the receiver
-# For color reference, see ../../chimera_ortho.h
+// These control the color of the LED on the receiver
+// For color reference, see ../../chimera_ortho.h
 void matrix_scan_user(void) {
     uint8_t layer = biton32(layer_state);
     

diff --git a/keyboards/planck/keymaps/dcompact/README.md b/keyboards/planck/keymaps/dcompact/README.md
index 04cb4fcb6e1c63ee80576f3f5a7d2104830b4534..d3e4c7a62d41ec10edf60090def91a4d0f50539d 100644 (file)
--- a/keyboards/planck/keymaps/dcompact/README.md
+++ b/keyboards/planck/keymaps/dcompact/README.md
@@ -1,6 +1,6 @@
 # DCompact Layout
 
-**Dvorak, Layered, Mouse-Enabled, Compact**
+**Dvorak, Layered, Mouse-Enabled, Compact -- now with Plover~**
 
 _See [the layout source](keymap.c) for the actual layout_
 
@@ -11,7 +11,7 @@ layout:
 
 - Provide minimal travel distance when typing English or coding
 - Consistent muscle memory translation from standard QWERTY
-- Statless typing experience
+- Stateless typing experience
 - OS-agnostic features, macros, and key placement
 - Minimize dependence on mouse usage
 
@@ -34,10 +34,10 @@ merge with those in the keyboard folder_
 
 ## Relevant Links
 
-- !(Online Dvorak Layout Trainer)[https://learn.dvorak.nl/]
-- !(Dvorak Wikipedia Page)[https://en.wikipedia.org/wiki/Dvorak_Simplified_Keyboard]
-- !(QMK Docs)[https://docs.qmk.fm/#/]
-- !(QMK KeyCode Reference)[https://docs.qmk.fm/#/keycodes]
+- ![Online Dvorak Layout Trainer](https://learn.dvorak.nl/)
+- ![Dvorak Wikipedia Page](https://en.wikipedia.org/wiki/Dvorak_Simplified_Keyboard)
+- ![QMK Docs](https://docs.qmk.fm/#/)
+- ![QMK KeyCode Reference](https://docs.qmk.fm/#/keycodes)
 
 ## Contact
 

diff --git a/keyboards/planck/keymaps/dcompact/keymap.c b/keyboards/planck/keymaps/dcompact/keymap.c
index 21245b7023d29caf6c86b2d320aaed007017592e..a5ce1ef4155f65e3704983b73a99c7050a48dbe1 100644 (file)
--- a/keyboards/planck/keymaps/dcompact/keymap.c
+++ b/keyboards/planck/keymaps/dcompact/keymap.c
@@ -16,6 +16,7 @@
 
 #include "planck.h"
 #include "action_layer.h"
+#include "keymap_steno.h"
 
 // Custom Keycodes and Combinations Used
 #define DEL_SHF SFT_T(KC_DEL)
@@ -33,17 +34,20 @@ enum planck_layers {
   _LOWER,
   _RAISE,
   _FUNC,
-  _MOUSE,
-  _ADJUST
+  _PLOVER,
+  _ADJUST,
+  _MOUSE
 };
 
 enum planck_keycodes {
   BASE = SAFE_RANGE,
+  PLOVER,
   LOWER,
   RAISE,
   FUNC,
   MOUSE,
-  ADJUST
+  ADJUST,
+  EXT_PLV
 };
 
 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
@@ -56,14 +60,14 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  * |------+------+------+------+------+------|------+------+------+------+------+------|
  * |Del/Sf|  : ; |   Q  |   J  |   K  |   X  |   B  |   M  |   W  |   V  |   Z  | Bspc |
  * |------+------+------+------+------+------+------+------+------+------+------+------|
- * | Ctrl |  Fn  | GUI  | Alt  |Lower |Shift |Space |Raise | Alt  | GUI  |  Fn  |Enter |
+ * | Ctrl |Plover| GUI  | Alt  |Lower |Shift |Space |Raise | Alt  | GUI  |  Fn  |Enter |
  * `-----------------------------------------------------------------------------------'
  */
 [_BASE] = {
   {  KC_TAB, KC_QUOT, KC_COMM,  KC_DOT,    KC_P,    KC_Y,    KC_F,    KC_G,    KC_C,    KC_R,    KC_L, KC_SLSH},
   {  KC_ESC,    KC_A,    KC_O,    KC_E,    KC_U,    KC_I,    KC_D,    KC_H,    KC_T,    KC_N,    KC_S, KC_MINS},
   { DEL_SHF, KC_SCLN,    KC_Q,    KC_J,    KC_K,    KC_X,    KC_B,    KC_M,    KC_W,    KC_V,    KC_Z, KC_BSPC},
-  { KC_LCTL,    FUNC, KC_LGUI, KC_LALT,   LOWER,  KC_LSFT,  KC_SPC,   RAISE, KC_RALT, KC_RGUI,    FUNC,  KC_ENT}
+  { KC_LCTL,  PLOVER, KC_LGUI, KC_LALT,   LOWER,  KC_LSFT,  KC_SPC,   RAISE, KC_RALT, KC_RGUI,    FUNC,  KC_ENT}
 },
 
 /* Lower
@@ -138,6 +142,25 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
   { _______, _______, _______, _______, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, _______, XXXXXXX}
 },
 
+/* Plover layer (http://opensteno.org)
+ * ,-----------------------------------------------------------------------------------.
+ * |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |   #  |
+ * |------+------+------+------+------+-------------+------+------+------+------+------|
+ * |  FN  |   S  |   T  |   P  |   H  |   *  |   *  |   F  |   P  |   L  |   T  |   D  |
+ * |------+------+------+------+------+------|------+------+------+------+------+------|
+ * |      |   S  |   K  |   W  |   R  |   *  |   *  |   R  |   B  |   G  |   S  |   Z  |
+ * |------+------+------+------+------+------+------+------+------+------+------+------|
+ * | Exit |      |      |   A  |   O  |             |   E  |   U  |  PWR | RES1 | RES2 |
+ * `-----------------------------------------------------------------------------------'
+ */
+
+[_PLOVER] = {
+  {STN_N1,  STN_N2,  STN_N3,  STN_N4,  STN_N5,  STN_N6,  STN_N7,  STN_N8,  STN_N9,  STN_NA,  STN_NB,  STN_NC },
+  {STN_FN,  STN_S1,  STN_TL,  STN_PL,  STN_HL,  STN_ST1, STN_ST3, STN_FR,  STN_PR,  STN_LR,  STN_TR,  STN_DR },
+  {XXXXXXX, STN_S2,  STN_KL,  STN_WL,  STN_RL,  STN_ST2, STN_ST4, STN_RR,  STN_BR,  STN_GR,  STN_SR,  STN_ZR },
+  {EXT_PLV, XXXXXXX, XXXXXXX, STN_A,   STN_O,   XXXXXXX, XXXXXXX, STN_E,   STN_U,   STN_PWR, STN_RE1, STN_RE2}
+},
+
 /* Adjust (Lower + Raise)
  * ,-----------------------------------------------------------------------------------.
  * |      | Reset|      |      |      |      |      |      |      |      |      |  Del |
@@ -158,6 +181,11 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 
 };
 
+#ifdef AUDIO_ENABLE
+  float plover_song[][2]     = SONG(PLOVER_SOUND);
+  float plover_gb_song[][2]  = SONG(PLOVER_GOODBYE_SOUND);
+#endif
+
 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
   switch (keycode) {
     case LOWER:
@@ -188,6 +216,25 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
       }
       return false;
       break;
+    case PLOVER:
+      if (!record->event.pressed) {
+        #ifdef AUDIO_ENABLE
+          stop_all_notes();
+          PLAY_SONG(plover_song);
+        #endif
+        layer_on(_PLOVER);
+      }
+      return false;
+      break;
+    case EXT_PLV:
+      if (record->event.pressed) {
+        #ifdef AUDIO_ENABLE
+          PLAY_SONG(plover_gb_song);
+        #endif
+        layer_off(_PLOVER);
+      }
+      return false;
+      break;
     case MOUSE:
       if (record->event.pressed) {
         layer_on(_MOUSE);
@@ -199,3 +246,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
   }
   return true;
 }
+
+void matrix_init_user() {
+  steno_set_mode(STENO_MODE_GEMINI);
+}

diff --git a/keyboards/planck/keymaps/dcompact/rules.mk b/keyboards/planck/keymaps/dcompact/rules.mk
index 9c9280adb57e4ebfb04e927ffaf477107c4cb7ca..d7eff1adc6f84c88387d654ba0c1b0e6e4269eab 100644 (file)
--- a/keyboards/planck/keymaps/dcompact/rules.mk
+++ b/keyboards/planck/keymaps/dcompact/rules.mk
@@ -2,3 +2,14 @@ ifndef QUANTUM_DIR
        include ../../../../Makefile
 endif
 
+# https://beta.docs.qmk.fm/reference/config-options#feature-options
+# Features Specifically Wanted
+EXTRAKEY_ENABLE = yes
+STENO_ENABLE = yes
+NKRO_ENABLE = yes
+AUDIO_ENABLE = yes
+
+# Features taking up space
+MOUSEKEY_ENABLE = no
+MIDI_ENABLE = no
+CONSOLE_ENABLE = no