aboutsummaryrefslogtreecommitdiff
path: root/config.example
diff options
context:
space:
mode:
authorLena <lena@omega>2026-01-01 00:00:00 +0000
committerLena <lena@omega>2026-01-01 00:00:00 +0000
commit2fa72ee0dc67d973330aec4ba98260e9f57f7821 (patch)
treee6a25c07c8da61d29e4e1f8a72436565e63c5777 /config.example
downloadmouseboard-2fa72ee0dc67d973330aec4ba98260e9f57f7821.tar.gz
Enter mouseboardHEADv0.1master
Keyboard-only pointing: a labelled grid over every monitor, type a label to jump to a cell, bisect it by quadrant until the crosshair is exact, then one key clicks. The coarse grid keeps labels short and bisection keeps precision unlimited, so a hotkey and a few keystrokes replace the mouse. The core talks only to the backend interface in platform.h; wlroots Wayland and Win32 backends supply the overlay, keyboard grab and pointer.
Diffstat (limited to 'config.example')
-rw-r--r--config.example44
1 files changed, 44 insertions, 0 deletions
diff --git a/config.example b/config.example
new file mode 100644
index 0000000..378c269
--- /dev/null
+++ b/config.example
@@ -0,0 +1,44 @@
+# mouseboard configuration. Copy to $XDG_CONFIG_HOME/mouseboard/config
+# (default ~/.config/mouseboard/config; on Windows %APPDATA%\mouseboard\config).
+# Lines are "key = value"; lines starting with # are comments (no inline
+# comments). Command-line flags override this file. Values below are the
+# defaults.
+
+# Label characters, most-preferred first. Common cells get the easiest labels.
+# alphabet = fjdkslaghrueiwoqptyvbcnxmz
+
+# Coarse grid. Either a target cell size in pixels (auto cols/rows per monitor),
+# or an explicit cols/rows pair (set both, 1..200; they override cell_size).
+# cell_size = 100
+# cols = 0
+# rows = 0
+
+# Label glyph scale. 0 means auto-fit each cell; the maximum is 64.
+# font_scale = 0
+
+# Opacity, 0..100 each. opacity_bg is the backdrop (0 = no dim, 100 = solid);
+# opacity_fg covers labels, grid lines and the refine crosshair. The flags
+# --opacity and --opacity-fg override them.
+# opacity_bg = 33
+# opacity_fg = 65
+
+# Colours, #RRGGBB or #RRGGBBAA. An explicit alpha sets an element's weight
+# relative to the others; opacity_bg/opacity_fg then scale them.
+# color_bg = #101014
+# color_grid = #ffffff40
+# color_label = #ffffff
+# color_typed = #52a8ff
+# color_active = #ff5252
+
+# Refine (bisection) keys: keep the named quadrant of the active region.
+# refine_tl = u
+# refine_tr = i
+# refine_bl = j
+# refine_br = k
+
+# Click keys. The final key decides the button.
+# click_left = m
+# click_middle = ,
+# click_right = .
+# click_double = ;
+# drag = v