summaryrefslogtreecommitdiff
path: root/users/drashna/pointing/readme.md
diff options
context:
space:
mode:
authorDrashna Jaelre <drashna@live.com>2021-12-29 20:17:34 -0800
committerGitHub <noreply@github.com>2021-12-29 20:17:34 -0800
commitc4551d7ef1ed2c1069f23cc8499b7c7fc30f3ecf (patch)
tree67dc381a45d59626132c4c59b71c4b36fa971f8b /users/drashna/pointing/readme.md
parent1a8a842cfb3e87a82afb57ba29ca59c5fa6fe97b (diff)
downloadqmk_firmware-c4551d7ef1ed2c1069f23cc8499b7c7fc30f3ecf.tar.gz
qmk_firmware-c4551d7ef1ed2c1069f23cc8499b7c7fc30f3ecf.zip
[Keymap] Reorganization, cleanup and readmes for drashna code (#15617)
Diffstat (limited to 'users/drashna/pointing/readme.md')
-rw-r--r--users/drashna/pointing/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/users/drashna/pointing/readme.md b/users/drashna/pointing/readme.md
new file mode 100644
index 0000000000..7770755050
--- /dev/null
+++ b/users/drashna/pointing/readme.md
@@ -0,0 +1,19 @@
+# User Pointing Device customization
+
+To disable the customized pointing device code and implement it at the keymap, add `CUSTOM_POINTING_DEVICE = no` to your `rules.mk`.
+
+## Automatic Mouse Layer
+
+Movement on the optical sensor triggers a layer that has all of the mouse keys on that layer. After a set time, the layer will automatically turn itself off after 650ms.
+
+Also, using mousekeys will extend the amount of time that the layer will stay active.
+
+Additionally, layer keys for the mouse layer will lock the layer on.
+
+## Gaming
+
+When the gamepad or diablo layers are enabled, the mouse layer is locked on, as well.
+
+## Keycodes
+
+The only custom keycode for Pointing devices here is `KC_ACCEL`. This allow the mouse report to have an acceleration curve (exponential).