diff options
55 files changed, 1890 insertions, 18 deletions
diff --git a/docs/contributing.md b/docs/contributing.md index 7c365b4186..c4d5057a07 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -85,7 +85,7 @@ Limited experimentation on the devices I have available shows that 7 is high eno Documentation is one of the easiest ways to get started contributing to QMK. Finding places where the documentation is wrong or incomplete and fixing those is easy! We also very badly need someone to edit our documentation, so if you have editing skills but aren't sure where or how to jump in please [reach out for help](#where-can-i-go-for-help)! -You'll find all our documentation in the `qmk_firmware/docs` directory, or if you'd rather use a web based workflow you can click "Suggest An Edit" at the top of each page on http://docs.qmk.fm/. +You'll find all our documentation in the `qmk_firmware/docs` directory, or if you'd rather use a web based workflow you can click the "Edit this page" link at the bottom of each page on https://docs.qmk.fm/. When providing code examples in your documentation, try to observe naming conventions used elsewhere in the docs. For example, standardizing enums as `my_layers` or `my_keycodes` for consistency: diff --git a/docs/index.html b/docs/index.html index 8d03c6edef..9b33cd263a 100644 --- a/docs/index.html +++ b/docs/index.html @@ -82,9 +82,9 @@ .replace('raw.githubusercontent.com', 'github.com') .replace(/\/master/, '/blob/master') } else { - url = 'https://github.com/qmk/qmk_firmware/blob/master/docs/' + vm.route.file + url = 'https://github.com/qmk/qmk_firmware/edit/master/docs/' + vm.route.file } - var editHtml = '[:memo: Edit Document](' + url + ')\n' + var editHtml = ':pencil2: [Edit this page](' + url + ')\n' return html + '\n\n----\n\n' + editHtml diff --git a/keyboards/atreus62/keymaps/d4mation/keymap.c b/keyboards/atreus62/keymaps/d4mation/keymap.c new file mode 100644 index 0000000000..63b9d6142d --- /dev/null +++ b/keyboards/atreus62/keymaps/d4mation/keymap.c @@ -0,0 +1,196 @@ +#include QMK_KEYBOARD_H +#include "d4mation.h" + +enum layer_names { + _DVR, + _QWR, + _LOWER, + _RAISE, + _NUM, + _ADJUST +}; + +enum keymap_custom_keycodes { + LOWER = NEW_SAFE_RANGE, + RAISE +}; + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + + /* Default/Dvorak layer + * ,-----------------------------------------. ,-----------------------------------------. + * | ` | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | / | + * |------+------+------+------+------+------| |------+------+------+------+------+------| + * | Tab | ' | , | . | P | Y | | F | G | C | R | L | = | + * |------+------+------+------+------+------| |------+------+------+------+------+------| + * | Ctrl | A | O | E | U | I |,------.,------.| D | H | T | N | S | - | + * |------+------+------+------+------+------|| || ||------+------+------+------+------+------| + * |Shift | ; | Q | J | K | X ||Super ||Enter || B | M | W | V | Z | \ | + * |------+------+------+------+------+------|| || ||------+------+------+------+------+------| + * | NUM | Alt | Home | End |Lower | Bksp |`------'`------'|Space |Raise | Left | Down | Up |Right | + * `-----------------------------------------' `-----------------------------------------' + */ + + [_DVR] = LAYOUT( + _GRAVE_ESC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_SLSH, + KC_TAB, KC_QUOT, KC_COMM, KC_DOT, KC_P, KC_Y, KC_F, KC_G, KC_C, KC_R, KC_L, KC_EQL, + KC_LCTL, KC_A, KC_O, KC_E, KC_U, KC_I, KC_D, KC_H, KC_T, KC_N, KC_S, KC_MINS, + TD(SHIFT_CAPS), KC_SCLN, KC_Q, KC_J, KC_K, KC_X, KC_B, KC_M, KC_W, KC_V, KC_Z, KC_BSLS, + TG(_NUM), KC_RALT, KC_HOME, KC_END, LOWER, KC_BSPC, KC_LGUI, KC_ENT, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RIGHT + ), + + /* Qwerty layer, more "standard" for other people who may need to use my keyboard or for games where using Qwerty is just easier + * ,-----------------------------------------. ,-----------------------------------------. + * | ` | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | - | + * |------+------+------+------+------+------| |------+------+------+------+------+------| + * | Tab | Q | W | E | R | T | | Y | U | I | O | P | \ | + * |------+------+------+------+------+------| |------+------+------+------+------+------| + * | Ctrl | A | S | D | F | G |,------.,------.| H | J | K | L | ; | ' | + * |------+------+------+------+------+------|| || ||------+------+------+------+------+------| + * |Shift | Z | X | C | V | B ||Super ||Enter || N | M | , | . | / | = | + * |------+------+------+------+------+------|| || ||------+------+------+------+------+------| + * | NUM | Alt | Home | End |Lower | Bksp |`------'`------'|Space |Raise | Left | Down | Up |Right | + * `-----------------------------------------' `-----------------------------------------' + */ + + [_QWR] = LAYOUT( + _GRAVE_ESC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, + KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSLS, + KC_LCTL, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, + TD(SHIFT_CAPS), KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_EQL, + TG(_NUM), KC_RALT, KC_HOME, KC_END, LOWER, KC_BSPC, KC_LGUI, KC_ENT, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RIGHT + ), + + /* "Lower" layer + * ,-----------------------------------------. ,-----------------------------------------. + * | F11 | F1 | F2 | F3 | F4 | F5 | | F6 | F7 | F8 | F9 | F10 | F12 | + * |------+------+------+------+------+------| |------+------+------+------+------+------| + * | | | | |SLEEP | | | | | SCRGB| | | | + * |------+------+------+------+------+------| |------+------+------+------+------+------| + * | | | | | | |,------.,------.| | | | { | } | | + * |------+------+------+------+------+------|| || ||------+------+------+------+------+------| + * | | | | | | || || || | Mute | VolD | VolU | | | + * |------+------+------+------+------+------|| || ||------+------+------+------+------+------| + * | | |PageUp|PgDown| | Del |`------'`------'| Ins | | | | | | + * `-----------------------------------------' `-----------------------------------------' + */ + + [_LOWER] = LAYOUT( + KC_F11, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F12, + _______, _______, _______, _______, SLEEP, _______, _______, _______, SCRGB, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_LCBR, KC_RCBR, _______, + _______, _______, _______, _______, _______, _______, _______, KC_MUTE, KC_VOLD, KC_VOLU, _______, _______, + _______, _______, KC_PGUP, KC_PGDN, _______, KC_DEL, _______, _______, KC_INS, _______, _______, _______, _______, _______ + ), + + /* "Raise" layer + * ,-----------------------------------------. ,-----------------------------------------. + * | F11 | F1 | F2 | F3 | F4 | F5 | | F6 | F7 | F8 | F9 | F10 | F12 | + * |------+------+------+------+------+------| |------+------+------+------+------+------| + * | | |<?php>| ?> | | | |ZALGO | | | | | | + * |------+------+------+------+------+------| |------+------+------+------+------+------| + * | | Shrug|Lenny |Magic |Disfac| |,------.,------.| | | | [ | ] | | + * |------+------+------+------+------+------|| || ||------+------+------+------+------+------| + * | | Ameno| Tflip| Tput | | || || || | Prev | Play | Next | | | + * |------+------+------+------+------+------|| || ||------+------+------+------+------+------| + * | | |PageUp|PgDown| | Del |`------'`------'| Ins | | | | | | + * `-----------------------------------------' `-----------------------------------------' + */ + + [_RAISE] = LAYOUT( + KC_F11, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F12, + _______, _______, PHPOPEN, PHPCLSE, _______, _______, ZALGO, _______, _______, _______, _______, _______, + _______, SHRUG, LENNY, MAGIC, DISFACE, _______, _______, _______, _______, KC_LBRC, KC_RBRC,_______, + _______, AMENO, TFLIP, TPUT, _______, _______, _______, KC_MPRV, KC_MPLY, KC_MNXT, _______, _______, + _______, _______, KC_PGUP, KC_PGDN, _______, KC_DEL, _______, _______, KC_INS, _______, _______, _______, _______, _______ + ), + + /* "Numpad" layer + * ,-----------------------------------------. ,-----------------------------------------. + * | | | / | * | - | | | | | / | * | - | | + * |------+------+------+------+------+------| |------+------+------+------+------+------| + * | | 7 | 8 | 9 | + | | | | 7 | 8 | 9 | + | | + * |------+------+------+------+------+------| |------+------+------+------+------+------| + * | | 4 | 5 | 6 | + | |,------.,------.| | 4 | 5 | 6 | + | | + * |------+------+------+------+------+------|| || ||------+------+------+------+------+------| + * | | 1 | 2 | 3 | Enter| || || || | 1 | 2 | 3 | Enter| | + * |------+------+------+------+------+------|| || ||------+------+------+------+------+------| + * | | 0 | 0 | . | Enter| |`------'`------'| | 0 | 0 | . | Enter| | + * `-----------------------------------------' `-----------------------------------------' + */ + + [_NUM] = LAYOUT( + _______, _______, KC_PSLS, KC_PAST, KC_PMNS, _______, _______, _______, KC_PSLS, KC_PAST, KC_PMNS, _______, + _______, KC_KP_7, KC_KP_8, KC_KP_9, KC_PPLS, _______, _______, KC_KP_7, KC_KP_8, KC_KP_9, KC_PPLS, _______, + _______, KC_KP_4, KC_KP_5, KC_KP_6, KC_PPLS, _______, _______, KC_KP_4, KC_KP_5, KC_KP_6, KC_PPLS, _______, + _______, KC_KP_1, KC_KP_2, KC_KP_3, KC_PENT, _______, _______, KC_KP_1, KC_KP_2, KC_KP_3, KC_PENT, _______, + _______, KC_KP_0, KC_KP_0, KC_PDOT, KC_PENT, _______, _______, _______, _______, KC_KP_0, KC_KP_0, KC_PDOT, KC_PENT, _______ + ), + + /* "Adjust" layer, only active if both "Lower" and "Raise" are active at the same time + * All unused keys are blanked out for this layer + * ,-----------------------------------------. ,-----------------------------------------. + * | NO | NO | NO | NO | NO | NO | | NO | NO | NO | NO | NO | NO | + * |------+------+------+------+------+------| |------+------+------+------+------+------| + * | NO |RESET | NO | NO | NO | NO | | NO | NO | NO | NO | NO | NO | + * |------+------+------+------+------+------| |------+------+------+------+------+------| + * | NO | NO | NO |UC WIN|UC OSX| NO |,------.,------.| NO |Dvorak|Qwerty| NO | NO | NO | + * |------+------+------+------+------+------|| Swap || ||------+------+------+------+------+------| + * | NO | NO | NO | NO | NO | NO || to || Swap || NO | NO | NO | NO | NO | NO | + * |------+------+------+------+------+------|| Ctrl || Back ||------+------+------+------+------+------| + * | NO | NO | NO | NO | | NO |`------'`------'| NO | | NO | NO | NO | NO | + * `-----------------------------------------' `-----------------------------------------' + */ + + [_ADJUST] = LAYOUT( + XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, + XXXXXXX, RESET, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, + XXXXXXX, XXXXXXX, XXXXXXX, UC_M_WI, UC_M_OS, XXXXXXX, XXXXXXX, DF(_DVR),DF(_QWR),XXXXXXX, XXXXXXX, XXXXXXX, + XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, + XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, _______, XXXXXXX, CG_SWAP, CG_NORM, XXXXXXX, _______, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX + ), + +}; + +/* Runs just one time when the keyboard initializes. */ +void eeconfig_init_keymap( void ) { + set_unicode_input_mode( UC_OSX ); +}; + +bool process_record_keymap( 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; + + } + + return true; + +};
\ No newline at end of file diff --git a/keyboards/atreus62/keymaps/d4mation/readme.md b/keyboards/atreus62/keymaps/d4mation/readme.md new file mode 100644 index 0000000000..5642e8e432 --- /dev/null +++ b/keyboards/atreus62/keymaps/d4mation/readme.md @@ -0,0 +1,40 @@ +# d4mation's keymap for the Atreus62 + +This is a bit of a work in-progress, but for the most part I like what I have done here. + +I switched to Dvorak some time ago and software-based support in most OS's for Dvorak isn't very great, so this keymap by default is set to Dvorak. + +## Table of Contents + +* [Layers](#layers) + - [Base layer](#base) + - [Num](#num) + - [Lower](#lower) + - [Raise](#raise) + - [Adjust](#adjust) + +# Layers + +## Base + +* By default, this layer is Dvorak. But using the Adjust layer you can switch to Qwerty +* Double-tapping Shift enables and disables Caps Lock +* Quickly tapping the Grave accent key will output a Grave Accent, but holding it for 200ms will output the ESC key instead + +## Num + +This layer gets toggled off and on to place a numpad on both the left and right sides of the keyboard. + +## Lower + +This layer holds some handy shortcuts that I use often, like the screen grab shortcut and sleep shortcut in OS X. + +It also has quick access to {} as they are inaccessible in the base layer + +## Raise + +Aside from quick access to [] and Play/Pause/Next/Previous, this layer is mostly just goofy things I decided to program into the keyboard because I could. There's a bunch of [kaomoji](https://en.wikipedia.org/wiki/Emoticon#Japanese_style_(kaomoji))/"unicode smileys" and I added a toggle switch to enable a [Zalgo Text](https://zalgo.org/) mode. + +## Adjust + +This layer is a "here be dragons" layer. It can only be accessed by holding down the keys for Lower and Raise at the same time. I added exclusively keys that drastically transformed the keyboard's layout or function on this layer. The ability to switch to Qwerty is on this layer, a way to switch CTRL and CMD back and forth is on this layer, and a hotkey to enter bootloader mode also exists. diff --git a/keyboards/atreus62/keymaps/d4mation/rules.mk b/keyboards/atreus62/keymaps/d4mation/rules.mk new file mode 100644 index 0000000000..517f2700e1 --- /dev/null +++ b/keyboards/atreus62/keymaps/d4mation/rules.mk @@ -0,0 +1,2 @@ +UNICODE_ENABLE = yes +TAP_DANCE_ENABLE = yes
\ No newline at end of file diff --git a/keyboards/clueboard/60/config.h b/keyboards/clueboard/60/config.h index aa544c70bb..f0e157ff14 100644 --- a/keyboards/clueboard/60/config.h +++ b/keyboards/clueboard/60/config.h @@ -47,7 +47,7 @@ * */ #define MATRIX_ROW_PINS { B0, B1, B2, A15, A10 } -#define MATRIX_COL_PINS { A2, A3, A6, B14, B15, A8, A9, A7, B3, B4, C14, C15, C13, B5, B6 } +#define MATRIX_COL_PINS { A2, A3, A6, B14, B15, A8, A9, A7, B3, B4, C15, C14, C13, B5, B6 } #define UNUSED_PINS { A0, A1, A9, B7, B8, B9, B10, B11, B12, B13 } #define DIODE_DIRECTION COL2ROW diff --git a/keyboards/crkbd/keymaps/kidbrazil/README.md b/keyboards/crkbd/keymaps/kidbrazil/README.md new file mode 100644 index 0000000000..28414860c3 --- /dev/null +++ b/keyboards/crkbd/keymaps/kidbrazil/README.md @@ -0,0 +1,52 @@ +# KidBrazil's custom CRKBD Layout + + + +This is a simple layout that I use for both programming and gaming. It is very +closely based on the original CRKBD layout with some modifications to the +position of CTRL and SHIFT. + +## Layers +This keymap includes a total of 4 Layers: +- QWERTY +- NUMBERS +- SYMBOLS +- GAMING +- WEAPONS + +The first three layers are pretty self explanatory and follow closely the +default keymap for this keyboard. The magic really starts to happen with the +gaming layer. + +### Gaming Layer +The gaming layer can be toggled on/off from the SYMBOLS layer. Once on the +gaming layer it will stay there until you toggle it off again. The gaming layer +includes normal WASD and most of the keys FPS games use on the left hand. On the +right hand we have F1-F12 and a few other special keys for games that require +it. + +### Weapon +The weapon layer is a momentary layer that can only be reached from the gaming +layer. This layer preserves the left hand almost unchanged, except for when the +layer is activated the top row becomes NUM 1 - 6 for wepon selection. The right +hand is KC_TRNS the whole way so basically it is still the gaming layer. + +## Custom Font +This keymap includes a custom font for my LooseTransistor logo. It is fine if +you want to use it I certainly don't mind but if you want your own, just replace +the glcdfont file here and you should be fine. + +Alternatively you could remove the font config line from the config.h file so it +will use the default QMK one. + +## OLED +This Keymap is setup to use the newer OLED API. Some work has been done to +customize this with showing layer and USB information. I also tried my best to +get a dormant / sleep state going but it is hit or miss and often only works on +the master hand. + +### TODO +- Fix OLED and Backlight so they turn off when the computer sleeps, currently + only the left hand does that and the LEDs still stay on. +- Wait for Spit_common to be implemented in CRKBD and revisit the special color + layers and animations diff --git a/keyboards/crkbd/keymaps/kidbrazil/config.h b/keyboards/crkbd/keymaps/kidbrazil/config.h new file mode 100644 index 0000000000..dd3f1a0307 --- /dev/null +++ b/keyboards/crkbd/keymaps/kidbrazil/config.h @@ -0,0 +1,100 @@ +/* +This is the c configuration file for the keymap + +Copyright 2012 Jun Wako <wakojun@gmail.com> +Copyright 2015 Jack Humbert +Copyright 2019 Lucas Moreira + +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 USE_MATRIX_I2C + +/* Select hand configuration */ + +#define MASTER_LEFT +// #define MASTER_RIGHT +// #define EE_HANDS + +//#define SSD1306OLED + +#define USE_SERIAL_PD2 + +#define TAPPING_FORCE_HOLD +#define TAPPING_TERM 150 +#undef PRODUCT +#define PRODUCT CRKBD Loose Transistor Ed. + +#ifdef RGBLIGHT_ENABLE + //#undef RGBLED_NUM + //#define RGBLIGHT_ANIMATIONS + #define RGBLIGHT_EFFECT_BREATHING + #define RGBLIGHT_EFFECT_RAINBOW_MOOD + #define RGBLIGHT_EFFECT_KNIGHT + //#define RGBLED_NUM 27 + #define RGBLIGHT_LIMIT_VAL 120 + #define RGBLIGHT_HUE_STEP 10 + #define RGBLIGHT_SAT_STEP 17 + #define RGBLIGHT_VAL_STEP 17 +#endif + +#ifdef RGB_MATRIX_ENABLE +//# define RGB_MATRIX_KEYPRESSES // reacts to keypresses +// # define RGB_MATRIX_KEYRELEASES // reacts to keyreleases (instead of keypresses) +// # define RGB_DISABLE_AFTER_TIMEOUT 0 // number of ticks to wait until disabling effects +# define RGB_DISABLE_WHEN_USB_SUSPENDED true // turn off effects when suspended +# define RGB_MATRIX_FRAMEBUFFER_EFFECTS +// # define RGB_MATRIX_LED_PROCESS_LIMIT (DRIVER_LED_TOTAL + 4) / 5 // limits the number of LEDs to process in an animation per task run (increases keyboard responsiveness) +// # define RGB_MATRIX_LED_FLUSH_LIMIT 16 // limits in milliseconds how frequently an animation will update the LEDs. 16 (16ms) is equivalent to limiting to 60fps (increases keyboard responsiveness) +# 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 + +/* Disable the animations you don't want/need. You will need to disable a good number of these * + * because they take up a lot of space. Disable until you can successfully compile your firmware. */ +# define DISABLE_RGB_MATRIX_ALPHAS_MODS +# define DISABLE_RGB_MATRIX_GRADIENT_UP_DOWN +// # define DISABLE_RGB_MATRIX_BREATHING +# define DISABLE_RGB_MATRIX_CYCLE_ALL +# define DISABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT +# define DISABLE_RGB_MATRIX_CYCLE_UP_DOWN |