mirrors/keychron_qmk_firmware
mirrors/keychron_qmk_firmware
0
0
Fork 0
mirror of https://github.com/Keychron/qmk_firmware.git synced 2024-12-13 05:38:51 +06:00
Code Issues Packages Projects Releases Wiki Activity
3f392c09b6
keychron_qmk_firmware/keyboards/hotdox/keymaps/ninjonas/README.md

106 lines
7.4 KiB
Markdown
Raw Normal View History

[keymap] ninjonas userspace and keymaps for hotdox, lily58, & pinky3 (#6649) * [keyboard] introducing ninjonas userspace & keymaps for hotdox, lily58, and pinky3 * [fix(#6649)] removed M_EPRM and used builtin EEP_RST keycode as-per review. * [chore(#6649)] forgot to update keymap legend on lily58
2019-09-02 20:40:01 +06:00
# ninjonas Keymap for [ErgoDox (HotDox)](https://www.alpacakeyboards.com/)
## Setup
- Ensure you've cloned the [qmk](https://github.com/qmk/qmk_firmware) repo
- Create directory `ninjonas` on `/keyboards/hotdox/keymaps/`
- Run `copy_keymap.sh`. This copies the contents of this repo into `%qmk_firmware%/ninjonas/` directory
- To push your keymap to your keyboard run this command `make clean hotdox:ninjonas:dfu`
- this compiles your keymap and creates a `hotdox_ninjonas.hex` file and will atempt to flash your board
- if you get the following message:
```
dfu-programmer: no device present.
Error: Bootloader not found. Trying again in 5s.
```
- Press the reset button underneath your ErgoDox keyboard
- The following messages should show up and your board has successfuly been flashed
```
Bootloader Version: 0x00 (0)
Erasing flash... Success
Checking memory from 0x0 to 0x6FFF... Empty.
Checking memory from 0x0 to 0x5D7F... Empty.
0% 100% Programming 0x5D80 bytes...
[>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>] Success
0% 100% Reading 0x7000 bytes...
[>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>] Success
Validating... Success
0x5D80 bytes written into 0x7000 bytes memory (83.48%).
```
- The alterenative is follow the steps on [Hotdox flashing guide](https://www.alpacakeyboards.com/flash/hot-dox-ergodox-76-flashing-instructions)
## Keymap
This keymap is designed based off my typing habits and is subject to change. Information about custom user macros and tap dances can be found [here](https://github.com/ninjonas/qmk-yonas/tree/master/users/ninjonas).
### QWERTY
```c
[keymap(kyria), refactor] created kyria keymap. refactored ninjonas userspace (#8053) * [keymap(kyria), refactor] created kyria keymap. refactored ninjonas userspace and keyboards * [fix(#8053)] removed redundant code based off Duckle29's code review * [fix(#8053)] fixing typos * [refactor(#8053)] updating oled timeout * [fix(8053) resolved code review issues identified by noroadsleft
2020-02-01 12:38:05 +06:00
/* QWERTY
[keymap] ninjonas userspace and keymaps for hotdox, lily58, & pinky3 (#6649) * [keyboard] introducing ninjonas userspace & keymaps for hotdox, lily58, and pinky3 * [fix(#6649)] removed M_EPRM and used builtin EEP_RST keycode as-per review. * [chore(#6649)] forgot to update keymap legend on lily58
2019-09-02 20:40:01 +06:00
*
* ,--------------------------------------------------. ,--------------------------------------------------.
* | ` | 1 | 2 | 3 | 4 | 5 | Play | |K_LOCK | 6 | 7 | 8 | 9 | 0 | - |
* |--------+------+------+------+------+-------------| |-------+------+------+------+------+------+--------|
* | Tab | Q | W | E | R | T | | | | Y | U | I | O | P | \ |
* |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
* | Esc | A | S | D | F | G |------| |-------| H | J | K | L | ; | ' |
* |--------+------+------+------+------+------| [ | | ] |------+------+------+------+------+--------|
* | LShift | Z | X | C | V | B | | | | N | M | , | . | / | = |
* `--------+------+------+------+------+-------------' `--------------+------+------+------+------+--------'
[Keymap] ninjonas keymap updates (#8170) * [keymap] ninjonas keymap updates * [refactor(kyria)] updating keymap for numpad layer to be transparent rather than ignores * [keymap(lily58)] added numpad layer * [keymap(crkbd)] added numpad layer activated through tapdance * [fix(8170)] fixing code review changes requested by noroadsleft * [fix(8170)] updating comments and .md files to use 'Cmd' instead of  and ⌘
2020-02-17 15:30:03 +06:00
* | | | Alt | Cmd | Ctl | | BkSP | Del |LOWER | | |
[keymap] ninjonas userspace and keymaps for hotdox, lily58, & pinky3 (#6649) * [keyboard] introducing ninjonas userspace & keymaps for hotdox, lily58, and pinky3 * [fix(#6649)] removed M_EPRM and used builtin EEP_RST keycode as-per review. * [chore(#6649)] forgot to update keymap legend on lily58
2019-09-02 20:40:01 +06:00
* `----------------------------------' `----------------------------------'
* ,-------------. ,-------------.
* | Up | Down | | Left | Right|
* ,------|------|------| |------+------+------.
* | | | Home | | PgUp | | |
* | Space|Backsp|------| |------| Del |Enter |
* | |ace | End | | PgDn | | |
* `--------------------' `--------------------'
*/
```
### LOWER
```c
[keymap(kyria), refactor] created kyria keymap. refactored ninjonas userspace (#8053) * [keymap(kyria), refactor] created kyria keymap. refactored ninjonas userspace and keyboards * [fix(#8053)] removed redundant code based off Duckle29's code review * [fix(#8053)] fixing typos * [refactor(#8053)] updating oled timeout * [fix(8053) resolved code review issues identified by noroadsleft
2020-02-01 12:38:05 +06:00
/* LOWER
[keymap] ninjonas userspace and keymaps for hotdox, lily58, & pinky3 (#6649) * [keyboard] introducing ninjonas userspace & keymaps for hotdox, lily58, and pinky3 * [fix(#6649)] removed M_EPRM and used builtin EEP_RST keycode as-per review. * [chore(#6649)] forgot to update keymap legend on lily58
2019-09-02 20:40:01 +06:00
*
* ,--------------------------------------------------. ,----------------------------------------------------.
* | F11 | F1 | F2 | F3 | F4 | F5 | | | | F6 | F7 | F8 | F9 | F10 | F12 |
* |--------+------+------+------+------+-------------| |-------+------+------+------+------+-------+--------|
[keymap(kyria), refactor] created kyria keymap. refactored ninjonas userspace (#8053) * [keymap(kyria), refactor] created kyria keymap. refactored ninjonas userspace and keyboards * [fix(#8053)] removed redundant code based off Duckle29's code review * [fix(#8053)] fixing typos * [refactor(#8053)] updating oled timeout * [fix(8053) resolved code review issues identified by noroadsleft
2020-02-01 12:38:05 +06:00
* | | |KC_BRU| Play | Mute | | | | | PgUp | Home | Up | End | | |
[keymap] ninjonas userspace and keymaps for hotdox, lily58, & pinky3 (#6649) * [keyboard] introducing ninjonas userspace & keymaps for hotdox, lily58, and pinky3 * [fix(#6649)] removed M_EPRM and used builtin EEP_RST keycode as-per review. * [chore(#6649)] forgot to update keymap legend on lily58
2019-09-02 20:40:01 +06:00
* |--------+------+------+------+------+------| | | |------+------+------+------+-------+--------|
[keymap(kyria), refactor] created kyria keymap. refactored ninjonas userspace (#8053) * [keymap(kyria), refactor] created kyria keymap. refactored ninjonas userspace and keyboards * [fix(#8053)] removed redundant code based off Duckle29's code review * [fix(#8053)] fixing typos * [refactor(#8053)] updating oled timeout * [fix(8053) resolved code review issues identified by noroadsleft
2020-02-01 12:38:05 +06:00
* | | |KC_BRD| Next |VolUp | |------| |-------| PgDn | Left | Down |Right |K_LOCK | |
[keymap] ninjonas userspace and keymaps for hotdox, lily58, & pinky3 (#6649) * [keyboard] introducing ninjonas userspace & keymaps for hotdox, lily58, and pinky3 * [fix(#6649)] removed M_EPRM and used builtin EEP_RST keycode as-per review. * [chore(#6649)] forgot to update keymap legend on lily58
2019-09-02 20:40:01 +06:00
* |--------+------+------+------+------+------| | | |------+------+------+------+-------+--------|
[keymap(kyria), refactor] created kyria keymap. refactored ninjonas userspace (#8053) * [keymap(kyria), refactor] created kyria keymap. refactored ninjonas userspace and keyboards * [fix(#8053)] removed redundant code based off Duckle29's code review * [fix(#8053)] fixing typos * [refactor(#8053)] updating oled timeout * [fix(8053) resolved code review issues identified by noroadsleft
2020-02-01 12:38:05 +06:00
* | | | | Prev |VolDn | | | | | | | | | | |
[keymap] ninjonas userspace and keymaps for hotdox, lily58, & pinky3 (#6649) * [keyboard] introducing ninjonas userspace & keymaps for hotdox, lily58, and pinky3 * [fix(#6649)] removed M_EPRM and used builtin EEP_RST keycode as-per review. * [chore(#6649)] forgot to update keymap legend on lily58
2019-09-02 20:40:01 +06:00
* `--------+------+------+------+------+-------------' `--------------+------+------+------+-------+--------'
* | | | | | | | | | |M_CODE | |
* `----------------------------------' `-----------------------------------'
* ,-------------. ,-------------.
* | | | | | |
* ,------|------|------| |------+------+------.
* | | | | | | | |
* | | |------| |------| | |
* | | | | | | | |
* `--------------------' `--------------------'
*/
```
### RAISE
```c
[keymap(kyria), refactor] created kyria keymap. refactored ninjonas userspace (#8053) * [keymap(kyria), refactor] created kyria keymap. refactored ninjonas userspace and keyboards * [fix(#8053)] removed redundant code based off Duckle29's code review * [fix(#8053)] fixing typos * [refactor(#8053)] updating oled timeout * [fix(8053) resolved code review issues identified by noroadsleft
2020-02-01 12:38:05 +06:00
/* RAISE
[keymap] ninjonas userspace and keymaps for hotdox, lily58, & pinky3 (#6649) * [keyboard] introducing ninjonas userspace & keymaps for hotdox, lily58, and pinky3 * [fix(#6649)] removed M_EPRM and used builtin EEP_RST keycode as-per review. * [chore(#6649)] forgot to update keymap legend on lily58
2019-09-02 20:40:01 +06:00
*
* ,--------------------------------------------------. ,----------------------------------------------------.
[keymap(kyria), refactor] created kyria keymap. refactored ninjonas userspace (#8053) * [keymap(kyria), refactor] created kyria keymap. refactored ninjonas userspace and keyboards * [fix(#8053)] removed redundant code based off Duckle29's code review * [fix(#8053)] fixing typos * [refactor(#8053)] updating oled timeout * [fix(8053) resolved code review issues identified by noroadsleft
2020-02-01 12:38:05 +06:00
* | | | | | | | | | | | | | | | |
[keymap] ninjonas userspace and keymaps for hotdox, lily58, & pinky3 (#6649) * [keyboard] introducing ninjonas userspace & keymaps for hotdox, lily58, and pinky3 * [fix(#6649)] removed M_EPRM and used builtin EEP_RST keycode as-per review. * [chore(#6649)] forgot to update keymap legend on lily58
2019-09-02 20:40:01 +06:00
* |--------+------+------+------+------+-------------| |-------+------+------+------+------+-------+--------|
[keymap(kyria), refactor] created kyria keymap. refactored ninjonas userspace (#8053) * [keymap(kyria), refactor] created kyria keymap. refactored ninjonas userspace and keyboards * [fix(#8053)] removed redundant code based off Duckle29's code review * [fix(#8053)] fixing typos * [refactor(#8053)] updating oled timeout * [fix(8053) resolved code review issues identified by noroadsleft
2020-02-01 12:38:05 +06:00
* | | | MS_1 | MS_U | MS_2 | WH_U | | | | | | | | | |
[keymap] ninjonas userspace and keymaps for hotdox, lily58, & pinky3 (#6649) * [keyboard] introducing ninjonas userspace & keymaps for hotdox, lily58, and pinky3 * [fix(#6649)] removed M_EPRM and used builtin EEP_RST keycode as-per review. * [chore(#6649)] forgot to update keymap legend on lily58
2019-09-02 20:40:01 +06:00
* |--------+------+------+------+------+------| | | |------+------+------+------+-------+--------|
[keymap(kyria), refactor] created kyria keymap. refactored ninjonas userspace (#8053) * [keymap(kyria), refactor] created kyria keymap. refactored ninjonas userspace and keyboards * [fix(#8053)] removed redundant code based off Duckle29's code review * [fix(#8053)] fixing typos * [refactor(#8053)] updating oled timeout * [fix(8053) resolved code review issues identified by noroadsleft
2020-02-01 12:38:05 +06:00
* | | | MS_L | MS_D | MS_R | WH_D |------| |-------| | | | | | |
[keymap] ninjonas userspace and keymaps for hotdox, lily58, & pinky3 (#6649) * [keyboard] introducing ninjonas userspace & keymaps for hotdox, lily58, and pinky3 * [fix(#6649)] removed M_EPRM and used builtin EEP_RST keycode as-per review. * [chore(#6649)] forgot to update keymap legend on lily58
2019-09-02 20:40:01 +06:00
* |--------+------+------+------+------+------| | | |------+------+------+------+-------+--------|
[keymap(kyria), refactor] created kyria keymap. refactored ninjonas userspace (#8053) * [keymap(kyria), refactor] created kyria keymap. refactored ninjonas userspace and keyboards * [fix(#8053)] removed redundant code based off Duckle29's code review * [fix(#8053)] fixing typos * [refactor(#8053)] updating oled timeout * [fix(8053) resolved code review issues identified by noroadsleft
2020-02-01 12:38:05 +06:00
* | | | | | | | | | | | | | | | |
[keymap] ninjonas userspace and keymaps for hotdox, lily58, & pinky3 (#6649) * [keyboard] introducing ninjonas userspace & keymaps for hotdox, lily58, and pinky3 * [fix(#6649)] removed M_EPRM and used builtin EEP_RST keycode as-per review. * [chore(#6649)] forgot to update keymap legend on lily58
2019-09-02 20:40:01 +06:00
* `--------+------+------+------+------+-------------' `--------------+------+------+------+-------+--------'
* | | | | | | | | | | | |
* `----------------------------------' `-----------------------------------'
* ,-------------. ,-------------.
* | | | | | |
* ,------|------|------| |------+------+------.
* | | | | | | | |
* | | |------| |------| | |
* | | | | | | | |
* `--------------------' `--------------------'
*/
```
Reference in New Issue Copy Permalink