mirrors/keychron_qmk_firmware
mirrors/keychron_qmk_firmware
0
0
Fork 0
mirror of https://github.com/Keychron/qmk_firmware.git synced 2024-11-30 12:47:37 +06:00
Code Issues Packages Projects Releases Wiki Activity
5a126e1a74
keychron_qmk_firmware/users/losinggeneration
History
James Young a03aa301de
Remove Full Bootmagic (#13846) 
* disambiguate Bootmagic rules in keymaps

The files edited by this commit were added at a point in time where `BOOTMAGIC_ENABLE = yes` enabled full Bootmagic.

This commit edits the files to specify that full Bootmagic is intended.

* remove BOOTMAGIC_ENABLE=full setting

* unify commented BOOTMAGIC_ENABLE rules in keyboards

Explicitly sets `BOOTMAGIC_ENABLE = no` in keyboards where the rule was commented out.

Command:

```
find keyboards/ -type f -name 'rules.mk' -and -not -path '*/keymaps/*' -exec sed -i -e 's;#[ \t]*\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-zA-Z]\+\).*;\1 = no       # Virtual DIP switch configuration;g' {} +
```

* remove commented Bootmagic rules from keymap/user level

Command:

```
find keyboards/ layouts/ users/ -type f -name 'rules.mk' -exec sed -i -e '/#.*\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*/d' {} +
```

* update keyboard BOOTMAGIC_ENABLE rule formatting

Sets the formatting of BOOTMAGIC_ENABLE rules to `BOOTMAGIC_ENABLE = [value]`, without the inline comments (which will be replaced later).

Command:

```
find keyboards/ -type f -name 'rules.mk' -and -not -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*;\1 = \2;g' '{}' +
```

* update keyboards' BOOTMAGIC_ENABLE settings

Updates keyboard `rules.mk` files to use `BOOTMAGIC_ENABLE = lite` where `BOOTMAGIC_ENABLE = full` was being used.

Command:

```
find keyboards/ -type f -name 'rules.mk' -and -not -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = \)full;\1lite;g' '{}' +
```

* update keymap/user BOOTMAGIC_ENABLE settings

Updates keymap/user `rules.mk` files to use `BOOTMAGIC_ENABLE = lite` where `BOOTMAGIC_ENABLE = full` was being used.

Commands:

```
find keyboards/ -type f -name 'rules.mk' -and -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE[ \t=]\+\)full;\1lite;g' '{}' +
find layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE[ \t=]\+\)full;\1lite;g' '{}' +
```

* remove and replace inline comments in keyboards and keymap/user files

Removes and replaces the inline comments, which have been updated to read `Enable Bootmagic Lite`.

Commands:

```
find keyboards/ -type f -name 'rules.mk' -and -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*;\1 = \2;g' '{}' +
find layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*;\1 = \2;g' '{}' +
find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = lite\);\1     # Enable Bootmagic Lite;g' '{}' +
find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = yes\);\1      # Enable Bootmagic Lite;g' '{}' +
find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = no\);\1       # Enable Bootmagic Lite;g' '{}' +
```

* rename improperly named makefiles

Some files intended to be used as makefiles had improper names causing them to not be used as intended when building.

This commit corrects the filenames of the affected files.

* update renamed file with new rule formatting

* update QMK's template files

Updates QMK's `rules.mk` templates to use the new inline comment.

* update QMK Docs

- remove documentation of full Bootmagic
- update links to Bootmagic Lite doc
- add doc for Magic Keycodes

* rules.mk patch for coarse/ixora and coarse/vinta
2021-08-06 23:59:56 -07:00
..
losinggeneration-common.h
losinggeneration-config.h
losinggeneration-keymap.h
README.md
rules.mk Remove Full Bootmagic (#13846) 2021-08-06 23:59:56 -07:00

README.md

losinggeneration's ortholinear layout

Features

  • Main layer(s)
    • The left space bar key has been changed to delete to have backspace & delete on the same main layer.
    • Adujst is a tap dance with one tap goes to the Adjust layer, second tap goes to the Numpad layer, a third tap goes to the Mouse layer. More taps are an error and disables tapping until you stop and try again.
    • Ctrl when tapped once & Ctrl+Alt when tapped twice
    • Left Alt when tapped once & Right Alt when tapped twice.
    • Left GUI when tapped once & right GUI when tapped twice. This is because I have a compose key on the right GUI key.
    • Left shift is a one shot modifier.
    • Enter when tapped Shift when held.
    • Esc when tapped Ctrl when held.
  • Lower & Raise
    • Removed ISO ~, ISO |, ISO #, ISO /, Media Next, & Media Play
    • Added PgUp, PgDn, Home, & End under the home row
    • Added Mute next to Vol-
  • New layers: Workman, Game, Numpad, & Mouse

Layouts

These include the 5x12 layout since it's nearly identical to the 4x12 layout. The only difference is the top row is removed for the 4x12 layout.

The Adjust layer keyboard specific, so it's described with the specific keyboard.

Qwerty

  ,-----------------------------------------..-----------------------------------------.
  |   `  |   1  |   2  |   3  |   4  |   5  ||   6  |   7  |   8  |   9  |   0  | Del  |
  |------+------+------+------+------+------||------+------+------+------+------+------|
  | 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 |
  |------+------+------+------+------+------||------+------+------+------+------+------|
  |Adjust| Ctrl | Alt  | GUI  |Lower | Bksp ||Space |Raise | Left | Down |  Up  |Right |
  `-----------------------------------------'`-----------------------------------------'

Colemak

 ,-----------------------------------------.,-----------------------------------------.
 |   `  |   1  |   2  |   3  |   4  |   5  ||   6  |   7  |   8  |   9  |   0  | Del  |
 |------+------+------+------+------+------||------+------+------+------+------+------|
 | Tab  |   Q  |   W  |   F  |   P  |   G  ||   J  |   L  |   U  |   Y  |   ;  | Bksp |
 |------+------+------+------+------+------||------+------+------+------+------+------|
 | Esc  |   A  |   R  |   S  |   T  |   D  ||   H  |   N  |   E  |   I  |   O  |  "   |
 |------+------+------+------+------+------||------+------+------+------+------+------|
 | Shift|   Z  |   X  |   C  |   V  |   B  ||   K  |   M  |   ,  |   .  |   /  |Enter |
 |------+------+------+------+------+------||------+------+------+------+------+------|
 |Adjust| Ctrl | Alt  | GUI  |Lower | Bksp ||Space |Raise | Left | Down |  Up  |Right |
 `-----------------------------------------'`-----------------------------------------'

Workman

 ,-----------------------------------------..-----------------------------------------.
 |   `  |   1  |   2  |   3  |   4  |   5  ||   6  |   7  |   8  |   9  |   0  | Del  |
 |------+------+------+------+------+------||------+------+------+------+------+------|
 | Tab  |   Q  |   D  |   R  |   W  |   B  ||   J  |   F  |   U  |   P  |   ;  | Bksp |
 |------+------+------+------+------+------||------+------+------+------+------+------|
 | Esc  |   A  |   S  |   H  |   T  |   G  ||   Y  |   N  |   E  |   O  |   I  |  "   |
 |------+------+------+------+------+------||------+------+------+------+------+------|
 | Shift|   Z  |   X  |   M  |   C  |   V  ||   K  |   L  |   ,  |   .  |   /  |Enter |
 |------+------+------+------+------+------||------+------+------+------+------+------|
 |Adjust| Ctrl | Alt  | GUI  |Lower | Bksp ||Space |Raise | Left | Down |  Up  |Right |
 `-----------------------------------------'`-----------------------------------------'

Dvorak

 ,-----------------------------------------..-----------------------------------------.
 |   `  |   1  |   2  |   3  |   4  |   5  ||   6  |   7  |   8  |   9  |   0  | Del  |
 |------+------+------+------+------+------||------+------+------+------+------+------|
 | Tab  |   "  |   ,  |   .  |   P  |   Y  ||   F  |   G  |   C  |   R  |   L  | Bksp |
 |------+------+------+------+------+------||------+------+------+------+------+------|
 | Esc  |   A  |   O  |   E  |   U  |   I  ||   D  |   H  |   T  |   N  |   S  |  /   |
 |------+------+------+------+------+------||------+------+------+------+------+------|
 | Shift|   ;  |   Q  |   J  |   K  |   X  ||   B  |   M  |   W  |   V  |   Z  |Enter |
 |------+------+------+------+------+------||------+------+------+------+------+------|
 |Adjust| Ctrl | Alt  | GUI  |Lower | Bksp ||Space |Raise | Left | Down |  Up  |Right |
 `-----------------------------------------'`-----------------------------------------'

Game (Qwerty without one shot modifiers & tap dancing)

 ,-----------------------------------------..-----------------------------------------.
 |   `  |   1  |   2  |   3  |   4  |   5  ||   6  |   7  |   8  |   9  |   0  | Del  |
 |------+------+------+------+------+------||------+------+------+------+------+------|
 | 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 |
 |------+------+------+------+------+------||------+------+------+------+------+------|
 |Adjust| Ctrl | Alt  | GUI  |Lower |Space ||Space |Raise | Left | Down |  Up  |Right |
 `-----------------------------------------'`-----------------------------------------'

Number pad

 ,-----------------------------------------..-----------------------------------------.
 | XXX  | XXX  | XXX  | XXX  | XXX  | XXX  || XXX  | NLCK |  *   |   /  | BKSP | BKSP |
 |------+------+------+------+------+------||------+------+------+------+------+------|
 | Tab  | XXX  | XXX  | XXX  | XXX  | XXX  || NLCK |   7  |  8   |   9  |  -   | BKSP |
 |------+------+------+------+------+------||------+------+------+------+------+------|
 | Esc  | XXX  | XXX  | XXX  | XXX  | XXX  ||  *   |   4  |  5   |   6  |  +   | BKSP |
 |------+------+------+------+------+------||------+------+------+------+------+------|
 |Shift | XXX  | XXX  | XXX  | XXX  | XXX  ||  /   |   1  |  2   |   3  | ENT  | XXX  |
 |------+------+------+------+------+------||------+------+------+------+------+------|
 |Adjust| Ctrl | Alt  | GUI  | XXX  |Space ||Space |   0  |  0   |   .  | ENT  | XXX  |
 `-----------------------------------------''-----------------------------------------'

Mouse movement

  • M is short for Mouse
  • MW is short for Mouse Wheel
  • MB is short for Mouse Button
  • MA is short for Mouse Acceleration

 

  • MB_1 is the left click
  • MB_2 is the right click
  • MB_3 is the middle click
 ,-----------------------------------------..-----------------------------------------.
 | XXX  | XXX  | XXX  | XXX  | XXX  | XXX  || XXX  | XXX  | XXX  | XXX  | XXX  | XXX  |
 |------+------+------+------+------+------||------+------+------+------+------+------|
 | Tab  | MB_1 | MB_3 | MB_2 | MB_4 | MB_5 || MA_0 | MB_1 | MB_3 | MB_2 | MB_4 | MB_5 |
 |------+------+------+------+------+------||------+------+------+------+------+------|
 | Esc  | MW_L | MW_U | MW_D | MW_R | XXX  || MA_1 | M_LT | M_UP | M_DN | M_RT | XXX  |
 |------+------+------+------+------+------||------+------+------+------+------+------|
 |Shift | MA_0 | MA_1 | MA_2 | XXX  | XXX  || MA_2 | MW_L | MW_U | MW_D | MW_R | XXX  |
 |------+------+------+------+------+------||------+------+------+------+------+------|
 |Adjust| Ctrl | Alt  | GUI  | XXX  |Space || XXX  | XXX  | XXX  |  XXX | XXX  | XXX  |
 `-----------------------------------------''-----------------------------------------'

Lower

 ,-----------------------------------------..-----------------------------------------.
 |   ~  |   !  |   @  |   #  |   $  |   %  ||   ^  |   &  |   *  |   (  |   )  | Del  |
 |------+------+------+------+------+------||------+------+------+------+------+------|
 |   ~  |   !  |   @  |   #  |   $  |   %  ||   ^  |   &  |   *  |   (  |   )  | Bksp |
 |------+------+------+------+------+------||------+------+------+------+------+------|
 | Del  |  F1  |  F2  |  F3  |  F4  |  F5  ||  F6  |   _  |   +  |      |   \  |  |   |
 |------+------+------+------+------+------||------+------+------+------+------+------|
 |      |  F7  |  F8  |  F9  |  F10 |  F11 ||  F12 | PgUp | PgDn | Home | End  |  ⏹   |
 |------+------+------+------+------+------||------+------+------+------+------+------|
 |      |      |      |      |      |      ||      |      | Mute | Vol- | Vol+ |  ⏯   |
 `-----------------------------------------'`-----------------------------------------'

Raise

 ,-----------------------------------------..-----------------------------------------.
 |   `  |   1  |   2  |   3  |   4  |   5  ||   6  |   7  |   8  |   9  |   0  | Del  |
 |------+------+------+------+------+------||------+------+------+------+------+------|
 |   `  |   1  |   2  |   3  |   4  |   5  ||   6  |   7  |   8  |   9  |   0  | Bksp |
 |------+------+------+------+------+------||------+------+------+------+------+------|
 | Del  |  F1  |  F2  |  F3  |  F4  |  F5  ||  F6  |   -  |   =  |   [  |   ]  |  \   |
 |------+------+------+------+------+------||------+------+------+------+------+------|
 |      |  F7  |  F8  |  F9  |  F10 |  F11 ||  F12 | PgUp | PgDn | Home | End  |  ⏹   |
 |------+------+------+------+------+------||------+------+------+------+------+------|
 |      |      |      |      |      |      ||      |      | Mute | Vol- | Vol+ |  ⏯   |
 `-----------------------------------------''-----------------------------------------'