Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Keymap addition for mjuma in keyboards/planck/keymaps #10885

Merged
merged 3 commits into from
Jan 24, 2021
Merged

Keymap addition for mjuma in keyboards/planck/keymaps #10885

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b7d9095
Add planck layout
MJuma Nov 8, 2020
ef4cac5
switch gaming toggle to TG
MJuma Dec 31, 2020
a013585
rename readme
MJuma Jan 9, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
183 changes: 183 additions & 0 deletions keyboards/planck/keymaps/mjuma/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,183 @@
# M Juma Planck Layout
MJuma marked this conversation as resolved.
Show resolved Hide resolved

## Layers

```ascii
Keymap: 32 Layers Layer: action code matrix
----------------- ---------------------
stack of layers array_of_action_code[row][column]
____________ precedence _______________________
/ / | high / ESC / F1 / F2 / F3 ....
31 /___________// | /-----/-----/-----/-----
30 /___________// | / TAB / Q / W / E ....
29 /___________/ | /-----/-----/-----/-----
: _:_:_:_:_:__ | : /LCtrl/ A / S / D ....
: / : : : : : / | : / : : : :
2 /___________// | 2 `--------------------------
1 /___________// | 1 `--------------------------
0 /___________/ V low 0 `--------------------------
```

### Qwerty

```ascii
,-----------------------------------------------------------------------------------.
| Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp |
|------+------+------+------+------+-------------+------+------+------+------+------|
| GEsc | A | S | D | F | G | H | J | K | L | ; | " |
|------+------+------+------+------+------|------+------+------+------+------+------|
| Shift| Z | X | C | V | B | N | M | , | . | / |Enter |
|------+------+------+------+------+------+------+------+------+------+------+------|
| Ctrl | FN | GUI | Alt |Lower | Space FN |Raise | Left | Down | Up |Right |
`-----------------------------------------------------------------------------------'
```

#### Qwerty Layer Features

- [Grave Escape](https://docs.qmk.fm/#/feature_grave_esc)
- [Tap Dance](https://docs.qmk.fm/#/feature_tap_dance) Left Shift
- Tap => Shift
- Double Tap => Capslock
- [Mod-Tap](https://docs.qmk.fm/#/mod_tap) Enter
- Tap => Enter
- Hold => Right Shift
- [Layer Toggle](https://docs.qmk.fm/#/feature_layers) Space
- Tap => Space
- Hold => Activate ***Space Function*** Layer

### Raise

```ascii
,-----------------------------------------------------------------------------------.
| ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp |
|------+------+------+------+------+-------------+------+------+------+------+------|
| | | | | | | * | 4 | 5 | 6 | - | \ |
|------+------+------+------+------+------|------+------+------+------+------+------|
| | | | | | | / | 1 | 2 | 3 | + |Enter |
|------+------+------+------+------+------+------+------+------+------+------+------|
| | | | | | Space | | 0 | . | = | |
`-----------------------------------------------------------------------------------'
```

### Lower

```ascii
,-----------------------------------------------------------------------------------.
| ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Bksp |
|------+------+------+------+------+-------------+------+------+------+------+------|
| | | | / | { | [ | ] | } | \ | - | = | | |
|------+------+------+------+------+------|------+------+------+------+------+------|
| | | | | | | | | | _ | + |Enter |
|------+------+------+------+------+------+------+------+------+------+------+------|
| | | | | | Space | | Home | PgDn | PgUp | End |
`-----------------------------------------------------------------------------------'
```

### Function

```ascii
,-----------------------------------------------------------------------------------.
| | F1 | F2 | F3 | F4 | F5 | F6 | F7 | F8 | F9 | F10 | Del |
|------+------+------+------+------+-------------+------+------+------+------+------|
| | F11 | F12 | F13 | F14 | F15 | |INSERT| Home | PgUp | | |
|------+------+------+------+------+------|------+------+------+------+------+------|
| | | | | | | |DELETE| End | PgDn | | Enter|
|------+------+------+------+------+------+------+------+------+------+------+------|
| | | | | | Space | | | | | |
`-----------------------------------------------------------------------------------'
```

### Space Function

```ascii
,------------------------------------------------------------------------------------.
|PRNT SC| | UP | | | | | | | | | |
|-------+------+------+------+------+-------------+------+------+------+------+------|
| | LEFT | DOWN | RIGHT| | | LEFT | DOWN | UP | RIGHT| | |
|-------+------+------+------+------+------|------+------+------+------+------+------|
| |ALT+1 |ALT+2 |ALT+3 |ALT+4 |ALT+5 |ALT+6 |ALT+7 |ALT+8 |ALT+9 |ALT+10| |
|-------+------+------+------+------+------+------+------+------+------+------+------|
| | | | |VOLDWN| |VOL UP| PREV | MUTE |PLY/PS| NEXT |
`------------------------------------------------------------------------------------'
```

### Gaming

```ascii
,-----------------------------------------------------------------------------------.
| Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp |
|------+------+------+------+------+-------------+------+------+------+------+------|
| Esc | A | S | D | F | G | H | J | K | L | ; | " |
|------+------+------+------+------+------|------+------+------+------+------+------|
| Shift| Z | X | C | V | B | N | M | , | . | / |Enter |
|------+------+------+------+------+------+------+------+------+------+------+------|
| Ctrl | FN | GUI | Alt |Lower | Space |Raise | Left | Down | Up |Right |
`-----------------------------------------------------------------------------------'
```

### Adjust (Lower + Raise)

```ascii
,-----------------------------------------------------------------------------------.
| |RESET |DEBUG | | | | |DMREC1|DMREC2| | | |
|------+------+------+------+------+-------------+------+------+------+------+------|
| |GAMING| | | | | |DMPLY1|DMPLY2|Audoff|Aud on| |
|------+------+------+------+------+------|------+------+------+------+------+------|
| | | | | | | |DMRSTP| |Musoff|Mus on|MusMod|
|------+------+------+------+------+------+------+------+------+------+------+------|
| | | |AG_TOG| | | | |Voice-|Voice+| |
`-----------------------------------------------------------------------------------'
```

#### Adjust Layer Features

```text
RESET: Put the keyboard into bootloader mode for flashing
DEBUG: Toggle debug mode
EEP_RST: Reinitializes the keyboard’s EEPROM (persistent memory)

AG_TOG: Toggle Alt and GUI swap on both sides (Mac)

DM_REC1: Start recording Macro 1
DM_REC2: Start recording Macro 2
DM_PLY1: Replay Macro 1
DM_PLY2: Replay Macro 2
DM_RSTP: Finish the macro that is currently being recorded.

AU_ON: Audio mode on
AU_OFF: Audio mode off
AU_TOG: Toggles Audio mode
MU_ON: Turn music mode on
MU_OFF: Turn music mode off
MU_TOG: Toggle music mode
MU_MOD: Cycle through the music modes:
CHROMATIC_MODE: Chromatic scale, row changes the octave
GUITAR_MODE: Chromatic scale, but the row changes the string (+5 st)
VIOLIN_MODE: Chromatic scale, but the row changes the string (+7 st)
MAJOR_MODE: Major scale

In Music Mode:
LCTL: start a recording
LALT: stop recording/stop playing
LGUI: play recording
KC_UP: speed-up playback
KC_DOWN: slow-down playback
```

## Compilation

Use the docker image to compile this keyboard layout by running the following from the root of the repo:

```sh
util/docker_build.sh planck/rev6:mjuma
```

## Flashing

Flashing on linux can be done through the docker image

```sh
sudo util/docker_build.sh planck/rev6:mjuma:flash
```

or on Windows using the [QMK Toolbox](https://github.com/qmk/qmk_toolbox)
28 changes: 28 additions & 0 deletions keyboards/planck/keymaps/mjuma/config.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
/* Copyright 2017-2021 M Juma
*
* 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
MJuma marked this conversation as resolved.
Show resolved Hide resolved

#ifdef AUDIO_ENABLE
#define STARTUP_SONG SONG(PLANCK_SOUND)

#define DEFAULT_LAYER_SONGS { SONG(QWERTY_SOUND), \
SONG(COLEMAK_SOUND), \
SONG(DVORAK_SOUND) \
}
#endif

#define TAPPING_TERM 200
Loading