summaryrefslogtreecommitdiff
path: root/keyboards/bastardkb/dilemma/4x6_4/keymaps/via/readme.md
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2023-10-01 17:56:31 +0000
committerQMK Bot <hello@qmk.fm>2023-10-01 17:56:31 +0000
commite78fe5f77b51ce8e28d652d3c5dfa39f8b84e38b (patch)
tree0bafd73e96b254a1a27c4bacf4559845ed06fe13 /keyboards/bastardkb/dilemma/4x6_4/keymaps/via/readme.md
parentda5d745c73936eb15caaac5321690d0a551a5938 (diff)
parent1b7a538353347e564edce2c78a7b155a50ac3c4b (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'keyboards/bastardkb/dilemma/4x6_4/keymaps/via/readme.md')
-rw-r--r--keyboards/bastardkb/dilemma/4x6_4/keymaps/via/readme.md47
1 files changed, 47 insertions, 0 deletions
diff --git a/keyboards/bastardkb/dilemma/4x6_4/keymaps/via/readme.md b/keyboards/bastardkb/dilemma/4x6_4/keymaps/via/readme.md
new file mode 100644
index 0000000000..f3636c8a40
--- /dev/null
+++ b/keyboards/bastardkb/dilemma/4x6_4/keymaps/via/readme.md
@@ -0,0 +1,47 @@
+# Dilemma Max `via` keymap
+
+The Dilemma Max `via` keymap is based on the original [Dactyl Manuform](../../../../../handwired/dactyl_manuform) default keymap, with some features and changes specific to the Dilemma.
+
+This layout also supports VIA.
+
+## Customizing the keymap
+
+### Dynamic DPI scaling
+
+Use the following keycodes to change the default DPI:
+
+- `POINTER_DEFAULT_DPI_FORWARD`: increases the DPI; decreases when shifted;
+- `POINTER_DEFAULT_DPI_REVERSE`: decreases the DPI; increases when shifted.
+
+There's a maximum of 16 possible values for the sniping mode DPI. See the [Dilemma documentation](../../README.md) for more information.
+
+Use the following keycodes to change the sniping mode DPI:
+
+- `POINTER_SNIPING_DPI_FORWARD`: increases the DPI; decreases when shifted;
+- `POINTER_SNIPING_DPI_REVERSE`: decreases the DPI; increases when shifted.
+
+There's a maximum of 4 possible values for the sniping mode DPI. See the [Dilemma documentation](../../README.md) for more information.
+
+### Drag-scroll
+
+Use the `DRAGSCROLL_MODE` keycode to enable drag-scroll on hold. Use the `DRAGSCROLL_TOGGLE` keycode to enable/disable drag-scroll on key press.
+
+### Circular scroll
+
+By default, the firmware is configured to enable the circular scroll feature on Cirque trackpad.
+
+To disable this, add the following to your keymap:
+
+```c
+#undef POINTING_DEVICE_GESTURES_SCROLL_ENABLE
+```
+
+### Sniping
+
+Use the `SNIPING_MODE` keycode to enable sniping mode on hold. Use the `SNIPING_TOGGLE` keycode to enable/disable sniping mode on key press.
+
+Change the value of `DILEMMA_AUTO_SNIPING_ON_LAYER` to automatically enable sniping mode on layer change. By default, sniping mode is enabled on the pointer layer:
+
+```c
+#define DILEMMA_AUTO_SNIPING_ON_LAYER LAYER_POINTER
+```