Keymap: Add noroadsleft keymap for KC60 (#3876)

[qmk_firmware.git] / keyboards / kc60 / keymaps / noroadsleft / readme_ch3.md

diff --git a/keyboards/kc60/keymaps/noroadsleft/readme_ch3.md b/keyboards/kc60/keymaps/noroadsleft/readme_ch3.md
new file mode 100644 (file)
index 0000000..80549ba
--- /dev/null
+++ b/keyboards/kc60/keymaps/noroadsleft/readme_ch3.md
@@ -0,0 +1,39 @@
+# @noroadsleft's KC60 keymap
+
+- [Table of Contents](./readme.md)
+  1. [Base Layers](./readme_ch1.md)
+  2. [OS Overlays](./readme_ch2.md)
+  3. **Quake 2 Overlays**
+  4. [Function Layers](./readme_ch4.md)
+  5. [Other Layers](./readme_ch5.md)
+
+### Last updated: September 2, 2018, 1:03 PM UTC-0700
+
+
+----
+
+## Layers 4, 5 and 6: Quake 2 `_Q2`, Quake 2 Dvorak `_QD`, and Quake 2 Console `_QC`
+
+### Accessed by holding either `Fn` key and tapping the `/?` key, then tapping `4$`
+
+These layers were born out of the confusion I have had trying to use the in-game chat and the console in [Quake 2](https://en.wikipedia.org/wiki/Quake_II). When Quake 2 came out, alternate keyboard layouts weren't really a thing. As a result, all in-game text input is hard-locked to US QWERTY, regardless of what the operating system is using for its input method.
+
+I'm attempting to solve this by some creative use of QMK's macro feature. The keycode in the System layer that enables these layers, [`GO_Q2`](./keymap.c#L386), is a [macro](./keymap.c#L175-183) that sets the default layer to the QWERTY layer, then turns the Quake 2 layer `_Q2` on. The result is a partially-overwritten QWERTY layer, that has some keycodes with some creative layer switching.
+
+When I hit the `Enter` key (bound in-game to text chat), the [macro keycode](./keymap.c#L184-L191) I've created sends the keycode for `Enter`, then follows with enabling the Hardware Dvorak layer and its corresponding overlay. Now the game is in text chat mode, and my keyboard is in Dvorak. When I hit `Enter` again, another `Enter` [keycode macro](./keymap.c#L192-L199) is sent, which sends the message, then the macro brings me back to the standard QWERTY+Quake 2 setup. Hitting `Escape` instead runs a [macro](./keymap.c#L200-L207) that cancels the sending of the message, and undoes the layers.
+
+I have been testing this configuration for a few months. Sometimes I end up still in Dvorak mode without any text input systems (in-game chat or the console) running, but it pretty much always happens when I'm focused on the game, so I don't know the cause yet.
+
+### Layer 4: Quake 2
+![Quake 2](https://i.imgur.com/WEZ9p2u.png)
+
+### Layer 5: Quake 2 Dvorak
+![Quake 2 Dvorak](https://i.imgur.com/rhugHN4.png)
+
+### Layer 6: Quake 2 Console
+![Quake 2 Console](https://i.imgur.com/dRTAjcy.png)
+
+
+----
+
+Next Chapter: [Function Layers](./readme_ch4.md)