qmk-dactyl-manuform-a/keyboards/rgbkb/sol/keymaps/xyverz/readme.md

133 lines
8.2 KiB
Markdown
Raw Normal View History

[Keymap] Updating keymaps (#7170) * Added WOW layer * Initial commit for this branch. Still a work in progress. * Added Rorschach keyboard layout. * Simplified keymap Removed the media layer to help simplify things. Also corrected some keymap mistakes in the Qwerty and Colemak layers. * Added ErgoTravel keymap. * reverted to previous layout. * Added Sol keyboard layout. * Minor changes to keymap. * more changes * Added sol graphic by Kagerufu and Cardiactuna * Added colemak layer because I can. * more changes to sol layout * Streamlined Sol layout * minor tweaks to sol layout * further revisions to sol keymap. * Removing deprecated #include statements from my keymaps * Standardizing keymap `include` lines. * Minor change to keymap. Swapped ESC with GRV on all alpha layers. * Tweaks to Atreus62 Keymap Added a layer for FPS RPG Loot Shooters. * Fixed readme.md for Atreus keymap. Replaced "Keymap" with "Layer" in illustrations for continuity's sake * More readme.md clean-up More clarification in the Atreus readme file. * Next verse, same as the first. * Changes to Sol layout Bringing my Sol layout more in line with my other Orthos. * Fixed keymap GUI. Replaced left-hand "RGUI" with "LGUI" on all layers as it should be. * Added ALPS64 keymap * Formatting corrections * fixes to config.h and keymap.c * Fixed errors This commit fixes a pathing issue in keyboards/orthodox/keymaps/xyverz/config.h and removes an stupid comma at the end of each LAYOUT stanza in keyboards/rgbkb/sol/keymaps/xyverz/keymap.c left there by me. * Fixed orthodox keymap config.h file I hope this one fixes the problem. *sigh* * Making suggested changes for PR#6192 Thanks to noroadsleft, fauxpark, and drashna. Still have more work to do, but at least these suggestions have been applied. * Fixing build errors Travis has shown me the error of my ways... * More fixes and corrections Those pesky semicolons... * More Fixes. * Removing unneeded code snippet. * fixed omitted semicolons * Code updates to my keymaps Updating the code for my Iris, Atreus62, and Atreus keymaps. * Fixed Atreus62 Keymap I forgot to add in the aliases for LOWER, RAISE, and ADJUST. * Added userspace Also made changes to Atreus62 Keymap to turn the red LEDs off on the ProMicro * Fixing code that disables LEDs on ProMicros Also tidied up my ErgoTravel keymap. * Moving userspace to new branch Moving my userspace to a new branch for the sake of keeping things clean on the master branch. * Added F13-F15 to Atreus62 Layout. * Update readme.md. * Updated Phantom keymap to current keymap standards * Phantom keymap updates Further updates - tidying and removing cruft. Thank you zvecr on Discord for the help! * Standards Updates Bringing my Kinesis keymap up to current code standards * Adding a readme * Bring GH60 code to standard * Utilizing layouts for 60_ansi and tkl_ansi Moving my GH60 and Phantom keymaps into layouts/community/ * Alps64 layout removal Removing my Alps64 keymap now that I've setup my 60_ansi layout. * Moved Clueboard layout to community/66_ansi. * Additions to 66_ansi config.h * Bringing keymaps up to standard. * More updates to keymaps. * Syntax updates * Revert "Syntax updates" This reverts commit a892b2d9fcc0d4ba8fc22d676d5414120cc2c183. * Moved WIP keymaps Moved my WIP keymaps to my wip_keymaps branch to keep my master clean * Updates requested by noroadsleft * more changes per noroadsleft More fixes as requested by noroadsleft. Further tidy-up and standardization of my keymap code.
2019-10-29 00:09:01 +01:00
# Xyverz's Sol Layout
## Layout
### Base modifier layout
```
* ,------------------------------------------------. ,------------------------------------------------.
* | ESC | | | | | | - | | = | | | | | | \ |
* |------+------+------+------+------+------|------| |------|------+------+------+------+------+------|
* | Tab | | | | | | [ | | ] | | | | | | / |
* |------+------+------+------+------+------|------| |------|------+------+------+------+------+------|
* | Del | | | | | | | | | | | | | | |
* |------+------+------+------+------+------+------| |------+------+------+------+------+------+------|
* |Shift | | | | | | | | | | | | | |Shift |
* |------+------+------+------+------+------+------| |------+------+------+------+------+------+------|
* | Adj | Alt | ` | Left | Rght | Ctrl | Alt | | Alt | Ctrl | Up | Down | / | = | Adj |
* |------+------+------+------+------+------+------| |------+------+------+------+------+------+------'
* | BkSp | Win | | Enter| Space|
* `-------------' `-------------'
```
### Qwerty alphas
```
* ,------------------------------------------------. ,------------------------------------------------.
* | | | | | | | | | | | | | | | |
* |------+------+------+------+------+------|------| |------|------+------+------+------+------+------|
* | | 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 | , | . | / | |
* |------+------+------+------+------+------+------| |------+------+------+------+------+------+------|
* | | | | | | | | | | | | | | | |
* `------+------+------+------+------+------+------| |------+------+------+------+------+------+------'
* | | | | | |
* `-------------' `-------------'
```
### Dvorak alphas
```
* ,------------------------------------------------. ,------------------------------------------------.
* | | | | | | | | | | | | | | | |
* |------+------+------+------+------+------|------| |------|------+------+------+------+------+------|
* | | " | , | . | 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 | |
* |------+------+------+------+------+------+------| |------+------+------+------+------+------+------|
* | | | | | | | | | | | | | | | |
* `------+------+------+------+------+------+------| |------+------+------+------+------+------+------'
* | | | | | |
* `-------------' `--------=----'
```
### Colemak alphas
```
* ,------------------------------------------------. ,------------------------------------------------.
* | | | | | | | | | | | | | | | |
* |------+------+------+------+------+------|------| |------|------+------+------+------+------+------|
* | | 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 | , | . | / | |
* |------+------+------+------+------+------+------| |------+------+------+------+------+------+------|
* | | | | | | | | | | | | | | | |
* `------+------+------+------+------+------+------| |------+------+------+------+------+------+------'
* | | | | | |
* `-------------' `-------------'
```
### Adjust (ADJ)
```
* ,------------------------------------------------. ,------------------------------------------------.
* | F11 | F1 | F2 | F3 | F4 | F5 | RESET| | | F6 | F7 | F8 | F9 | F10 | F12 |
* |------+------+------+------+------+------|------| |------|------+------+------+------+------+------|
* | | |QWERTY|DVORAK|COLEMK| | | | | | PrSc | ScLk | NmLk | | |
* |------+------+------+------+------+------|------| |------|------+------+------+------+------+------|
* | | | Mute | Vol- | Vol+ | | | | |RGBTOG|RGBMOD| HUI | SAI | VAI | |
* |------+------+------+------+------+------+------| |------+------+------+------+------+------+------|
* | | | Prev | Play | Next | | | | | |RGBRMD| HUD | SAD | VAD | |
* |------+------+------+------+------+------+------| |------+------+------+------+------+------+------|
* | | | | Home | End | | | | | | PgUp | PgDn | | | |
* `------+------+------+------+------+------+------| |------+------+------+------+------+------+------'
* | Del | | | | Ins |
* `-------------' `-------------'
```
## Customize
see `qmk_firmware/keyboards/sol/rev1/keymaps/default/rules.mk`
```
# Variables you can set for SOL
BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration
MOUSEKEY_ENABLE = no # Mouse keys
EXTRAKEY_ENABLE = yes # Audio control and System control
CONSOLE_ENABLE = no # Console for debug
COMMAND_ENABLE = ne # Commands for debug and configuration
NKRO_ENABLE = yes # Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
RGBLIGHT_ENABLE = yes # Enable global lighting effects. Do not enable with RGB Matrix
LED_ANIMATIONS = yes # LED animations
LED_MIRRORED = no # Mirror LEDs across halves (enable DIP 1 on slave, and DIP 2 and 3 on master)
RGB_MATRIX_ENABLE = no # Enable per-key coordinate based RGB effects. Do not enable with RGBlight
RGB_MATRIX_KEYPRESSES = no # Enable reactive per-key effects. Can be very laggy
RGBLIGHT_FULL_POWER = no # Allow maximum RGB brightness. Otherwise, limited to a safe level for a normal USB-A port
UNICODE_ENABLE = no # Unicode
SWAP_HANDS_ENABLE = no # Enable one-hand typing
ENCODER_ENABLE_CUSTOM = yes # Enable rotary encoder
OLED_ENABLE = yes # OLED_ENABLE
IOS_DEVICE_ENABLE = no # Limit max brightness to connect to IOS device (iPad,iPhone)
```
## Compile
go to qmk top directory.
```
$ cd qmk_firmware
```
build
```
$ make sol:xyverz
```
After the initial flash with AVRdudess, you should be able to flash using this:
```
$ make sol:xyverz:flash
```