Nulo/qmk_firmware
1
0
Fork 0
Code Releases Activity

Update miryoku (#9442)

Browse source 
- Add mouse buttons overlay layer
- Change button order
- Remove crkbd hardware specifics
- Add alternative base layer alphas
- Change title
- Add logo
- Reword intro text
- Add dev branch and new commits links
- Replace manual toc and remove anchors
- Unindent lists
- Reduce headings
- Update docs
- Build keymap as object instead of including .c file
- Add kle subset mapping images
- Add alternative mapping support
- Change default mapping for ortho_4x12
- Add split mapping for ortho_4x12
- Add contact section
- Add #pragma once to layout and keyboard config.h
This commit is contained in:
Manna Harbour 2020-06-23 15:30:05 +10:00 committed by GitHub
parent 24b0cda3e8
commit f0bde7906d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
12 changed files with 511 additions and 327 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
keyboards/crkbd/keymaps/manna-harbour_miryoku/config.h
View file

@ -2,17 +2,15 @@
#pragma once #pragma once
#define EE_HANDS #define LAYOUT_miryoku( \
K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, \
#ifdef RGB_MATRIX_ENABLE K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, \
#define RGB_MATRIX_KEYPRESSES // reacts to keypresses K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, \
#define RGB_DISABLE_WHEN_USB_SUSPENDED true // turn off effects when suspended N30, N31, K32, K33, K34, K35, K36, K37, N38, N39 \
#define RGB_MATRIX_FRAMEBUFFER_EFFECTS ) \
#define RGB_MATRIX_MAXIMUM_BRIGHTNESS 150 // limits maximum brightness of LEDs to 150 out of 255. Higher may cause the controller to crash. LAYOUT( \
#define RGB_MATRIX_HUE_STEP 8 KC_NO, K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, KC_NO, \
#define RGB_MATRIX_SAT_STEP 8 KC_NO, K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, KC_NO, \
#define RGB_MATRIX_VAL_STEP 8 KC_NO, K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, KC_NO, \
#define RGB_MATRIX_SPD_STEP 10 K32, K33, K34, K35, K36, K37 \
#endif )
#define SSD1306OLED // old oled driver

53
keyboards/crkbd/keymaps/manna-harbour_miryoku/keymap.c
View file

@ -1,54 +1 @@
// generated from users/manna-harbour_miryoku/miryoku.org -*- buffer-read-only: t -*- // generated from users/manna-harbour_miryoku/miryoku.org -*- buffer-read-only: t -*-
#define LAYOUT_miryoku( \
K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, \
K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, \
K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, \
N30, N31, K32, K33, K34, K35, K36, K37, N38, N39 \
) \
LAYOUT( \
KC_NO, K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, KC_NO, \
KC_NO, K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, KC_NO, \
KC_NO, K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, KC_NO, \
K32, K33, K34, K35, K36, K37 \
)
#include "manna-harbour_miryoku.c"
#ifdef SSD1306OLED
#include "ssd1306.h"
void matrix_init_user(void) {
iota_gfx_init(!has_usb()); // turns on the display
}
// When add source files to SRC in rules.mk, you can use functions.
const char *read_logo(void);
void matrix_scan_user(void) {
iota_gfx_task();
}
void matrix_render_user(struct CharacterMatrix *matrix) {
if (host_keyboard_leds() & (1<<USB_LED_CAPS_LOCK)) {
matrix_write(matrix, read_logo());
}
}
void matrix_update(struct CharacterMatrix *dest, const struct CharacterMatrix *source) {
if (memcmp(dest->display, source->display, sizeof(dest->display))) {
memcpy(dest->display, source->display, sizeof(dest->display));
dest->dirty = true;
}
}
void iota_gfx_task_user(void) {
struct CharacterMatrix matrix;
matrix_clear(&matrix);
matrix_render_user(&matrix);
matrix_update(&display, &matrix);
}
#endif //SSD1306OLED

7
keyboards/crkbd/keymaps/manna-harbour_miryoku/rules.mk
View file

@ -1,7 +0,0 @@
# generated from users/manna-harbour_miryoku/miryoku.org -*- buffer-read-only: t -*-
RGB_MATRIX_ENABLE = WS2812
# old oled driver
SRC += ./lib/glcdfont.c \
./lib/logo_reader.c

20
layouts/community/ergodox/manna-harbour_miryoku/config.h Normal file
View file

@ -0,0 +1,20 @@
// generated from users/manna-harbour_miryoku/miryoku.org -*- buffer-read-only: t -*-
#pragma once
#define LAYOUT_miryoku(\
K00, K01, K02, K03, K04, K05, K06, K07, K08, K09,\
K10, K11, K12, K13, K14, K15, K16, K17, K18, K19,\
K20, K21, K22, K23, K24, K25, K26, K27, K28, K29,\
N30, N31, K32, K33, K34, K35, K36, K37, N38, N39\
)\
LAYOUT_ergodox_pretty( \
KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, \
KC_NO, K00, K01, K02, K03, K04, KC_NO, KC_NO, K05, K06, K07, K08, K09, KC_NO, \
KC_NO, K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, KC_NO, \
KC_NO, K20, K21, K22, K23, K24, KC_NO, KC_NO, K25, K26, K27, K28, K29, KC_NO, \
KC_NO, KC_NO, KC_NO, KC_NO, K32, K37, KC_NO, KC_NO, KC_NO, KC_NO, \
KC_NO, KC_NO, KC_NO, KC_NO, \
KC_NO, KC_NO, \
K33, K34, KC_NO, KC_NO, K35, K36 \
)

19
layouts/community/ergodox/manna-harbour_miryoku/keymap.c
View file

@ -1,20 +1 @@
// generated from users/manna-harbour_miryoku/miryoku.org -*- buffer-read-only: t -*- // generated from users/manna-harbour_miryoku/miryoku.org -*- buffer-read-only: t -*-
#define LAYOUT_miryoku(\
K00, K01, K02, K03, K04, K05, K06, K07, K08, K09,\
K10, K11, K12, K13, K14, K15, K16, K17, K18, K19,\
K20, K21, K22, K23, K24, K25, K26, K27, K28, K29,\
N30, N31, K32, K33, K34, K35, K36, K37, N38, N39\
)\
LAYOUT_ergodox_pretty( \
KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, \
KC_NO, K00, K01, K02, K03, K04, KC_NO, KC_NO, K05, K06, K07, K08, K09, KC_NO, \
KC_NO, K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, KC_NO, \
KC_NO, K20, K21, K22, K23, K24, KC_NO, KC_NO, K25, K26, K27, K28, K29, KC_NO, \
KC_NO, KC_NO, KC_NO, KC_NO, K32, K37, KC_NO, KC_NO, KC_NO, KC_NO, \
KC_NO, KC_NO, KC_NO, KC_NO, \
KC_NO, KC_NO, \
K33, K34, KC_NO, KC_NO, K35, K36 \
)
#include "manna-harbour_miryoku.c"

31
layouts/community/ortho_4x12/manna-harbour_miryoku/config.h Normal file
View file

@ -0,0 +1,31 @@
// generated from users/manna-harbour_miryoku/miryoku.org -*- buffer-read-only: t -*-
#pragma once
#if defined MIRYOKU_MAPPING_SPLIT
#define LAYOUT_miryoku(\
K00, K01, K02, K03, K04, K05, K06, K07, K08, K09,\
K10, K11, K12, K13, K14, K15, K16, K17, K18, K19,\
K20, K21, K22, K23, K24, K25, K26, K27, K28, K29,\
N30, N31, K32, K33, K34, K35, K36, K37, N38, N39\
)\
LAYOUT_ortho_4x12(\
KC_NO, K01, K02, K03, K04, KC_NO, KC_NO, K05, K06, K07, K08, KC_NO,\
K00, K11, K12, K13, K14, KC_NO, KC_NO, K15, K16, K17, K18, K09,\
K10, K21, K22, K23, K24, KC_NO, KC_NO, K25, K26, K27, K28, K19,\
K20, KC_NO, KC_NO, K32, K33, K34, K35, K36, K37, KC_NO, KC_NO, K29\
)
#else
#define LAYOUT_miryoku(\
K00, K01, K02, K03, K04, K05, K06, K07, K08, K09,\
K10, K11, K12, K13, K14, K15, K16, K17, K18, K19,\
K20, K21, K22, K23, K24, K25, K26, K27, K28, K29,\
N30, N31, K32, K33, K34, K35, K36, K37, N38, N39\
)\
LAYOUT_ortho_4x12(\
K00, K01, K02, K03, K04, KC_NO, KC_NO, K05, K06, K07, K08, K09,\
K10, K11, K12, K13, K14, KC_NO, KC_NO, K15, K16, K17, K18, K19,\
K20, K21, K22, K23, K24, KC_NO, KC_NO, K25, K26, K27, K28, K29,\
KC_NO, KC_NO, K32, K33, K34, K34, K35, K35, K36, K37, KC_NO, KC_NO\
)
#endif

15
layouts/community/ortho_4x12/manna-harbour_miryoku/keymap.c
View file

@ -1,16 +1 @@
// generated from users/manna-harbour_miryoku/miryoku.org -*- buffer-read-only: t -*- // generated from users/manna-harbour_miryoku/miryoku.org -*- buffer-read-only: t -*-
#define LAYOUT_miryoku(\
K00, K01, K02, K03, K04, K05, K06, K07, K08, K09,\
K10, K11, K12, K13, K14, K15, K16, K17, K18, K19,\
K20, K21, K22, K23, K24, K25, K26, K27, K28, K29,\
N30, N31, K32, K33, K34, K35, K36, K37, N38, N39\
)\
LAYOUT_ortho_4x12(\
KC_NO, K01, K02, K03, K04, KC_NO, KC_NO, K05, K06, K07, K08, KC_NO,\
K00, K11, K12, K13, K14, KC_NO, KC_NO, K15, K16, K17, K18, K09,\
K10, K21, K22, K23, K24, KC_NO, KC_NO, K25, K26, K27, K28, K19,\
K20, KC_NO, KC_NO, K32, K33, K34, K35, K36, K37, KC_NO, KC_NO, K29\
)
#include "manna-harbour_miryoku.c"

15
users/manna-harbour_miryoku/config.h
View file

@ -2,6 +2,9 @@
#pragma once #pragma once
// default but important
#define TAPPING_TERM 200
// Prevent normal rollover on alphas from accidentally triggering mods. // Prevent normal rollover on alphas from accidentally triggering mods.
#define IGNORE_MOD_TAP_INTERRUPT #define IGNORE_MOD_TAP_INTERRUPT
@ -10,3 +13,15 @@
// Recommended for heavy chording. // Recommended for heavy chording.
#define QMK_KEYS_PER_SCAN 4 #define QMK_KEYS_PER_SCAN 4
// Mouse key speed and acceleration.
#undef MOUSEKEY_DELAY
#define MOUSEKEY_DELAY 0
#undef MOUSEKEY_INTERVAL
#define MOUSEKEY_INTERVAL 16
#undef MOUSEKEY_WHEEL_DELAY
#define MOUSEKEY_WHEEL_DELAY 0
#undef MOUSEKEY_MAX_SPEED
#define MOUSEKEY_MAX_SPEED 6
#undef MOUSEKEY_TIME_TO_MAX
#define MOUSEKEY_TIME_TO_MAX 64

61
users/manna-harbour_miryoku/manna-harbour_miryoku.c
View file

@ -1,28 +1,51 @@
// generated from users/manna-harbour_miryoku/miryoku.org -*- buffer-read-only: t -*- // generated from users/manna-harbour_miryoku/miryoku.org -*- buffer-read-only: t -*-
#include QMK_KEYBOARD_H #include "manna-harbour_miryoku.h"
#define KC_NP KC_NO // key is not present
#define KC_NA KC_NO // present but not available for use
#define KC_NU KC_NO // available but not used
// non-KC_ keycodes
#define KC_RST RESET
#define KC_TOG RGB_TOG
#define KC_MOD RGB_MOD
#define KC_HUI RGB_HUI
#define KC_SAI RGB_SAI
#define KC_VAI RGB_VAI
enum layers { BASE, MEDR, NAVR, MOUR, NSSL, NSL, FUNL };
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
#if defined MIRYOKU_ALPHAS_QWERTY
[BASE] = LAYOUT_miryoku(
KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P,
LGUI_T(KC_A), LALT_T(KC_S), LCTL_T(KC_D), LSFT_T(KC_F), KC_G, KC_H, LSFT_T(KC_J), LCTL_T(KC_K), LALT_T(KC_L), LGUI_T(KC_QUOT),
KC_Z, ALGR_T(KC_X), KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, ALGR_T(KC_DOT), KC_SLSH,
KC_NP, KC_NP, LT(MEDR, KC_ESC), LT(NAVR, KC_SPC), LT(MOUR, KC_TAB), LT(NSSL, KC_ENT), LT(NSL, KC_BSPC), LT(FUNL, KC_DEL), KC_NP, KC_NP
),
#elif defined MIRYOKU_ALPHAS_DVORAK
[BASE] = LAYOUT_miryoku(
KC_QUOT, KC_COMM, KC_DOT, KC_P, KC_Y, KC_F, KC_G, KC_C, KC_R, KC_L,
LGUI_T(KC_A), LALT_T(KC_O), LCTL_T(KC_E), LSFT_T(KC_U), KC_I, KC_D, LSFT_T(KC_H), LCTL_T(KC_T), LALT_T(KC_N), LGUI_T(KC_S),
KC_SLSH, ALGR_T(KC_Q), KC_J, KC_K, KC_X, KC_B, KC_M, KC_W, ALGR_T(KC_V), KC_Z,
KC_NP, KC_NP, LT(MEDR, KC_ESC), LT(NAVR, KC_SPC), LT(MOUR, KC_TAB), LT(NSSL, KC_ENT), LT(NSL, KC_BSPC), LT(FUNL, KC_DEL), KC_NP, KC_NP
),
#elif defined MIRYOKU_ALPHAS_COLEMAK
[BASE] = LAYOUT_miryoku(
KC_Q, KC_W, KC_F, KC_P, KC_G, KC_J, KC_L, KC_U, KC_Y, KC_QUOT,
LGUI_T(KC_A), LALT_T(KC_R), LCTL_T(KC_S), LSFT_T(KC_T), KC_D, KC_H, LSFT_T(KC_N), LCTL_T(KC_E), LALT_T(KC_I), LGUI_T(KC_O),
KC_Z, ALGR_T(KC_X), KC_C, KC_V, KC_B, KC_K, KC_M, KC_COMM, ALGR_T(KC_DOT), KC_SLSH,
KC_NP, KC_NP, LT(MEDR, KC_ESC), LT(NAVR, KC_SPC), LT(MOUR, KC_TAB), LT(NSSL, KC_ENT), LT(NSL, KC_BSPC), LT(FUNL, KC_DEL), KC_NP, KC_NP
),
#elif defined MIRYOKU_ALPHAS_COLEMAKDH
[BASE] = LAYOUT_miryoku(
KC_Q, KC_W, KC_F, KC_P, KC_B, KC_J, KC_L, KC_U, KC_Y, KC_QUOT,
LGUI_T(KC_A), LALT_T(KC_R), LCTL_T(KC_S), LSFT_T(KC_T), KC_G, KC_K, LSFT_T(KC_N), LCTL_T(KC_E), LALT_T(KC_I), LGUI_T(KC_O),
KC_Z, ALGR_T(KC_X), KC_C, KC_D, KC_V, KC_M, KC_H, KC_COMM, ALGR_T(KC_DOT), KC_SLSH,
KC_NP, KC_NP, LT(MEDR, KC_ESC), LT(NAVR, KC_SPC), LT(MOUR, KC_TAB), LT(NSSL, KC_ENT), LT(NSL, KC_BSPC), LT(FUNL, KC_DEL), KC_NP, KC_NP
),
#elif defined MIRYOKU_ALPHAS_WORKMAN
[BASE] = LAYOUT_miryoku(
KC_Q, KC_D, KC_R, KC_W, KC_B, KC_J, KC_F, KC_U, KC_P, KC_QUOT,
LGUI_T(KC_A), LALT_T(KC_S), LCTL_T(KC_H), LSFT_T(KC_T), KC_G, KC_Y, LSFT_T(KC_N), LCTL_T(KC_E), LALT_T(KC_O), LGUI_T(KC_I),
KC_Z, ALGR_T(KC_X), KC_M, KC_C, KC_V, KC_K, KC_L, KC_COMM, ALGR_T(KC_DOT), KC_SLSH,
KC_NP, KC_NP, LT(MEDR, KC_ESC), LT(NAVR, KC_SPC), LT(MOUR, KC_TAB), LT(NSSL, KC_ENT), LT(NSL, KC_BSPC), LT(FUNL, KC_DEL), KC_NP, KC_NP
),
#else
[BASE] = LAYOUT_miryoku( [BASE] = LAYOUT_miryoku(
KC_Q, KC_W, KC_F, KC_P, KC_B, KC_J, KC_L, KC_U, KC_Y, KC_QUOT, KC_Q, KC_W, KC_F, KC_P, KC_B, KC_J, KC_L, KC_U, KC_Y, KC_QUOT,
LGUI_T(KC_A), LALT_T(KC_R), LCTL_T(KC_S), LSFT_T(KC_T), KC_G, KC_M, LSFT_T(KC_N), LCTL_T(KC_E), LALT_T(KC_I), LGUI_T(KC_O), LGUI_T(KC_A), LALT_T(KC_R), LCTL_T(KC_S), LSFT_T(KC_T), KC_G, KC_M, LSFT_T(KC_N), LCTL_T(KC_E), LALT_T(KC_I), LGUI_T(KC_O),
KC_Z, ALGR_T(KC_X), KC_C, KC_D, KC_V, KC_K, KC_H, KC_COMM, ALGR_T(KC_DOT), KC_SLSH, KC_Z, ALGR_T(KC_X), KC_C, KC_D, KC_V, KC_K, KC_H, KC_COMM, ALGR_T(KC_DOT), KC_SLSH,
KC_NP, KC_NP, LT(MEDR, KC_ESC), LT(NAVR, KC_SPC), LT(MOUR, KC_TAB), LT(NSSL, KC_ENT), LT(NSL, KC_BSPC), LT(FUNL, KC_DEL), KC_NP, KC_NP KC_NP, KC_NP, LT(MEDR, KC_ESC), LT(NAVR, KC_SPC), LT(MOUR, KC_TAB), LT(NSSL, KC_ENT), LT(NSL, KC_BSPC), LT(FUNL, KC_DEL), KC_NP, KC_NP
), ),
#endif
[NAVR] = LAYOUT_miryoku( [NAVR] = LAYOUT_miryoku(
KC_RST, KC_NA, KC_NA, KC_NA, KC_NA, KC_AGIN, KC_UNDO, KC_CUT, KC_COPY, KC_PSTE, KC_RST, KC_NA, KC_NA, KC_NA, KC_NA, KC_AGIN, KC_UNDO, KC_CUT, KC_COPY, KC_PSTE,
KC_LGUI, KC_LALT, KC_LCTL, KC_LSFT, KC_NA, KC_CAPS, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT, KC_LGUI, KC_LALT, KC_LCTL, KC_LSFT, KC_NA, KC_CAPS, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT,
@ -33,7 +56,13 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
KC_RST, KC_NA, KC_NA, KC_NA, KC_NA, KC_NU, KC_NU, KC_NU, KC_NU, KC_NU, KC_RST, KC_NA, KC_NA, KC_NA, KC_NA, KC_NU, KC_NU, KC_NU, KC_NU, KC_NU,
KC_LGUI, KC_LALT, KC_LCTL, KC_LSFT, KC_NA, KC_NU, KC_MS_L, KC_MS_D, KC_MS_U, KC_MS_R, KC_LGUI, KC_LALT, KC_LCTL, KC_LSFT, KC_NA, KC_NU, KC_MS_L, KC_MS_D, KC_MS_U, KC_MS_R,
KC_NA, KC_ALGR, KC_NA, KC_NA, KC_NA, KC_NU, KC_WH_L, KC_WH_D, KC_WH_U, KC_WH_R, KC_NA, KC_ALGR, KC_NA, KC_NA, KC_NA, KC_NU, KC_WH_L, KC_WH_D, KC_WH_U, KC_WH_R,
KC_NP, KC_NP, KC_NA, KC_NA, KC_NA, KC_BTN3, KC_BTN1, KC_BTN2, KC_NP, KC_NP KC_NP, KC_NP, KC_NA, KC_NA, KC_NA, KC_BTN1, KC_BTN3, KC_BTN2, KC_NP, KC_NP
),
[MBO] = LAYOUT_miryoku(
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
KC_NP, KC_NP, KC_TRNS, KC_TRNS, KC_TRNS, KC_BTN1, KC_BTN3, KC_BTN2, KC_NP, KC_NP
), ),
[MEDR] = LAYOUT_miryoku( [MEDR] = LAYOUT_miryoku(
KC_RST, KC_NA, KC_NA, KC_NA, KC_NA, KC_TOG, KC_MOD, KC_HUI, KC_SAI, KC_VAI, KC_RST, KC_NA, KC_NA, KC_NA, KC_NA, KC_TOG, KC_MOD, KC_HUI, KC_SAI, KC_VAI,

19
users/manna-harbour_miryoku/manna-harbour_miryoku.h Normal file
View file

@ -0,0 +1,19 @@
// generated from users/manna-harbour_miryoku/miryoku.org -*- buffer-read-only: t -*-
#pragma once
#include QMK_KEYBOARD_H
#define KC_NP KC_NO // key is not present
#define KC_NA KC_NO // present but not available for use
#define KC_NU KC_NO // available but not used
// non-KC_ keycodes
#define KC_RST RESET
#define KC_TOG RGB_TOG
#define KC_MOD RGB_MOD
#define KC_HUI RGB_HUI
#define KC_SAI RGB_SAI
#define KC_VAI RGB_VAI
enum layers { BASE, MBO, MEDR, NAVR, MOUR, NSSL, NSL, FUNL };

519
users/manna-harbour_miryoku/miryoku.org
View file

@ -1,33 +1,40 @@
#+Title: miryoku.org # After making changes to code or tables call org-babel-tangle (C-c C-v t).
#+Title: Miryoku [[https://raw.githubusercontent.com/manna-harbour/miryoku/master/miryoku-roa-32.png]]
[[https://raw.githubusercontent.com/manna-harbour/miryoku/master/kle-miryoku-keycodes.png]] [[https://raw.githubusercontent.com/manna-harbour/miryoku/master/kle-miryoku-keycodes.png]]
The miryoku layout is an ergonomic, minimal, orthogonal layout for ergo or ortho Miryoku is an ergonomic, minimal, orthogonal layout for ergo or ortho keyboards,
keyboards, implemented as part of the QMK firmware. The layout is maintained in implemented as part of the QMK firmware.
emacs org-mode tables and converted to QMK keymap data structures using embedded
python scripts. The layout is mapped onto keyboards with different physical
layouts as a subset without code duplication using the QMK userspace feature and
C macros. Versions of the layout can also be seen outside of the QMK source at
[[https://github.com/manna-harbour/miryoku/]].
After making changes here call org-babel-tangle (C-c C-v t). The layout is maintained in emacs org-mode tables and converted to QMK keymap
data structures using embedded python scripts. It is mapped onto keyboards with
different physical layouts as a subset without code duplication using the QMK
userspace feature and C macros.
* Contents Please see the [[https://github.com/manna-harbour/qmk_firmware/blob/miryoku/users/manna-harbour_miryoku/miryoku.org][development branch]] for any [[https://github.com/qmk/qmk_firmware/compare/master...manna-harbour:miryoku][updates not yet merged into QMK]].
Additional visualisations are provided outside QMK in the [[https://github.com/manna-harbour/miryoku/blob/master/README.org][Miryoku (Extras) repository]].
* Contents :TOC:
- [[#layout][Layout]] - [[#layout][Layout]]
- [[#general-principles][General Principles]]
- [[#details][Details]]
- [[#layers][Layers]]
- [[#code-generation][Code Generation]] - [[#code-generation][Code Generation]]
- [[#table-conversion-scripts][Table Conversion Scripts]]
- [[#data][Data]]
- [[#subset-mapping][Subset Mapping]] - [[#subset-mapping][Subset Mapping]]
- [[#related-documentation][Related Documentation]] - [[#userspace][Userspace]]
- [[#layouts][Layouts]]
- [[#keyboards][Keyboards]]
- [[#documentation][Documentation]]
- [[#qmk][QMK]]
- [[#org-mode][Org Mode]]
- [[#contact][Contact]]
* Layout * Layout
:PROPERTIES:
:CUSTOM_ID: layout
:END:
** Info ** General Principles
*** General Principles
- Use layers instead of reaching. - Use layers instead of reaching.
- Use both hands instead of contortions. - Use both hands instead of contortions.
@ -36,29 +43,29 @@ After making changes here call org-babel-tangle (C-c C-v t).
- Avoid unnecessary complication. - Avoid unnecessary complication.
*** Specifics ** Details
- 5 columns, 3 rows, 3 thumb keys, 2 hands. - 5 columns, 3 rows, 3 thumb keys, 2 hands.
- Can be used on almost any split or non-split ergo or ortho keyboard. - Can be used on almost any split or non-split ergo or ortho keyboard.
- Includes all keys found on a US layout TKL keyboard, plus media keys and - Includes all keys found on a US layout TKL keyboard, plus media keys and mouse
mouse emulation. emulation.
- Home row is the middle row, home thumb key is the middle thumb key. - Home row is the middle row, home thumb key is the middle thumb key.
- Maximum 1-u movement from home position for fingers and thumbs, and only - Maximum 1-u movement from home position for fingers and thumbs, and only along
along one axis (except for the inner index finger column which is one axis (except for the inner index finger column which is deprioritised
deprioritised compared with the home columns). compared with the home columns).
- Dual-function modifiers on home row, mirrored on both hands. - Dual-function modifiers on home row, mirrored on both hands.
- Dual-function layer change on thumbs. - Dual-function layer change on thumbs.
- Layers are designed orthogonally with a single purpose per hand and are - Layers are designed orthogonally with a single purpose per hand and are
accessed by holding a thumb key on the opposite hand. accessed by holding a thumb key on the opposite hand.
- All layers on the same hand are based on the same basic key arrangement. - All layers on the same hand are based on the same basic key arrangement.
- Holding layer change and modifiers on one hand combined with a single key - Holding layer change and modifiers on one hand combined with a single key
press on the other hand can produce any combination of modifiers and press on the other hand can produce any combination of modifiers and single
single keys without any finger contortions. keys without any finger contortions.
- Single function mods are also defined on layers on the same hand as the - Single function mods are also defined on layers on the same hand as the layer
layer change thumb key so layer change and mods can be held in any order change thumb key so layer change and mods can be held in any order or
or simultaneously without race conditions. simultaneously without race conditions.
- As mods are only enabled on the opposite hand, auto-repeat is available on - As mods are only enabled on the opposite hand, auto-repeat is available on the
the home row on layers for use with cursor and mouse keys. home row on layers for use with cursor and mouse keys.
- Tap-hold auto-repeat is disabled to permit faster tap-hold switching on - Tap-hold auto-repeat is disabled to permit faster tap-hold switching on
thumbs, but thumb tap keys are mirrored onto some layers for use with thumbs, but thumb tap keys are mirrored onto some layers for use with
auto-repeat. On other layers thumb keys are redefined with important auto-repeat. On other layers thumb keys are redefined with important
@ -86,16 +93,21 @@ into the corresponding tap-hold keycodes for mods and layer change. RST and
mods will be available on sub layers on the same hand as the layer change thumb mods will be available on sub layers on the same hand as the layer change thumb
key. Unknown names are considered to be layer names. key. Unknown names are considered to be layer names.
Base layer alphas are Colemak DHm. Thumb keys are backspace, enter, delete on Base layer alphas are Colemak-DHm. Thumb keys are backspace, enter, delete on
the right and space, tab, escape on the left. Dot, comma and apostrophe are the right and space, tab, escape on the left. Dot, comma and apostrophe are
included for prose, dot and slash for file and directory names. included for prose, dot and slash for file and directory names.
#+NAME: tap **** Tap
#+NAME: colemakdhm
| Q | W | F | P | B | J | L | U | Y | ' | | Q | W | F | P | B | J | L | U | Y | ' |
| A | R | S | T | G | M | N | E | I | O | | A | R | S | T | G | M | N | E | I | O |
| Z | X | C | D | V | K | H | , | . | / | | Z | X | C | D | V | K | H | , | . | / |
| NP | NP | ESC | SPC | TAB | ENT | BSPC | DEL | NP | NP | | NP | NP | ESC | SPC | TAB | ENT | BSPC | DEL | NP | NP |
**** Hold
#+NAME: hold #+NAME: hold
| RST | | | | | | | | | RST | | RST | | | | | | | | | RST |
| LGUI | LALT | LCTL | LSFT | | | LSFT | LCTL | LALT | LGUI | | LGUI | LALT | LCTL | LSFT | | | LSFT | LCTL | LALT | LGUI |
@ -103,6 +115,52 @@ included for prose, dot and slash for file and directory names.
| NP | NP | MEDR | NAVR | MOUR | NSSL | NSL | FUNL | NP | NP | | NP | NP | MEDR | NAVR | MOUR | NSSL | NSL | FUNL | NP | NP |
**** Alternative Base Layer Alphas
Alternative base layer alphas are provided. To select, append
e.g. ~MIRYOKU_ALPHAS=QWERTY~ to the make command line when building.
***** QWERTY (QWERTY)
#+NAME: qwerty
| Q | W | E | R | T | Y | U | I | O | P |
| A | S | D | F | G | H | J | K | L | ' |
| Z | X | C | V | B | N | M | , | . | / |
| NP | NP | ESC | SPC | TAB | ENT | BSPC | DEL | NP | NP |
***** Dvorak (DVORAK)
#+NAME: dvorak
| ' | , | . | P | Y | F | G | C | R | L |
| A | O | E | U | I | D | H | T | N | S |
| / | Q | J | K | X | B | M | W | V | Z |
| NP | NP | ESC | SPC | TAB | ENT | BSPC | DEL | NP | NP |
***** Colemak (COLEMAK)
#+NAME: colemak
| Q | W | F | P | G | J | L | U | Y | ' |
| A | R | S | T | D | H | N | E | I | O |
| Z | X | C | V | B | K | M | , | . | / |
| NP | NP | ESC | SPC | TAB | ENT | BSPC | DEL | NP | NP |
***** Colemak Mod-DH (COLEMAKDH)
#+NAME: colemakdh
| Q | W | F | P | B | J | L | U | Y | ' |
| A | R | S | T | G | K | N | E | I | O |
| Z | X | C | D | V | M | H | , | . | / |
| NP | NP | ESC | SPC | TAB | ENT | BSPC | DEL | NP | NP |
***** Workman (WORKMAN)
#+NAME: workman
| Q | D | R | W | B | J | F | U | P | ' |
| A | S | H | T | G | Y | N | E | O | I |
| Z | X | M | C | V | K | L | , | . | / |
| NP | NP | ESC | SPC | TAB | ENT | BSPC | DEL | NP | NP |
*** Navigation (NAVR) *** Navigation (NAVR)
Primary right-hand layer (left home thumb) is navigation and editing. Cursor Primary right-hand layer (left home thumb) is navigation and editing. Cursor
@ -120,15 +178,27 @@ layer to avoid having to layer change mid edit and to enable auto-repeat.
*** Mouse (MOUR) *** Mouse (MOUR)
Secondary RH layer is mouse emulation. Mouse movement mirrors cursor navigation Secondary RH layer is mouse emulation. Mouse movement mirrors cursor navigation
on home and wheel mirrors line / page movement below. Buttons are on the on home and wheel mirrors line / page movement below. Buttons are on the thumbs
thumbs. Mouse movement, click, and drag with modifiers can be performed from (L, M, R). Mouse movement, click, and drag with modifiers can be performed from
the home position. Unused keys are available for other related functions. the home position. Unused keys are available for other related functions.
#+NAME: mour #+NAME: mour
| | | | | | | | | | | |
| | MS_L | MS_D | MS_U | MS_R | | | MS_L | MS_D | MS_U | MS_R |
| | WH_L | WH_D | WH_U | WH_R | | | WH_L | WH_D | WH_U | WH_R |
| BTN3 | BTN1 | BTN2 | NP | NP | | BTN1 | BTN3 | BTN2 | NP | NP |
**** Mouse Buttons Overlay (MBO)
Available for automatic activation depending on keyboard hardware and
configuration. Not activated manually.
#+NAME: mbo
| | | | | | | | | | |
| | | | | | | | | | |
| | | | | | | | | | |
| NP | NP | | | | BTN1 | BTN3 | BTN2 | NP | NP |
*** Media (MEDR) *** Media (MEDR)
@ -211,9 +281,6 @@ Duplicate base layer tap keys on thumbs rather than trans to enable auto-repeat.
* Code Generation * Code Generation
:PROPERTIES:
:CUSTOM_ID: code-generation
:END:
** Table Conversion Scripts ** Table Conversion Scripts
@ -222,14 +289,14 @@ Duplicate base layer tap keys on thumbs rather than trans to enable auto-repeat.
Produce base layer from separate tap and hold tables. Produce base layer from separate tap and hold tables.
#+NAME: table-layout-taphold #+NAME: table-layout-taphold
#+BEGIN_SRC python :var tap_table=tap :var hold_table=hold :var symbol_names_table=symbol-names :var mods_list=mods :tangle no :results verbatim #+BEGIN_SRC python :var layer_name="BASE" :var tap_table=colemakdhm :var hold_table=hold :var symbol_names_table=symbol-names :var mods_list=mods :tangle no :results verbatim
width = 19 width = 19
mods_dict = dict.fromkeys(mods_list) mods_dict = dict.fromkeys(mods_list)
symbol_names_dict = {} symbol_names_dict = {}
for symbol, name, shifted_symbol, shifted_name in symbol_names_table: for symbol, name, shifted_symbol, shifted_name in symbol_names_table:
symbol_names_dict[symbol] = name symbol_names_dict[symbol] = name
symbol_names_dict[shifted_symbol] = shifted_name symbol_names_dict[shifted_symbol] = shifted_name
results = ' [BASE] = LAYOUT_miryoku(\n' results = ' [' + layer_name + '] = LAYOUT_miryoku(\n'
for tap_row, hold_row in map(None, tap_table, hold_table): for tap_row, hold_row in map(None, tap_table, hold_table):
results += ' ' results += ' '
for tap, hold in map(None, tap_row, hold_row): for tap, hold in map(None, tap_row, hold_row):
@ -254,7 +321,7 @@ return results
: [BASE] = LAYOUT_miryoku( : [BASE] = LAYOUT_miryoku(
: KC_Q, KC_W, KC_F, KC_P, KC_B, KC_J, KC_L, KC_U, KC_Y, KC_QUOT, : KC_Q, KC_W, KC_F, KC_P, KC_B, KC_J, KC_L, KC_U, KC_Y, KC_QUOT,
: LGUI_T(KC_A), LALT_T(KC_R), LCTL_T(KC_S), LSFT_T(KC_T), KC_G, KC_M, LSFT_T(KC_N), LCTL_T(KC_E), LALT_T(KC_I), LGUI_T(KC_O), : LGUI_T(KC_A), LALT_T(KC_R), LCTL_T(KC_S), LSFT_T(KC_T), KC_G, KC_M, LSFT_T(KC_N), LCTL_T(KC_E), LALT_T(KC_I), LGUI_T(KC_O),
: KC_Z, KC_X, KC_C, KC_D, KC_V, KC_K, KC_H, KC_COMM, KC_DOT, KC_SLSH, : KC_Z, ALGR_T(KC_X), KC_C, KC_D, KC_V, KC_K, KC_H, KC_COMM, ALGR_T(KC_DOT), KC_SLSH,
: KC_NP, KC_NP, LT(MEDR, KC_ESC), LT(NAVR, KC_SPC), LT(MOUR, KC_TAB), LT(NSSL, KC_ENT), LT(NSL, KC_BSPC), LT(FUNL, KC_DEL), KC_NP, KC_NP : KC_NP, KC_NP, LT(MEDR, KC_ESC), LT(NAVR, KC_SPC), LT(MOUR, KC_TAB), LT(NSSL, KC_ENT), LT(NSL, KC_BSPC), LT(FUNL, KC_DEL), KC_NP, KC_NP
: ) : )
@ -314,6 +381,43 @@ return results
: ) : )
*** table-layout-full
Produce full layer from single table. Fill for unused keys is configurable.
#+NAME: table-layout-full
#+BEGIN_SRC python :var table=mbo :var layer_name="MBO" :var fill="TRNS" :var symbol_names_table=symbol-names :tangle no :results verbatim
width = 9
symbol_names_dict = {}
for symbol, name, shifted_symbol, shifted_name in symbol_names_table:
symbol_names_dict[symbol] = name
symbol_names_dict[shifted_symbol] = shifted_name
results = ' [' + layer_name + '] = LAYOUT_miryoku(\n'
for row in table:
results += ' '
for key in row:
if key == '':
code = fill
elif key in symbol_names_dict:
code = symbol_names_dict[key]
else:
code = key
code = 'KC_' + str(code)
results += (code + ', ').ljust(width)
results = results.rstrip(' ') + '\n'
results = results.rstrip('\n, ') + '\n )'
return results
#+END_SRC
#+RESULTS: table-layout-full
: [MBO] = LAYOUT_miryoku(
: KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
: KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
: KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
: KC_NP, KC_NP, KC_TRNS, KC_TRNS, KC_TRNS, KC_BTN1, KC_BTN3, KC_BTN2, KC_NP, KC_NP
: )
*** table-enums *** table-enums
Produce layer enums from layer names in hold table. Produce layer enums from layer names in hold table.
@ -321,7 +425,7 @@ Produce layer enums from layer names in hold table.
#+NAME: table-enums #+NAME: table-enums
#+BEGIN_SRC python :var hold_table=hold :var mods_list=mods :tangle no #+BEGIN_SRC python :var hold_table=hold :var mods_list=mods :tangle no
mods_dict = dict.fromkeys(mods_list) mods_dict = dict.fromkeys(mods_list)
results = 'enum layers { BASE, ' results = 'enum layers { BASE, MBO, '
for hold_row in hold_table: for hold_row in hold_table:
for hold in hold_row: for hold in hold_row:
if hold not in mods_dict and hold != '' and hold != 'NP' and hold != 'RST': if hold not in mods_dict and hold != '' and hold != 'NP' and hold != 'RST':
@ -331,7 +435,7 @@ return results
#+END_SRC #+END_SRC
#+RESULTS: table-enums #+RESULTS: table-enums
: enum layers { BASE, MEDR, NAVR, MOUR, NSSL, NSL, FUNL }; : enum layers { BASE, MBO, MEDR, NAVR, MOUR, NSSL, NSL, FUNL };
** Data ** Data
@ -376,8 +480,6 @@ Modifiers usable in hold table. Need to have the same name for KC_ and _T versi
- ALGR - ALGR
** Other
*** header *** header
Header for tangled src files. Header for tangled src files.
@ -389,25 +491,27 @@ generated from users/manna-harbour_miryoku/miryoku.org -*- buffer-read-only: t
* Subset Mapping * Subset Mapping
:PROPERTIES:
:CUSTOM_ID: subset-mapping The keymap, build options, and configuration are shared between keyboards. The
:END: layout is mapped onto keyboards with different physical layouts as a subset.
** Userspace ** Userspace
The keymap and configuration are shared between keyboards. The keymap is The keymap is defined for LAYOUT_miryoku which is 10x4, with the outer 2
defined for LAYOUT_miryoku which is 10x4, with the outer 2 positions on the positions on the bottom row unused and the rest of the bottom row being the
bottom row unused and the rest of the bottom row are the thumb keys. thumb keys.
*** manna-harbour_miryoku.h
*** manna-harbour_miryoku.c Keymap-related definitions. Included from manna-harbour_miryoku.c. Can be
included from keymap or layout keymap.c if needed.
Contains the keymap. Included from keymap.c [[./manna-harbour_miryoku.h][users/manna-harbour_miryoku/manna-harbour_miryoku.h]]
#+BEGIN_SRC C :noweb yes :padline no :tangle manna-harbour_miryoku.h
[[./manna-harbour_miryoku.c][users/manna-harbour_miryoku/manna-harbour_miryoku.c]]
#+BEGIN_SRC C :noweb yes :padline no :tangle manna-harbour_miryoku.c
// <<header>> // <<header>>
#pragma once
#include QMK_KEYBOARD_H #include QMK_KEYBOARD_H
#define KC_NP KC_NO // key is not present #define KC_NP KC_NO // key is not present
@ -423,11 +527,36 @@ Contains the keymap. Included from keymap.c
#define KC_VAI RGB_VAI #define KC_VAI RGB_VAI
<<table-enums()>> <<table-enums()>>
#+END_SRC
*** manna-harbour_miryoku.c
Contains the keymap. Added from rules.mk.
[[./manna-harbour_miryoku.c][users/manna-harbour_miryoku/manna-harbour_miryoku.c]]
#+BEGIN_SRC C :noweb yes :padline no :tangle manna-harbour_miryoku.c
// <<header>>
#include "manna-harbour_miryoku.h"
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
<<table-layout-taphold()>>, #if defined MIRYOKU_ALPHAS_QWERTY
<<table-layout-taphold(layer_name="BASE", tap_table=qwerty, hold_table=hold)>>,
#elif defined MIRYOKU_ALPHAS_DVORAK
<<table-layout-taphold(layer_name="BASE", tap_table=dvorak, hold_table=hold)>>,
#elif defined MIRYOKU_ALPHAS_COLEMAK
<<table-layout-taphold(layer_name="BASE", tap_table=colemak, hold_table=hold)>>,
#elif defined MIRYOKU_ALPHAS_COLEMAKDH
<<table-layout-taphold(layer_name="BASE", tap_table=colemakdh, hold_table=hold)>>,
#elif defined MIRYOKU_ALPHAS_WORKMAN
<<table-layout-taphold(layer_name="BASE", tap_table=workman, hold_table=hold)>>,
#else
<<table-layout-taphold(layer_name="BASE", tap_table=colemakdhm, hold_table=hold)>>,
#endif
<<table-layout-half(layer_name="NAVR", half_table=navr)>>, <<table-layout-half(layer_name="NAVR", half_table=navr)>>,
<<table-layout-half(layer_name="MOUR", half_table=mour)>>, <<table-layout-half(layer_name="MOUR", half_table=mour)>>,
<<table-layout-full(layer_name="MBO", table=mbo, fill="TRNS")>>,
<<table-layout-half(layer_name="MEDR", half_table=medr)>>, <<table-layout-half(layer_name="MEDR", half_table=medr)>>,
<<table-layout-half(layer_name="FUNL", half_table=funl)>>, <<table-layout-half(layer_name="FUNL", half_table=funl)>>,
<<table-layout-half(layer_name="NSL", half_table=nsl)>>, <<table-layout-half(layer_name="NSL", half_table=nsl)>>,
@ -446,6 +575,9 @@ Config options. Automatically included.
#pragma once #pragma once
// default but important
#define TAPPING_TERM 200
// Prevent normal rollover on alphas from accidentally triggering mods. // Prevent normal rollover on alphas from accidentally triggering mods.
#define IGNORE_MOD_TAP_INTERRUPT #define IGNORE_MOD_TAP_INTERRUPT
@ -455,6 +587,18 @@ Config options. Automatically included.
// Recommended for heavy chording. // Recommended for heavy chording.
#define QMK_KEYS_PER_SCAN 4 #define QMK_KEYS_PER_SCAN 4
// Mouse key speed and acceleration.
#undef MOUSEKEY_DELAY
#define MOUSEKEY_DELAY 0
#undef MOUSEKEY_INTERVAL
#define MOUSEKEY_INTERVAL 16
#undef MOUSEKEY_WHEEL_DELAY
#define MOUSEKEY_WHEEL_DELAY 0
#undef MOUSEKEY_MAX_SPEED
#define MOUSEKEY_MAX_SPEED 6
#undef MOUSEKEY_TIME_TO_MAX
#define MOUSEKEY_TIME_TO_MAX 64
#+END_SRC #+END_SRC
@ -466,10 +610,20 @@ Build options. Automatically included.
#+BEGIN_SRC makefile :noweb yes :padline no :tangle rules.mk #+BEGIN_SRC makefile :noweb yes :padline no :tangle rules.mk
# <<header>> # <<header>>
MOUSEKEY_ENABLE = yes # Mouse keys(+4700) MOUSEKEY_ENABLE = yes # Mouse keys
EXTRAKEY_ENABLE = yes # Audio control and System control(+450) EXTRAKEY_ENABLE = yes # Audio control and System control
EXTRAFLAGS += -flto # Link Time Optimization to reduce code size, 31358->28034/28672
SRC += manna-harbour_miryoku.c # keymap
# select alternative base layer alphas
ifneq ($(strip $(MIRYOKU_ALPHAS)),)
OPT_DEFS += -DMIRYOKU_ALPHAS_$(MIRYOKU_ALPHAS)
endif
# select alternative subset mappings
ifneq ($(strip $(MIRYOKU_MAPPING)),)
OPT_DEFS += -DMIRYOKU_MAPPING_$(MIRYOKU_MAPPING)
endif
#+END_SRC #+END_SRC
@ -477,7 +631,9 @@ EXTRAFLAGS += -flto # Link Time Optimization to reduce code size, 31358->28
To use the keymap on a keyboard supporting the layouts feature, LAYOUT_miryoku To use the keymap on a keyboard supporting the layouts feature, LAYOUT_miryoku
is defined as a macro mapping onto the layout's own LAYOUT macro, leaving the is defined as a macro mapping onto the layout's own LAYOUT macro, leaving the
unused keys as KC_NO. The userspace keymap is then included. unused keys as KC_NO.
The following are example layouts.
*** ergodox *** ergodox
@ -486,10 +642,26 @@ secondary thumb keys are the inner and outer 2u thumb keys and the tertiary
thumb key is the innermost key of the partial bottom row. The remaining keys thumb key is the innermost key of the partial bottom row. The remaining keys
are unused. are unused.
[[../../layouts/community/ergodox/manna-harbour_miryoku/keymap.c][layouts/community/ergodox/manna-harbour_miryoku/keymap.c]] [[https://raw.githubusercontent.com/manna-harbour/miryoku/master/kle-miryoku-mapping-ergodox.png]]
#+BEGIN_SRC C :noweb yes :padline no :tangle ../../layouts/community/ergodox/manna-harbour_miryoku/keymap.c
To build for any keyboard using the this layout (ergodone, ergodox_ez,
ergodox_infinity, hotdox) e.g. the ergodox_ez,
#+BEGIN_SRC sh :tangle no
make ergodox_ez:manna-harbour_miryoku:flash
#+END_SRC
**** config.h
Contains subset mapping.
[[../../layouts/community/ergodox/manna-harbour_miryoku/config.h][layouts/community/ergodox/manna-harbour_miryoku/config.h]]
#+BEGIN_SRC C :noweb yes :padline no :tangle ../../layouts/community/ergodox/manna-harbour_miryoku/config.h
// <<header>> // <<header>>
#pragma once
#define LAYOUT_miryoku(\ #define LAYOUT_miryoku(\
K00, K01, K02, K03, K04, K05, K06, K07, K08, K09,\ K00, K01, K02, K03, K04, K05, K06, K07, K08, K09,\
K10, K11, K12, K13, K14, K15, K16, K17, K18, K19,\ K10, K11, K12, K13, K14, K15, K16, K17, K18, K19,\
@ -506,32 +678,62 @@ KC_NO, KC_NO, KC_NO, KC_NO, K32, K37, KC_NO, KC_
KC_NO, KC_NO, \ KC_NO, KC_NO, \
K33, K34, KC_NO, KC_NO, K35, K36 \ K33, K34, KC_NO, KC_NO, K35, K36 \
) )
#include "manna-harbour_miryoku.c"
#+END_SRC #+END_SRC
To build for any keyboard using the this layout (ergodone, ergodox_ez,
ergodox_infinity, hotdox) e.g. the ergodox_ez,
#+BEGIN_SRC sh :tangle no **** keymap.c
cd ../.. && make ergodox_ez:manna-harbour_miryoku:teensy
Required by the build system.
[[../../layouts/community/ergodox/manna-harbour_miryoku/keymap.c][layouts/community/ergodox/manna-harbour_miryoku/keymap.c]]
#+BEGIN_SRC C :noweb yes :padline no :tangle ../../layouts/community/ergodox/manna-harbour_miryoku/keymap.c
// <<header>>
#+END_SRC #+END_SRC
*** ortho_4x12 *** ortho_4x12
For the ortho_4x12 layout, the right half as is as follows: The rightmost column For the ortho_4x12 layout, the middle two columns, and the 2 keys on each end of
bottom 3 rows is the pinkie column. The middle 4 columns top 3 rows are for the the bottom row are unused. This allows the hands to be positioned without ulnar
remaining fingers. The pinkie column is one row lower than the other columns to deviation of the wrists.
provide some column stagger on ortho keyboards. The bottom row left 3 columns
are the thumb keys. The remaining keys are unused.
[[../../layouts/community/ortho_4x12/manna-harbour_miryoku/keymap.c][layouts/community/ortho_4x12/manna-harbour_miryoku/keymap.c]] In the implementation, the 2 unused middle columns bottom row keys are mapped as
#+BEGIN_SRC C :noweb yes :padline no :tangle ../../layouts/community/ortho_4x12/manna-harbour_miryoku/keymap.c duplicates of their adjacent keys to support alternative bottom row physical
layouts including 1x2uC (MIT), 1x2uR, 1x2uL, and 2x2u.
[[https://raw.githubusercontent.com/manna-harbour/miryoku/master/kle-miryoku-mapping-ortho_4x12.png]]
For split keyboards using this layout the halves can be positioned and rotated
for each hand and so an alternative mapping is provided. The right half is as
follows: The rightmost column bottom 3 keys is the pinkie column. The middle 4
columns top 3 rows are for the remaining fingers. The pinkie column is one row
lower than the other columns to provide some column stagger. The bottom row
left 3 keys are the thumb keys. The remaining keys are unused. To select this
mapping, append ~MIRYOKU_MAPPING=SPLIT~ to the make command line when building.
[[https://raw.githubusercontent.com/manna-harbour/miryoku/master/kle-miryoku-mapping-ortho_4x12-split.png]]
To build for any keyboard using this layout (4x4, nori, chimera_ls, contra,
divergetm2, jj40, lets_split, lets_split_eh, meira, niu_mini, planck, telophase,
vitamins_included, zinc, zlant, ortho48, kbd4x, levinson, wavelet, plaid):
#+BEGIN_SRC sh :tangle no
make planck/rev6:manna-harbour_miryoku:flash # planck
make keebio/levinson:manna-harbour_miryoku:flash MIRYOKU_MAPPING=SPLIT # levinson
#+END_SRC
**** config.h
Contains subset mapping.
[[../../layouts/community/ortho_4x12/manna-harbour_miryoku/config.h][layouts/community/ortho_4x12/manna-harbour_miryoku/config.h]]
#+BEGIN_SRC C :noweb yes :padline no :tangle ../../layouts/community/ortho_4x12/manna-harbour_miryoku/config.h
// <<header>> // <<header>>
#pragma once
#if defined MIRYOKU_MAPPING_SPLIT
#define LAYOUT_miryoku(\ #define LAYOUT_miryoku(\
K00, K01, K02, K03, K04, K05, K06, K07, K08, K09,\ K00, K01, K02, K03, K04, K05, K06, K07, K08, K09,\
K10, K11, K12, K13, K14, K15, K16, K17, K18, K19,\ K10, K11, K12, K13, K14, K15, K16, K17, K18, K19,\
@ -544,18 +746,30 @@ K00, K11, K12, K13, K14, KC_NO, KC_NO, K15, K16, K17, K18, K09
K10, K21, K22, K23, K24, KC_NO, KC_NO, K25, K26, K27, K28, K19,\ K10, K21, K22, K23, K24, KC_NO, KC_NO, K25, K26, K27, K28, K19,\
K20, KC_NO, KC_NO, K32, K33, K34, K35, K36, K37, KC_NO, KC_NO, K29\ K20, KC_NO, KC_NO, K32, K33, K34, K35, K36, K37, KC_NO, KC_NO, K29\
) )
#else
#include "manna-harbour_miryoku.c" #define LAYOUT_miryoku(\
K00, K01, K02, K03, K04, K05, K06, K07, K08, K09,\
K10, K11, K12, K13, K14, K15, K16, K17, K18, K19,\
K20, K21, K22, K23, K24, K25, K26, K27, K28, K29,\
N30, N31, K32, K33, K34, K35, K36, K37, N38, N39\
)\
LAYOUT_ortho_4x12(\
K00, K01, K02, K03, K04, KC_NO, KC_NO, K05, K06, K07, K08, K09,\
K10, K11, K12, K13, K14, KC_NO, KC_NO, K15, K16, K17, K18, K19,\
K20, K21, K22, K23, K24, KC_NO, KC_NO, K25, K26, K27, K28, K29,\
KC_NO, KC_NO, K32, K33, K34, K34, K35, K35, K36, K37, KC_NO, KC_NO\
)
#endif
#+END_SRC #+END_SRC
To build for any keyboard using this layout (4x4, nori, chimera_ls, contra,
divergetm2, jj40, lets_split, lets_split_eh, meira, niu_mini, planck, telophase,
vitamins_included, zinc, zlant, ortho48, kbd4x, levinson, wavelet, plaid)
e.g. the levinson,
#+BEGIN_SRC sh :tangle no **** keymap.c
make keebio/levinson:manna-harbour_miryoku:avrdude
Required by the build system.
[[../../layouts/community/ortho_4x12/manna-harbour_miryoku/keymap.c][layouts/community/ortho_4x12/manna-harbour_miryoku/keymap.c]]
#+BEGIN_SRC C :noweb yes :padline no :tangle ../../layouts/community/ortho_4x12/manna-harbour_miryoku/keymap.c
// <<header>>
#+END_SRC #+END_SRC
@ -563,18 +777,30 @@ make keebio/levinson:manna-harbour_miryoku:avrdude
To use the keymap on a keyboard which does not support the layouts feature, To use the keymap on a keyboard which does not support the layouts feature,
LAYOUT_miryoku is defined as a macro mapping onto the keyboard's own LAYOUT LAYOUT_miryoku is defined as a macro mapping onto the keyboard's own LAYOUT
macro, leaving the unused keys as KC_NO. The userspace keymap is then included. macro, leaving the unused keys as KC_NO.
The following are example keyboards.
*** crkbd *** crkbd
The outer columns are unused. The outer columns are unused.
**** keymap.c To build for this keyboard,
[[../../keyboards/crkbd/keymaps/manna-harbour_miryoku/keymap.c][keyboards/crkbd/keymaps/manna-harbour_miryoku/keymap.c]] #+BEGIN_SRC sh :tangle no
#+BEGIN_SRC C :noweb yes :padline no :tangle ../../keyboards/crkbd/keymaps/manna-harbour_miryoku/keymap.c make crkbd:manna-harbour_miryoku:flash
#+END_SRC
**** config.h
Contains subset mapping.
[[../../keyboards/crkbd/keymaps/manna-harbour_miryoku/config.h][keyboards/crkbd/keymaps/manna-harbour_miryoku/config.h]]
#+BEGIN_SRC C :noweb yes :padline no :tangle ../../keyboards/crkbd/keymaps/manna-harbour_miryoku/config.h
// <<header>> // <<header>>
#pragma once
#define LAYOUT_miryoku( \ #define LAYOUT_miryoku( \
K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, \ K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, \
K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, \ K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, \
@ -587,114 +813,33 @@ KC_NO, K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, KC_
KC_NO, K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, KC_NO, \ KC_NO, K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, KC_NO, \
K32, K33, K34, K35, K36, K37 \ K32, K33, K34, K35, K36, K37 \
) )
#include "manna-harbour_miryoku.c"
#ifdef SSD1306OLED
#include "ssd1306.h"
void matrix_init_user(void) {
iota_gfx_init(!has_usb()); // turns on the display
}
// When add source files to SRC in rules.mk, you can use functions.
const char *read_logo(void);
void matrix_scan_user(void) {
iota_gfx_task();
}
void matrix_render_user(struct CharacterMatrix *matrix) {
if (host_keyboard_leds() & (1<<USB_LED_CAPS_LOCK)) {
matrix_write(matrix, read_logo());
}
}
void matrix_update(struct CharacterMatrix *dest, const struct CharacterMatrix *source) {
if (memcmp(dest->display, source->display, sizeof(dest->display))) {
memcpy(dest->display, source->display, sizeof(dest->display));
dest->dirty = true;
}
}
void iota_gfx_task_user(void) {
struct CharacterMatrix matrix;
matrix_clear(&matrix);
matrix_render_user(&matrix);
matrix_update(&display, &matrix);
}
#endif //SSD1306OLED
#+END_SRC #+END_SRC
**** config.h **** keymap.c
[[../../keyboards/crkbd/keymaps/manna-harbour_miryoku/config.h][keyboards/crkbd/keymaps/manna-harbour_miryoku/config.h]] Required by the build system.
#+BEGIN_SRC C :noweb yes :padline no :tangle ../../keyboards/crkbd/keymaps/manna-harbour_miryoku/config.h
[[../../keyboards/crkbd/keymaps/manna-harbour_miryoku/keymap.c][keyboards/crkbd/keymaps/manna-harbour_miryoku/keymap.c]]
#+BEGIN_SRC C :noweb yes :padline no :tangle ../../keyboards/crkbd/keymaps/manna-harbour_miryoku/keymap.c
// <<header>> // <<header>>
#pragma once
#define EE_HANDS
#ifdef RGB_MATRIX_ENABLE
#define RGB_MATRIX_KEYPRESSES // reacts to keypresses
#define RGB_DISABLE_WHEN_USB_SUSPENDED true // turn off effects when suspended
#define RGB_MATRIX_FRAMEBUFFER_EFFECTS
#define RGB_MATRIX_MAXIMUM_BRIGHTNESS 150 // limits maximum brightness of LEDs to 150 out of 255. Higher may cause the controller to crash.
#define RGB_MATRIX_HUE_STEP 8
#define RGB_MATRIX_SAT_STEP 8
#define RGB_MATRIX_VAL_STEP 8
#define RGB_MATRIX_SPD_STEP 10
#endif
#define SSD1306OLED // old oled driver
#+END_SRC #+END_SRC
**** rules.mk * Documentation
[[../../keyboards/crkbd/keymaps/manna-harbour_miryoku/rules.mk][keyboards/crkbd/keymaps/manna-harbour_miryoku/rules.mk]]
#+BEGIN_SRC C :noweb yes :padline no :tangle ../../keyboards/crkbd/keymaps/manna-harbour_miryoku/rules.mk
# <<header>>
RGB_MATRIX_ENABLE = WS2812
# old oled driver
SRC += ./lib/glcdfont.c \
./lib/logo_reader.c
#+END_SRC
To build for this keyboard,
#+BEGIN_SRC sh :tangle no
cd ../.. && make crkbd:manna-harbour_miryoku:flash
#+END_SRC
* Related Documentation
:PROPERTIES:
:CUSTOM_ID: related-documentation
:END:
** QMK ** QMK
- https://qmk.fm/ - https://qmk.fm/
- https://docs.qmk.fm/#/getting_started_introduction - https://docs.qmk.fm/#/getting_started_introduction
- https://docs.qmk.fm/#/hardware_keyboard_guidelines
- https://docs.qmk.fm/#/config_options - https://docs.qmk.fm/#/config_options
- https://docs.qmk.fm/#/keycodes - https://docs.qmk.fm/#/keycodes
- https://docs.qmk.fm/#/feature_advanced_keycodes - https://docs.qmk.fm/#/feature_advanced_keycodes
- https://docs.qmk.fm/#/feature_layers
- https://docs.qmk.fm/#/mod_tap
- https://docs.qmk.fm/#/feature_layouts - https://docs.qmk.fm/#/feature_layouts
- https://docs.qmk.fm/#/feature_userspace - https://docs.qmk.fm/#/feature_userspace
- https://docs.qmk.fm/#/feature_mouse_keys
- https://docs.qmk.fm/#/getting_started_make_guide - https://docs.qmk.fm/#/getting_started_make_guide
@ -703,3 +848,13 @@ cd ../.. && make crkbd:manna-harbour_miryoku:flash
- https://orgmode.org/ - https://orgmode.org/
- https://orgmode.org/manual/Tables.html - https://orgmode.org/manual/Tables.html
- https://orgmode.org/manual/Working-with-Source-Code.html - https://orgmode.org/manual/Working-with-Source-Code.html
* Contact
For issues with this branch, or to request support for additional base layer
alphas, layouts, or keyboards, please [[https://github.com/manna-harbour/qmk_firmware/issues/new][open an issue]].
For more general discussion, please join a relevant [[https://www.reddit.com/user/manna_harbour/posts/?sort=new][recent thread]] or [[https://www.reddit.com/message/compose/?to=manna_harbour][send a PM]].
[[https://github.com/manna-harbour][https://raw.githubusercontent.com/manna-harbour/miryoku/master/manna-harbour-boa-32.png]]

17
users/manna-harbour_miryoku/rules.mk
View file

@ -1,5 +1,16 @@
# generated from users/manna-harbour_miryoku/miryoku.org -*- buffer-read-only: t -*- # generated from users/manna-harbour_miryoku/miryoku.org -*- buffer-read-only: t -*-
MOUSEKEY_ENABLE = yes # Mouse keys(+4700) MOUSEKEY_ENABLE = yes # Mouse keys
EXTRAKEY_ENABLE = yes # Audio control and System control(+450) EXTRAKEY_ENABLE = yes # Audio control and System control
LTO_ENABLE = yes
SRC += manna-harbour_miryoku.c # keymap
# select alternative base layer alphas
ifneq ($(strip $(MIRYOKU_ALPHAS)),)
OPT_DEFS += -DMIRYOKU_ALPHAS_$(MIRYOKU_ALPHAS)
endif
# select alternative subset mappings
ifneq ($(strip $(MIRYOKU_MAPPING)),)
OPT_DEFS += -DMIRYOKU_MAPPING_$(MIRYOKU_MAPPING)
endif