Add clarifying comments and add new (not bound by default) GAME layer #8
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a bit of clarifying text in the same style as the existing documentation, and a togglable gaming layer, which has no modkey functionality and contains WASD and other keys commonly needed for playing games.
I believe a separate layer is the best solution for gaming with a Miryoku keyboard, as e.g. using different layouts means you might not have WASD on your left hand, and importantly, regular keys have hold actions which interrupt gaming, like the space button, which doesn't register in games due to its modkey functionality.
I've seen a post of someone online trying to do the same, but they ended up changing and moving their entire modkey row to a less ergonomic position, this solution has no such compromises, and would be discoverable and understandable by anyone wishing to do the same.
The use-case for this kind of a layer means it doesn't make sense to make it a temporarily-switched-to layer like the others, it needs to be toggled, which goes against what seems to be the design philosophy and flow of Miryoku. That's the reason the layer doesn't have a binding by default.
If a togglable layer is considered an okay addition, I could suggest adding it to unused keys of the more obscure Button layer, like I've done on the personal branch of my fork, which is harder to accidentally press. Let me know and I can add this change as well.
If not, I still think an unused extra layer is a worthy addition, as the effort it takes to implement a new layer is relatively tedious, and requires trial-and-error. With this layer in the file, anyone wanting to add this functionality themselves can simply bind this extra layer, instead of possibly giving up on figuring out how to add a new layer. They could also easily repurpose this layer if they want to add a new layer for other reasons.
Of note, I couldn't find the toggle-layer commands for other layouts than ZMK and QMK, but a part of the added clarifying text also illuminates the need for layer changing commands to be supported in the keycode-translations table.