summaryrefslogtreecommitdiff
path: root/keyboards/massdrop/ctrl/keymaps/endgame/README.md
diff options
context:
space:
mode:
authorAhmed Elshafey <12426718+ash0x0@users.noreply.github.com>2020-01-15 07:34:41 +0200
committerDrashna Jaelre <drashna@live.com>2020-01-14 21:34:41 -0800
commit3a69232213643ca77f81f3e6c359bb3ce9b2ecee (patch)
tree86b92ea35879512e5a1287606b7dc93b79e7da19 /keyboards/massdrop/ctrl/keymaps/endgame/README.md
parent2a6cb426efc8544a5a1de59106357ccef127e6b1 (diff)
[Keymap] Massdrop ctrl keymap (#7639)
* RGB config overhaul Changing RGB config from setrgb to sethsv, trying out different color values. * Merged changes * Various changes and a couple additions Added Git Layer with git macros for most operations and LED config to show the macro keys on layer. Activated with FN+3. Added VIM Layer, this is a normal keycode layer with no macros for now but it has LED config that highlights the navigation and edit keys in VIM. Added a sticky CTRL and sticky SHIFT layers. I have no idea why I did this actually, it's mildly useful but oneshot and tapdance would be better, will be removed in later commit. Changed the LED config from setrgb to sethsv and the key by key LED config to array. Some code improvements in process_record_user. Better way to manage string macros using char array. Inspired by drashna's secret macros. * Various keymap changes and added documentation Updated massdrop/ctrl endgame keymap: Added layers for git and vim. Better LED config method, using ledmap, similar to what's used in many other keymaps. Improved process_record_user() mainly with reduced conditionals. Cleaned things up in the header and config. Added pretty much all qmk feature headers to rules and config, commented out to be enabled if desired. Firmware size should be considered. Not many features added in this commit. Shifting for a while to work on implementing raw hid for the keyboard and expanding qmk terminal. Added documentation.md for massdrop/ctrl at keyboard level to house all related information for future use. Added documentation for raw hid in docs, added the doc to feature index. Need some review for this documentation and suggested additions/changes. * Some fixes Fixed keymap documentation to include changes. Removed useless double tap keys and simplified layer maps. * Fixed error in keymap * Removed documentation changes. Will present in another PR * Update keyboards/massdrop/ctrl/DOCUMENTATION.md Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update DOCUMENTATION.md * Update keymap.c fixed mouse layout incomplete arrow cluster * Update keyboards/massdrop/ctrl/keymaps/endgame/keymap.c Fixed Git layer led config Co-Authored-By: totolouis <totolouis@users.noreply.github.com> * Update DOCUMENTATION.md Remove raw hid details * Update rules.mk Remove useless stuff * fixed malformed led map causing compile fail, indentation fixes * Update keyboards/massdrop/ctrl/keymaps/endgame/config.h switch from TG_NKRO to NK_TOGG Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keymap.c Switching from TG_NKRO to NK_TOGG * Added yakuake layout * Update keyboards/massdrop/ctrl/keymaps/endgame/keymap.c Change biton32(layer_state) to get_highest_layer() Co-Authored-By: fauxpark <fauxpark@gmail.com> * Update keymap.c Change from biton32 to get_highest_layer * Fixed custom LED not toggling off Co-authored-by: fauxpark <fauxpark@gmail.com> Co-authored-by: totolouis <totolouis@users.noreply.github.com>
Diffstat (limited to 'keyboards/massdrop/ctrl/keymaps/endgame/README.md')
-rw-r--r--keyboards/massdrop/ctrl/keymaps/endgame/README.md24
1 files changed, 16 insertions, 8 deletions
diff --git a/keyboards/massdrop/ctrl/keymaps/endgame/README.md b/keyboards/massdrop/ctrl/keymaps/endgame/README.md
index 9a0b2d8efa..f65b70475f 100644
--- a/keyboards/massdrop/ctrl/keymaps/endgame/README.md
+++ b/keyboards/massdrop/ctrl/keymaps/endgame/README.md
@@ -6,15 +6,19 @@ This keymap is here to show some love to the MD Ctrl.
### Typing Layer
-![Typing Layer](https://i.imgur.com/1uSVUdU.png)
+![Typing Layer](https://imgur.com/QUIU2SL.png)
### Function Layer
-![Function Layer](https://i.imgur.com/rINs7ro.png)
+![Function Layer](https://imgur.com/4q4ld4X.png)
### Mouse Layer
-![Mouse Layer](https://i.imgur.com/IaS0nAB.png)
+![Mouse Layer](https://imgur.com/xXVFyEE.png)
+
+### Git Layer
+
+![Git Layer](https://imgur.com/WMMM0zz.png)
## Features
@@ -36,19 +40,23 @@ This allows setting a dynamic timeout for RGB to turn off. The following is supp
Not really a feature. I just want to document what tapdance keys this keymap has because there will be many of them.
1. LGUI is used for both LGUI and toggle mouse layer for double tap.
-2. LCTRL and RCTRL are used for their respective keycodes at single tap and to send LCTRL+LALT+T for double tap, which opens terminal in most environments.
+2. LCTRL sends LCTRL for single tap and LCTRL+LALT+T for double tap, which opens terminal in most environments.
## Future Work
By the time this is project has accomplished its original primary objectives, the following features will be available for the ctrl:
1. Automatic RGB timeout with all the options you would need. **DONE**
-2. Macro and Shortcut layers for at least the following: Git, IntelliJ, VIM, Yakuake, KDE, Firefox, Slack, Discord. All using default program configuration. [This list may and probably will get longer]
-3. Custom LED configs that offer all the RGB layouts I deem useful or having a unique feature, look or feel.
+2. Macro and Shortcut layers for at least the following: Git **DONE**, IntelliJ, VIM **WIP**, Yakuake, KDE, Firefox, Slack, Discord. All using default program configuration. [This list may and probably will get longer]
+3. Custom LED configs that offer all the RGB layouts I deem useful or having a unique feature, look or feel. **DONE**
4. Increased Dynamic Macro slots, because two simply isn't enough. This particular one falls outside Ctrl config and into QMK core modification. However, it is on the list of features I would like this keyboard to have and is a **TOP PRIORITY** for me. It won't be easy, but I will figure it out.
-5. Porting from the Drop, Inc. way of doing things to the QMK way of doing things, wherever possible. Full QMK support of this keyboard is the goal, not that it's possible, but I'd like to get as close as it gets.
+5. Porting from the Drop, Inc. way of doing things to the QMK way of doing things, wherever possible. Full QMK support of this keyboard is the goal, not that it's possible, but I'd like to get as close as it gets. **WIP**
6. An easier way to configure LED than both the QMK way and the Drop way. I'm thinking of a graphical LED config like Drop configurator that offers the advanced LED config features QMK offers. This may or may not get done depending on whether or not I get sick of QMK LED config at any point. If it does get done, it may or may not be added to QMK Configurator.
-7. Better documentation of the MD Ctrl specifications, features, etc. This will be included here in the form of C and doxygen comments. The bigger portion will be included in QMK docs if and where possible.
+7. Better documentation of the MD Ctrl specifications, features, etc. This will be included here in the form of C and doxygen comments. The bigger portion will be included in QMK docs if and where possible. **WIP**
+
+Additions:
+
+8. Implement Raw HID. **WIP**
This list will most probably either expand or have some items removed if they're deemed not worthy, probably both. Nothing will be removed because it can't be done though, I am a firm believer in You Can Do It. Anything modified in this list will be clearly marked, for posterity.