-
-
Notifications
You must be signed in to change notification settings - Fork 126
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.
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
Add reference images for KMonad Lite default and QWERTY layouts #106
base: master
Are you sure you want to change the base?
Conversation
Great idea, thanks! That'll be a nice addition! Did you edit the Layer Reference diagram and re-arrange the keys? The lite mapping is intended to be used just for alphas, mods, and Nav, and by using the rest of the keys as usual. (Although with the default layers option (non-flip) the thumb keys are also mapped to their corresponding Base tap keys, so they can also be used for layers as an alternative to the rest of the keys, but it might get awkward for some, especially if mods are also involved.) With that in mind, it might be nice to un-ghost the rest of the keys and add their default legends? That would require choosing a particular layout though, so might need some consideration first. |
Hmmm, let's see what I've been thinking... yes, I modified data/layers/miryoku-kle-reference to the shape of the "Default 60%" (and ISO variant) and as suggested in #71, replaced the base layer legends as one would for QWERTY. However, I haven't wrapped my head entirely around babel yet (though it looks awesome!), so don't know what you've been doing in #72 - and looking at these raw JSON, particularly compared to the KLE samples, there may be a lot of cruft in there (I certainly don't know yet whether I maintained any order). It's what I refer to in my opening caveat, it could be a bad idea to introduce anything which would be manually maintained (hmm, except for attracting nitpickers like me? :-D). Default legends - sure! I don't think EurKey or US Intl QWERTY would be too presumptuous (yes, I too looked for AltGr as in #53). Something like my personal UncleCJ:miryoku:development/data/layers/miryoku-kle-reference-lite-qwerty-vi-iso-apple.png? Digressing for a moment, but dipping my toe into something this esoteric, basically KMonad, I feel inevitably irreverent. Though certainly Miryoku Colemak-DH on QMK is something to be desired, I'm simply not there yet. So, I appreciate your insight into how Miryoku (Lite, QWERTY) is intended to be utilized, and will continue improving my setup... and yeah, am glad you seem to agree it could be a useful lowering of the barrier to entry (my first attempt, I simply didn't notice the default, non-lite mapping was one row up). With all that said, I suggest not to be in a hurry to merge this, I'll be happy to bake this a bit further. Slightly off topic - but as my first QMK-capable Corne is being shipped from Poland to Sweden (any thoughts on how to utilize the sixth columns?), my substitute Windows 11 KMonad setup really does not feel "production ready" - shutting KMonad down almost freeze my system, sends a bunch of 'ccccccccccc' everywhere and I probably manage to occasionally get stuck in some layers... that project being what it is, besides |
See the first paragraph here: #98 (reply in thread). For my first crkbd, I removed the outer pinkie columns with a hacksaw!
I can't really help with windows, but perhaps there are more and less graceful methods for exiting. Try searching and asking on the KMonad discord and issues, I'm sure someone must have had the same problem. Getting stuck in layers is probably the layer lock though. See https://github.com/manna-harbour/miryoku/tree/master/docs/reference#additional-features and #93. |
The goals for #72 are to auto generate (for any combination of alternative layout options) individual layer diagrams that are printable (high res, suitable use of colour) and can also replace the individual layer diagrams used at https://github.com/manna-harbour/miryoku/tree/master/docs/reference#layers. It eventually should also be able to generate the combined layers reference diagram. But there's no plan yet for supporting different physical layouts, and KLE will probably still be used for the mapping diagrams used at https://github.com/manna-harbour/miryoku_qmk/tree/miryoku/users/manna-harbour_miryoku#community-layouts (and they are only made when a layout is already available for KLE). At the moment the SVG generation is based on https://github.com/callum-oakley/keymap, so the physical layout just a grid, but I'd consider adding support for https://github.com/ergogen/ergogen layout descriptions at some point. So for the diagram you're making, it probably has to be done manually in KLE. It might be possible to turn the KLE json into a skeleton for something like Miryoku SVG, and have it fill in the legends, but in general I think KLE is a bit of a dead end in general now, given the support status and limitations, so I'm not so interested in that option. |
Thanks for the various advice! Again, my context has developed - as I built my first crkbd and 1) miryoku_qmk didn't seem to easily support the OLED displays or RGB backlights (or Via, but again, that has its own issues) 2) I realized I wanted Miryoku variations not supported as options (let's see, numpad layout, F-keys and just generally additions which felt logical to me) 3) I certainly need the Thus, the KLE illustration is for me personally slightly less relevant now... I did tinker some more with it, discovering I can decrease redundancy in the profile as well as align it with the babel row-wise description... except KLE will helpfully transpose it and mess up my tedious effort... So will see whether I find any way forward, in that case of course I'd get in touch. Thanks for the |
abd4178
to
d42c8b5
Compare
In manna-harbour#106 Manna Harbour alerted me to the intended use of Lite layout variations - to enable mod taps and the navigation layer without requiring the thumb keys from ortho keyboards. Rather, Lite layouts are intended to provide the minimum viable additions to standard keyboards, so in this version I have only kept those legends. Also, rather than bothering with the Miryoku theme (necessary to keep all those layer legend variations legible), these diagrams are additions to the KLE presets for 60% keyboards. I am eyeing the [hysp keymap diagrams](https://github.com/alvaro-prieto/corne) to come up with a more pleasant color theme. Obviously, if one want to merge my contributions it could be necessary to perform also other subsequent changes to align with these. Let me know and perhaps I could do that work. A minor note - commonly shift layers are illustrated as primary (eg. '1') at the bottom and shifted ('!') above it. In KLE this comes out as shifted in the _primary_ position. Also I guessed a bit in terms of how the Miryoku layouts position punctuation keys versus how they are in standard layouts. If one would want to generate these from Bab el, it would be something to keep in mind. This time, the screenshots are, as the originals, carefully made pixel perfect in Gimp to maintain the transparent corners of the images.
I redid the ANSI Lite layouts according to the comments and hope you agree they look way nicer now. As mentioned before, and even more so once the purpose of Lite variations was clarified, I think it is a really great entry level usage of Miryoku worth illustrating. In fact, I'll try again to get it going on my machines so I can still use mod tapping when my custom keyboard is not available. Thanks! |
In manna-harbour#106 Manna Harbour alerted me to the intended use of Lite layout variations - to enable mod taps and the navigation layer without requiring the thumb keys from ortho keyboards. Rather, Lite layouts are intended to provide the minimum viable additions to standard keyboards, so in this version I have only kept those legends. Also, rather than bothering with the Miryoku theme (necessary to keep all those layer legend variations legible), these diagrams are additions to the KLE presets for 60% keyboards. I am eyeing the [hysp keymap diagrams](https://github.com/alvaro-prieto/corne) to come up with a more pleasant color theme. Obviously, if one want to merge my contributions it could be necessary to perform also other subsequent changes to align with these. Let me know and perhaps I could do that work. A minor note - commonly shift layers are illustrated as primary (eg. '1') at the bottom and shifted ('!') above it. In KLE this comes out as shifted in the _primary_ position. Also I guessed a bit in terms of how the Miryoku layouts position punctuation keys versus how they are in standard layouts. If one would want to generate these from Bab el, it would be something to keep in mind. This time, the screenshots are, as the originals, carefully made pixel perfect in Gimp to maintain the transparent corners of the images.
In manna-harbour#106 Manna Harbour alerted me to the intended use of Lite layout variations - to enable mod taps and the navigation layer without requiring the thumb keys from ortho keyboards. Rather, Lite layouts are intended to provide the minimum viable additions to standard keyboards, so in this version I have only kept those legends. Also, rather than bothering with the Miryoku theme (necessary to keep all those layer legend variations legible), these diagrams are additions to the KLE presets for 60% keyboards. I am eyeing the [hysp keymap diagrams](https://github.com/alvaro-prieto/corne) to come up with a more pleasant color theme. Obviously, if one want to merge my contributions it could be necessary to perform also other subsequent changes to align with these. Let me know and perhaps I could do that work. A minor note - commonly shift layers are illustrated as primary (eg. '1') at the bottom and shifted ('!') above it. In KLE this comes out as shifted in the _primary_ position. Also I guessed a bit in terms of how the Miryoku layouts position punctuation keys versus how they are in standard layouts. If one would want to generate these from Bab el, it would be something to keep in mind. This time, the screenshots are, as the originals, carefully made pixel perfect in Gimp to maintain the transparent corners of the images.
In manna-harbour#106 Manna Harbour alerted me to the intended use of Lite layout variations - to enable mod taps and the navigation layer without requiring the thumb keys from ortho keyboards. Rather, Lite layouts are intended to provide the minimum viable additions to standard keyboards, so in this version I have only kept those legends. Also, rather than bothering with the Miryoku theme (necessary to keep all those layer legend variations legible), these diagrams are additions to the KLE presets for 60% keyboards. I am eyeing the [hysp keymap diagrams](https://github.com/alvaro-prieto/corne) to come up with a more pleasant color theme. Obviously, if one want to merge my contributions it could be necessary to perform also other subsequent changes to align with these. Let me know and perhaps I could do that work. A minor note - commonly shift layers are illustrated as primary (eg. '1') at the bottom and shifted ('!') above it. In KLE this comes out as shifted in the _primary_ position. Also I guessed a bit in terms of how the Miryoku layouts position punctuation keys versus how they are in standard layouts. If one would want to generate these from Bab el, it would be something to keep in mind. This time, the screenshots are, as the originals, carefully made pixel perfect in Gimp to maintain the transparent corners of the images.
In manna-harbour#106 Manna Harbour alerted me to the intended use of Lite layout variations - to enable mod taps and the navigation layer without requiring the thumb keys from ortho keyboards. Rather, Lite layouts are intended to provide the minimum viable additions to standard keyboards, so in this version I have only kept those legends. Also, rather than bothering with the Miryoku theme (necessary to keep all those layer legend variations legible), these diagrams are additions to the KLE presets for 60% keyboards. I am eyeing the [hysp keymap diagrams](https://github.com/alvaro-prieto/corne) to come up with a more pleasant color theme. Obviously, if one want to merge my contributions it could be necessary to perform also other subsequent changes to align with these. Let me know and perhaps I could do that work. A minor note - commonly shift layers are illustrated as primary (eg. '1') at the bottom and shifted ('!') above it. In KLE this comes out as shifted in the _primary_ position. Also I guessed a bit in terms of how the Miryoku layouts position punctuation keys versus how they are in standard layouts. If one would want to generate these from Bab el, it would be something to keep in mind. This time, the screenshots are, as the originals, carefully made pixel perfect in Gimp to maintain the transparent corners of the images.
In manna-harbour#106 Manna Harbour alerted me to the intended use of Lite layout variations - to enable mod taps and the navigation layer without requiring the thumb keys from ortho keyboards. Rather, Lite layouts are intended to provide the minimum viable additions to standard keyboards, so in this version I have only kept those legends. Also, rather than bothering with the Miryoku theme (necessary to keep all those layer legend variations legible), these diagrams are additions to the KLE presets for 60% keyboards. I am eyeing the [hysp keymap diagrams](https://github.com/alvaro-prieto/corne) to come up with a more pleasant color theme. Obviously, if one want to merge my contributions it could be necessary to perform also other subsequent changes to align with these. Let me know and perhaps I could do that work. A minor note - commonly shift layers are illustrated as primary (eg. '1') at the bottom and shifted ('!') above it. In KLE this comes out as shifted in the _primary_ position. Also I guessed a bit in terms of how the Miryoku layouts position punctuation keys versus how they are in standard layouts. If one would want to generate these from Bab el, it would be something to keep in mind. This time, the screenshots are, as the originals, carefully made pixel perfect in Gimp to maintain the transparent corners of the images.
@manna-harbour hi! I hope you’re not feeling pestered by these comments or suggestions - I fidget with them for my own benefit, because it’s enjoyable and with a slight hope it may be useful for others. With that in mind I wanted to write some general comments and questions. Please pardon I won’t be cross referencing right now.
All in all, I even got KMonad working decently now and with each step appreciate the logic of Miryoku, so would be quite happy both to “paint within its lines” and to contribute to it in any way I can. Thank you so much! |
For customisation in general see #85.
For OLED and RGB see the
To substitute custom layers, see the
Via / Vial / Remap support is a whole other thing which I haven't even begun looking into...
Nice! Using
Yeah, I still think KLE is probably a dead end...
I've been extending it slightly as I go, but not for other physical layouts yet. |
That looks great, thanks! I'll definitely be adding that! Actually, even your previous "complete" version was useful as it illustrated the other thumbs being mapped to the corresponding keys. But really this new version perfectly shows the intention of the lite mapping.
Great! |
Hmm, yes… assuming you’re not in a too great hurry, perhaps I’ll try some other variation and try to fit it into the documentation wording, or do you wanna do that last bit yourself? Collaborating like this is quite a peculiar thing (though Git expert is a significant part of my profile), but I find it quite rewarding to figure out :-) The latest version had only the Nav layer and mods, but as I picked the 60% template to modify, I realized one probably would want the Function layer, and perhaps even “num pad”, except the layer modifiers (if that is what we call the thumb keys) looked so awkward strewn all over a regular keyboard, and the KMonad config doesn’t exclude any layers out of the box (which newcomers would be expecting)… Anyway, as I follow you responding to my comments in sequence, I’ll just interject that indeed both my Corne and KMonad seem to work excellently with Miryoku now, I’ve seen your Side note, sharing the passion - my partner is getting into resin key caps casting so will be inheriting the Falba MX Corne while soldering a new acrylic case low profile Choc Corne for me <3 Let’s see how my monkeytype and Colemak Club exercises come along and whether I can inspire some household competition ;-) Take care and have lovely days! |
Sorry if I'm sometimes slow to reply. I definitely appreciate your efforts! Feel free to create new posts in the Discussions (#8) if there are issues you'd like to explore further individually, or send me a DM on discord (https://github.com/manna-harbour/manna-harbour/tree/main/contact) if you'd like to chat. But this is your PR, so do with it what you will!
Layers and mapping diagrams are in general pretty separate, they just both happen to be using KLE at the moment. Layer diagrams will be covered by #72. Mapping diagrams I don't see as being so important. I'll be reorganising the mappings soon (standardising between Miryoku QMK and Miryoku ZMK and probably also combining the docs) and just the text descriptions should cover the majority of mappings. Although no doubt the diagrams are still helpful in many cases. But at the moment they are only provided where a KLE is already available for that keyboard. The lite mapping is a special case though as it's a hybrid mapping, having only Base and partial Nav, and including the rest of the default keymap, and definitely benefits from your inclusion of the legends. But I think it's ok to keep it in with the other mappings for now, at least until Miryoku SVG can handle its generation.
The logo URLs I just update when I otherwise need to change something. AltGr was left out deliberately but is included now with Miryoku SVG. I haven't notice the issue with tab though? From now, changes to the layer diagrams should be done via Miryoku SVG as that will soon replace the current KLE versions (well, the per layer diagrams at least, to begin).
I think Miryoku SVG should be able to handle substituting legends into the current JSON as is, without needing any rearrangement, as it's done via
I'll have to get back to you on that one!
So the comfort order of the thumb keys is the one assumption of the physical layout. Generally if you use a few boards I find you can be pretty flexible with the absolute positions. Ideally though the physical layout would be a perfect match for you hand. I don't recommend changing the relative positions though unless it's completely unavoidable (e.g. le chiffre) as it breaks your muscle memory compatibility with the ideal physical layout as well as almost all other boards. For crkbd, the 1.5u key is mostly just historical baggage and doesn't indicate that it is supposed to be the home thumb. The crkbd thumbs are shifted around 0.5u from their ideal positions though, so the 1.5u key is closer to the resting position than it should be, but it still shouldn't take long to get used to homing on the middle.
Yeah the alternative alpha arrangements are really just the alphas. But there needs to be some accommodation for remapping on the host based on standard QWERTY. See #35. Perhaps by Extra having the swap and also being connected to an alternative swapped copy of Num / Sym...
Great!
Nice! Yeah, better international support is something else I'd like to include... One approach to support localised layouts on the host would be to load the keycode translations into Miryoku Babel and have it output the localised codes. There are also plenty of options when using more generic international layouts on the host.
Auto shift is enabled in Miryoku QMK for numbers and symbols. For Miryoku ZMK and Miryoku KMonad see #36.
Excellent! For Miryoku SVG, as soon as the core functions are there I'd be happy to add you to the private repo if you'd like to play around with it. There are plenty of open issues you might be interested in. The colour scheme and other aspects of the styles, legends, support for other physical layouts (e.g. via ergogen), KLE JSON legend substitution, and of course any other issues you've noticed with the current diagrams. |
In manna-harbour#106 Manna Harbour alerted me to the intended use of Lite layout variations - to enable mod taps and the navigation layer without requiring the thumb keys from ortho keyboards. Rather, Lite layouts are intended to provide the minimum viable additions to standard keyboards, so in this version I have only kept those legends. Also, rather than bothering with the Miryoku theme (necessary to keep all those layer legend variations legible), these diagrams are additions to the KLE presets for 60% keyboards. I am eyeing the [hysp keymap diagrams](https://github.com/alvaro-prieto/corne) to come up with a more pleasant color theme. Obviously, if one want to merge my contributions it could be necessary to perform also other subsequent changes to align with these. Let me know and perhaps I could do that work. A minor note - commonly shift layers are illustrated as primary (eg. '1') at the bottom and shifted ('!') above it. In KLE this comes out as shifted in the _primary_ position. Also I guessed a bit in terms of how the Miryoku layouts position punctuation keys versus how they are in standard layouts. If one would want to generate these from Bab el, it would be something to keep in mind. This time, the screenshots are, as the originals, carefully made pixel perfect in Gimp to maintain the transparent corners of the images.
2ef12f3
to
4e5d6cb
Compare
In manna-harbour#106 Manna Harbour alerted me to the intended use of Lite layout variations - to enable mod taps and the navigation layer without requiring the thumb keys from ortho keyboards. Rather, Lite layouts are intended to provide the minimum viable additions to standard keyboards, so in this version I have only kept those legends. Also, rather than bothering with the Miryoku theme (necessary to keep all those layer legend variations legible), these diagrams are additions to the KLE presets for 60% keyboards. I am eyeing the [hysp keymap diagrams](https://github.com/alvaro-prieto/corne) to come up with a more pleasant color theme. Obviously, if one want to merge my contributions it could be necessary to perform also other subsequent changes to align with these. Let me know and perhaps I could do that work. A minor note - commonly shift layers are illustrated as primary (eg. '1') at the bottom and shifted ('!') above it. In KLE this comes out as shifted in the _primary_ position. Also I guessed a bit in terms of how the Miryoku layouts position punctuation keys versus how they are in standard layouts. If one would want to generate these from Bab el, it would be something to keep in mind. This time, the screenshots are, as the originals, carefully made pixel perfect in Gimp to maintain the transparent corners of the images.
In manna-harbour#106 Manna Harbour alerted me to the intended use of Lite layout variations - to enable mod taps and the navigation layer without requiring the thumb keys from ortho keyboards. Rather, Lite layouts are intended to provide the minimum viable additions to standard keyboards, so in this version I have only kept those legends. Also, rather than bothering with the Miryoku theme (necessary to keep all those layer legend variations legible), these diagrams are additions to the KLE presets for 60% keyboards. I am eyeing the [hysp keymap diagrams](https://github.com/alvaro-prieto/corne) to come up with a more pleasant color theme. Obviously, if one want to merge my contributions it could be necessary to perform also other subsequent changes to align with these. Let me know and perhaps I could do that work. A minor note - commonly shift layers are illustrated as primary (eg. '1') at the bottom and shifted ('!') above it. In KLE this comes out as shifted in the _primary_ position. Also I guessed a bit in terms of how the Miryoku layouts position punctuation keys versus how they are in standard layouts. If one would want to generate these from Bab el, it would be something to keep in mind. This time, the screenshots are, as the originals, carefully made pixel perfect in Gimp to maintain the transparent corners of the images.
In manna-harbour#106 Manna Harbour alerted me to the intended use of Lite layout variations - to enable mod taps and the navigation layer without requiring the thumb keys from ortho keyboards. Rather, Lite layouts are intended to provide the minimum viable additions to standard keyboards, so in this version I have only kept those legends. Also, rather than bothering with the Miryoku theme (necessary to keep all those layer legend variations legible), these diagrams are additions to the KLE presets for 60% keyboards. I am eyeing the [hysp keymap diagrams](https://github.com/alvaro-prieto/corne) to come up with a more pleasant color theme. Obviously, if one want to merge my contributions it could be necessary to perform also other subsequent changes to align with these. Let me know and perhaps I could do that work. A minor note - commonly shift layers are illustrated as primary (eg. '1') at the bottom and shifted ('!') above it. In KLE this comes out as shifted in the _primary_ position. Also I guessed a bit in terms of how the Miryoku layouts position punctuation keys versus how they are in standard layouts. If one would want to generate these from Bab el, it would be something to keep in mind. This time, the screenshots are, as the originals, carefully made pixel perfect in Gimp to maintain the transparent corners of the images.
I completely understand if one doesn't want to bother with all of these variations, but at least illustrations of the "lite" layout also in QWERTY variant (using KMonad) would have attracted me to the project even quicker. Screenshots are made manually from [kle](http://www.keyboard-layout-editor.com) at 150%, because the download options are (poorly) experimental
In manna-harbour#106 Manna Harbour alerted me to the intended use of Lite layout variations - to enable mod taps and the navigation layer without requiring the thumb keys from ortho keyboards. Rather, Lite layouts are intended to provide the minimum viable additions to standard keyboards, so in this version I have only kept those legends. Also, rather than bothering with the Miryoku theme (necessary to keep all those layer legend variations legible), these diagrams are additions to the KLE presets for 60% keyboards. I am eyeing the [hysp keymap diagrams](https://github.com/alvaro-prieto/corne) to come up with a more pleasant color theme. Obviously, if one want to merge my contributions it could be necessary to perform also other subsequent changes to align with these. Let me know and perhaps I could do that work. A minor note - commonly shift layers are illustrated as primary (eg. '1') at the bottom and shifted ('!') above it. In KLE this comes out as shifted in the _primary_ position. Also I guessed a bit in terms of how the Miryoku layouts position punctuation keys versus how they are in standard layouts. If one would want to generate these from Bab el, it would be something to keep in mind. This time, the screenshots are, as the originals, carefully made pixel perfect in Gimp to maintain the transparent corners of the images.
4e5d6cb
to
5682443
Compare
In manna-harbour#106 Manna Harbour alerted me to the intended use of Lite layout variations - to enable mod taps and the navigation layer without requiring the thumb keys from ortho keyboards. Rather, Lite layouts are intended to provide the minimum viable additions to standard keyboards, so in this version I have only kept those legends. Also, rather than bothering with the Miryoku theme (necessary to keep all those layer legend variations legible), these diagrams are additions to the KLE presets for 60% keyboards. I am eyeing the [hysp keymap diagrams](https://github.com/alvaro-prieto/corne) to come up with a more pleasant color theme. Obviously, if one want to merge my contributions it could be necessary to perform also other subsequent changes to align with these. Let me know and perhaps I could do that work. A minor note - commonly shift layers are illustrated as primary (eg. '1') at the bottom and shifted ('!') above it. In KLE this comes out as shifted in the _primary_ position. Also I guessed a bit in terms of how the Miryoku layouts position punctuation keys versus how they are in standard layouts. If one would want to generate these from Bab el, it would be something to keep in mind. This time, the screenshots are, as the originals, carefully made pixel perfect in Gimp to maintain the transparent corners of the images.
I completely understand if one doesn't want to bother with all of these variations, but at least illustrations of the "lite" layout also in QWERTY variant (using KMonad) would have attracted me to the project even quicker.
Screenshots are made manually from KLE at 150%, because the download options are (poorly) experimental
This is in reference to #71 (although I noticed #72 only now...) and I would love to tidy the JSON (how does KLE classify types of legends?) but no rush - use (and modify) these only if they make sense in a general plan. There are a couple more options in UncleCJ:miryoku:development