diff options
| author | Nick Brassel <nick@tzarc.org> | 2024-02-28 21:47:37 +1100 |
|---|---|---|
| committer | Nick Brassel <nick@tzarc.org> | 2024-02-28 21:47:37 +1100 |
| commit | 4e369d405af6bba1adce6337b2e1b1ea1788566c (patch) | |
| tree | b0f020feff1809e37c9e7795d344929ff0bb290a /keyboards/bastardkb/dilemma/3x5_3/keymaps/via/readme.md | |
| parent | 4e04da397ef643f8fcf4afbe1d19f63aee1fc561 (diff) | |
| parent | dd1706e468bb18dd7f7ae143de735a5d3be1bfb8 (diff) | |
Merge branch 'develop'
Diffstat (limited to 'keyboards/bastardkb/dilemma/3x5_3/keymaps/via/readme.md')
| -rw-r--r-- | keyboards/bastardkb/dilemma/3x5_3/keymaps/via/readme.md | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/keyboards/bastardkb/dilemma/3x5_3/keymaps/via/readme.md b/keyboards/bastardkb/dilemma/3x5_3/keymaps/via/readme.md new file mode 100644 index 0000000000..4552f0948d --- /dev/null +++ b/keyboards/bastardkb/dilemma/3x5_3/keymaps/via/readme.md @@ -0,0 +1,47 @@ +# Dilemma `via` keymap + +The Dilemma `via` keymap is based on a QWERTY layout with [home row mods](https://precondition.github.io/home-row-mods) and [Miryoku-inspired layers](https://github.com/manna-harbour/miryoku), and 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 +```
\ No newline at end of file |