Macros Layer on Double Thumb-Hold (QMK)

[noahShinabarger]

I wanted to create some macros to type out common strings. This is unadvisable if your keyboard is ever in public, but mine is in my home office. It took me a while to figure out how to get this working, so I wanted to make a detailed post so others trying to do the same thing have a resource to use.

I started with modifying custom_config.h and making sure I could get a new layer working. I ran into some issuses, but ended up getting it working. I then added the macros which required adding a manna-harbour_miryoku directory under qmk_firmware/keyboards/crkbd/keymaps and copying over config.h and keymap.c from qmk_keyboards/layouts/community/split_3x6_3/manna-harbour_miryoku. I also wanted to try out Pascal Getreuer's "word select" macro, which required adding a features directory under qmk_firmware/keyboards/crkbd/keymaps/manna-harbour_miryoku along with select_word.c and select_word.h. The "word select" macro also required one small change to the custom_rules.mk.

Files are pasted below with sensitive information changed.

custom_config.c

// Copyright 2019 Manna Harbour
// https://github.com/manna-harbour/miryoku

// 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

#define MIRYOKU_LAYER_LIST \
MIRYOKU_X(BASE,   "Base") \
MIRYOKU_X(EXTRA,  "Extra") \
MIRYOKU_X(TAP,    "Tap") \
MIRYOKU_X(BUTTON, "Button") \
MIRYOKU_X(NAV,    "Nav") \
MIRYOKU_X(MOUSE,  "Mouse") \
MIRYOKU_X(MEDIA,  "Media") \
MIRYOKU_X(NUM,    "Num") \
MIRYOKU_X(SYM,    "Sym") \
MIRYOKU_X(FUN,    "Fun") \
MIRYOKU_X(PRSNL,  "Personal")

/*
enum custom_keycodes {
    UPDIR = SAFE_RANGE,
    LST_NME,
    P_EML,
    W_EML,
    PHONE,
    PAREN,
    BRACE,
    BRCKT,
    PASWD,
    NXTSEN,
    SELWRD,
};
*/

#define MIRYOKU_LAYER_NAV \
TD(U_TD_BOOT),     TD(U_TD_U_TAP),    TD(U_TD_U_EXTRA),  TD(U_TD_U_BASE),   U_NA,              U_RDO,             U_PST,             U_CPY,             U_CUT,             U_UND,             \
KC_LGUI,           KC_LALT,           KC_LCTL,           KC_LSFT,           U_NA,              CW_TOGG,           KC_LEFT,           KC_DOWN,           KC_UP,             KC_RGHT,           \
U_NA,              KC_ALGR,           TD(U_TD_U_NUM),    TD(U_TD_U_NAV),    U_NA,              KC_INS,            KC_HOME,           KC_PGDN,           NXTSEN,            KC_END,            \
U_NP,              U_NP,              U_NA,              U_NA,              U_NA,              KC_ENT,            LT(U_PRSNL,KC_BSPC),KC_DEL,           U_NP,              U_NP

#define MIRYOKU_LAYER_NUM \
KC_LBRC,           KC_7,              KC_8,              KC_9,              KC_RBRC,           U_NA,              TD(U_TD_U_BASE),   TD(U_TD_U_EXTRA),  TD(U_TD_U_TAP),    TD(U_TD_BOOT),     \
KC_SCLN,           KC_4,              KC_5,              KC_6,              KC_EQL,            U_NA,              KC_LSFT,           KC_LCTL,           KC_LALT,           KC_LGUI,           \
KC_GRV,            KC_1,              KC_2,              KC_3,              KC_BSLS,           U_NA,              TD(U_TD_U_NUM),    TD(U_TD_U_NAV),    KC_ALGR,           U_NA,              \
U_NP,              U_NP,              KC_DOT,            LT(U_PRSNL,KC_0),  KC_MINS,           U_NA,              U_NA,              U_NA,              U_NP,              U_NP

#define MIRYOKU_LAYER_PRSNL \
KC_LBRC,           UPDIR,             PHONE,             KC_7,              KC_RBRC,           U_NA,              TD(U_TD_U_BASE),   TD(U_TD_U_EXTRA),  TD(U_TD_U_TAP),    TD(U_TD_BOOT),     \
KC_SCLN,           KC_7,              LST_NME,           W_EML,             P_EML,             U_NA,              SELWRD,            KC_LCTL,           KC_LALT,           PASWD,             \
KC_GRV,            KC_7,              KC_7,              KC_7,              KC_BSLS,           U_NA,              TD(U_TD_U_NUM),    TD(U_TD_U_NAV),    KC_ALGR,           U_NA,              \
U_NP,              U_NP,              KC_DOT,            KC_0,              KC_MINS,           U_NA,              U_NA,              U_NA,              U_NP,              U_NP

#define MIRYOKU_LAYERMAPPING_PRSNL MIRYOKU_MAPPING

keymap.c

// Copyright 2019 Manna Harbour
// https://github.com/manna-harbour/miryoku

// 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 "features/select_word.h"

enum custom_keycodes {
    UPDIR = SAFE_RANGE,
    LST_NME,
    P_EML,
    W_EML,
    PHONE,
    PAREN,
    BRACE,
    BRCKT,
    PASWD,
    NXTSEN,
    SELWRD,
};

bool process_record_user(uint16_t keycode, keyrecord_t* record) {
    if (!process_select_word(keycode, record, SELWRD)) { return false; }
  switch (keycode) {
    case UPDIR:  // Types ../ to go up a directory on the shell.
      if (record->event.pressed) {
        SEND_STRING("../");
      }
      return false;
    case LST_NME:
      if (record->event.pressed) {
        SEND_STRING("Lastname");
      }
      return false;
    case P_EML:
      if (record->event.pressed) {
        SEND_STRING("me@domain.com");
      }
      return false;
    case W_EML:
      if (record->event.pressed) {
        SEND_STRING("me@work.com");
      }
      return false;
    case PHONE:
      if (record->event.pressed) {
        SEND_STRING("1112223333");
      }
      return false;
    /*
    case PAREN:
      if (record->event.pressed) {
        SEND_STRING("../");
      }
      return false;
    case BRACE:  // Types ../ to go up a directory on the shell.
      if (record->event.pressed) {
        SEND_STRING("../");
      }
      return false;
    case BRCKT:  // Types ../ to go up a directory on the shell.
      if (record->event.pressed) {
        SEND_STRING("../");
      }
      return false;
    */
    case PASWD:
      if (record->event.pressed) {
        SEND_STRING("password");
      }
      return false;
    case NXTSEN:  // Next sentence macro.
      if (record->event.pressed) {
          SEND_STRING(". ");
          add_oneshot_mods(MOD_BIT(KC_LSFT));  // Set one-shot mod for shift.
      }
      return false;
  }
  return true;
}

custom_rules.mk

# Copyright 2019 Manna Harbour
# https://github.com/manna-harbour/miryoku

MIRYOKU_CLIPBOARD=MAC

SRC += features/select_word.c

[manna-harbour]

Thanks for sharing your customisations!

I'd suggest using the files below users/manna-harbour_miryoku directly, rather than keyboards/crkbd/keymaps/manna-harbour_miryoku, unless you want the changes to only apply to crkbd. See #279 (comment). Also see #94 for future custom macro support.