accessibility.example.toml

# =============================================================================
# FloatWM Accessibility Configuration
# =============================================================================
#
# This configuration is optimized for users with accessibility needs.
# It includes larger text, high contrast settings, keyboard-friendly navigation,
# and adjustments for users with motor or visual impairments.
#
# USE CASE: Perfect for users who need accessibility features including:
#   - Visual impairments (low vision, color blindness)
#   - Motor impairments (limited mobility, repetitive strain injury)
#   - Cognitive considerations (ADHD, autism spectrum)
#   - General accessibility preferences
#
# ACCESSIBILITY FEATURES:
#   - Larger window sizes for better visibility
#   - High contrast color schemes (where applicable)
#   - Keyboard-focused navigation (minimal mouse dependence)
#   - Slower, smoother animations (reduced motion sensitivity)
#   - Larger hit targets for easier interaction
#   - Sticky keys and modifier key options
#   - Audio feedback for actions (if supported)
#
# TO USE: Copy this file to ~/.config/floatwm/floatwm.toml
#         cp docs/examples/accessibility.example.toml ~/.config/floatwm/floatwm.toml
#
# =============================================================================

# -----------------------------------------------------------------------------
# Focus Behavior
# -----------------------------------------------------------------------------
#
# RECOMMENDATION FOR ACCESSIBILITY: "click" is often most predictable and
# controllable for users with motor impairments or cognitive considerations.
#
# OPTIONS:
#   - "click":        Most predictable, requires deliberate action
#   - "followmouse":  May be too automatic for some users
#   - "sloppy":       Balance between automatic and control
#
focus_behavior = "click"

# -----------------------------------------------------------------------------
# Accessibility Settings
# -----------------------------------------------------------------------------
#
# Core accessibility settings that affect FloatWM's behavior.
#
[accessibility]

# Enable accessibility features
# When true: Enables all accessibility enhancements
# DEFAULT: true (this is an accessibility config after all)
enabled = true

# Reduced motion mode
# When true: Minimizes animations, transitions, and spatial movement
# RECOMMENDED: true for users with motion sensitivity or vestibular disorders
# BENEFITS: Reduces dizziness, nausea, and distraction
reduced_motion = true

# High contrast mode
# When true: Uses high contrast colors for window borders, decorations
# RECOMMENDED: true for users with low vision or color blindness
# NOTE: FloatWM's theming system must support this
high_contrast = true

# Large text mode
# When true: Increases font sizes in window decorations, tooltips
# RECOMMENDED: true for users with low vision
# NOTE: FloatWM's UI system must support this
large_text = true

# Screen reader support
# When true: Emits events/signals compatible with screen readers (AT-SPI)
# RECOMMENDED: true for users who use screen readers
# NOTE: Requires AT-SPI support to be implemented
screen_reader_support = true

# Audio feedback
# When true: Plays sounds for actions (window focus, close, etc.)
# RECOMMENDED: true for users with visual impairments
# NOTE: Requires sound system integration
audio_feedback = true

# Audio feedback volume (0.0 - 1.0)
# DEFAULT: 0.5
# Adjust based on your hearing preferences
audio_volume = 0.5

# Sticky keys
# When true: Modifier keys (Shift, Ctrl, Alt, Super) remain active until
#            another key is pressed, eliminating need to hold multiple keys
# RECOMMENDED: true for users with motor impairments or limited hand mobility
# BENEFITS: Can press keys sequentially instead of simultaneously
sticky_keys = true

# Slow keys
# When true: Keys must be held for a minimum duration before being accepted
# RECOMMENDED: true for users with hand tremors or uncontrolled movements
# NOTE: Requires system-level slow keys support
slow_keys = false

# Bounce keys
# When true: Ignores rapid repeated key presses
# RECOMMENDED: true for users with motor control issues
# NOTE: Requires system-level bounce keys support
bounce_keys = false

# -----------------------------------------------------------------------------
# Visual Accessibility Settings
# -----------------------------------------------------------------------------
#
# Settings specifically for users with visual impairments.
#
[visual_accessibility]

# Window border width (pixels)
# THICKER borders are easier to see
# DEFAULT: 4 (standard), 8-12 (accessibility)
# RECOMMENDED: 8-10 for low vision
border_width = 10

# Window border color (high contrast)
# FORMAT: Hex color code or color name
# RECOMMENDED: Bright colors that contrast with desktop background
border_color = "#FFFFFF"  # White for high contrast

# Focused window border color
# Should be distinctly different from unfocused windows
border_focused_color = "#00FF00"  # Bright green for high visibility

# Window title bar height (pixels)
# TALLER title bars are easier to click and see
# DEFAULT: 24 (standard), 32-40 (accessibility)
# RECOMMENDED: 36 for better visibility
titlebar_height = 36

# Title bar font size (points)
# DEFAULT: 10-12 (standard), 14-18 (accessibility)
# RECOMMENDED: 16 for readability
titlebar_font_size = 16

# Window shadow/outline intensity
# Helps distinguish overlapping windows
# VALID RANGE: 0.0 - 1.0
# DEFAULT: 0.3 (subtle), 0.6-0.8 (accessibility)
# RECOMMENDED: 0.7 for clear window separation
shadow_intensity = 0.7

# Minimum window size (width, height)
# Prevents windows from becoming too small to interact with
# DEFAULT: [200, 150] (standard), [300, 200] (accessibility)
# RECOMMENDED: [350, 250] for usability
min_window_size = [350, 250]

# Cursor size (pixels)
# Larger cursor is easier to see and track
# DEFAULT: 24 (standard), 32-48 (accessibility)
# RECOMMENDED: 40 for visibility
# NOTE: Requires system cursor settings
cursor_size = 40

# -----------------------------------------------------------------------------
# Motor Accessibility Settings
# -----------------------------------------------------------------------------
#
# Settings for users with motor impairments or limited mobility.
#
[motor_accessibility]

# Keyboard navigation mode
# When true: All window management accessible via keyboard
# RECOMMENDED: true for users who can't use mouse
keyboard_navigation = true

# Movement step size (pixels)
# LARGER steps mean fewer keypresses to move windows
# DEFAULT: 50 (standard), 100-150 (accessibility)
# RECOMMENDED: 120 for fewer keypresses
movement_step_size = 120

# Movement delay (milliseconds)
# Delay between auto-repeated movement commands
# LOWER values allow faster continuous movement
# DEFAULT: 100 (standard), 50-80 (accessibility)
# RECOMMENDED: 60 for responsive movement
movement_delay = 60

# Click assist
# When true: Automatically focuses windows on hover for easier clicking
# RECOMMENDED: true for users with difficulty aiming mouse
# NOTE: Works best with focus_behavior = "sloppy"
click_assist = false

# Dwell click (automatic click after holding still)
# When true: Automatically clicks after cursor dwells in one place
# RECOMMENDED: true for users who can't click physically
# NOTE: Requires dwell time configuration
dwell_click = false

# Dwell time (milliseconds)
# How long cursor must dwell before triggering click
# DEFAULT: 500-1000ms
# RECOMMENDED: 750ms (balance of speed and accuracy)
dwell_time = 750

# -----------------------------------------------------------------------------
# Cognitive Accessibility Settings
# -----------------------------------------------------------------------------
#
# Settings for users with cognitive considerations (ADHD, autism, etc.).
#
[cognitive_accessibility]

# Simplified mode
# When true: Reduces visual clutter, minimizes distractions
# RECOMMENDED: true for users easily distracted by visual elements
simplified_mode = true

# Focus mode
# When true: Dim or hide non-focused windows
# RECOMMENDED: true for users who need help focusing
# BENEFITS: Reduces visual distraction from background windows
focus_mode = false

# Notification minimization
# When true: Reduces frequency and prominence of notifications
# RECOMMENDED: true for users sensitive to interruptions
minimize_notifications = true

# Predictive window placement
# When true: Places windows in predictable positions
# RECOMMENDED: true for users who prefer consistency
# BENEFITS: Reduces cognitive load of finding windows
predictive_placement = true

# Workspace persistence
# When true: Remembers window positions across workspace switches
# RECOMMENDED: true for users who need spatial consistency
workspace_persistence = true

# -----------------------------------------------------------------------------
# Spatial Settings - Accessibility Optimized
# -----------------------------------------------------------------------------
#
# Accessibility-optimized spatial settings for users with XReal glasses.
# Emphasizes comfort and reduces motion sensitivity.
#
[spatial_settings]

# Enable spatial window movement
# DEFAULT: false
# RECOMMENDATION: Enable cautiously, with reduced_motion = true
# WARNING: Spatial movement may cause dizziness in some users
enabled = false

# Accessibility-optimized sensitivity
# MUCH LOWER than default to minimize motion
# VALID RANGE: 0.0 - 10.0
# ACCESSIBILITY RECOMMENDED: 0.2 - 0.4 (very subtle, if enabled at all)
sensitivity = 0.3

# Maximum movement range
# SMALLER range to minimize visual disruption
# VALID RANGE: 1 - 2000 pixels
# ACCESSIBILITY RECOMMENDED: 50 - 100 (minimal movement)
max_range = 75

# Smoothing factor - maximum smoothness
# VERY HIGH smoothing for gentle, non-jarring movement
# VALID RANGE: 0.0 - 1.0
# ACCESSIBILITY RECOMMENDED: 0.8 - 0.95 (very smooth)
smoothing = 0.9

# Calibration profile for accessibility
# OPTIONS: "default", "gentle", "accessibility"
# RECOMMENDATION: "gentle" for minimal motion
calibration_profile = "gentle"

# Motion comfort level
# OPTIONS: "low", "medium", "high"
# RECOMMENDATION: "low" for users with motion sensitivity
motion_comfort = "low"

# -----------------------------------------------------------------------------
# Keybindings - Accessibility Optimized
# -----------------------------------------------------------------------------
#
# Accessibility-focused keybindings with emphasis on:
# - Easy-to-reach keys (reduced hand stretching)
# - Minimal modifier combinations (easier for limited mobility)
# - Multiple binding options (alternatives for different abilities)
# - Sticky keys friendly (can press sequentially)
#
[keybindings]

# -------------------------------------------------------------------------
# Essential Keybindings - Multiple Options
# -------------------------------------------------------------------------
#
# Provide multiple ways to trigger essential actions for flexibility.
#

# Spawn terminal - multiple easy options
# Options: Single-modifier or easy-to-reach combinations
spawn_terminal = [
    "Super+Return",     # Standard (sticky keys friendly)
    "Control+Alt+t",    # Alternative (common terminal shortcut)
    "Super+Shift+t"     # Alternative (easy to remember)
]

# Close window - multiple easy options
close_window = [
    "Super+Shift+q",    # Standard (sticky keys friendly)
    "Super+F4",         # Alternative (common Windows shortcut)
    "Alt+F4"            # Alternative (traditional X11 shortcut)
]

# -------------------------------------------------------------------------
# Window Movement - Accessibility Optimized
# -------------------------------------------------------------------------
#
# Use arrow keys instead of hjkl for more intuitive navigation.
# Also provide both one-modifier and two-modifier options.
#

# Movement with arrow keys (most intuitive)
move_left = ["Super+Shift+Left"]
move_right = ["Super+Shift+Right"]
move_up = ["Super+Shift+Up"]
move_down = ["Super+Shift+Down"]

# Alternative: Single modifier for easier pressing (if supported)
# move_left = ["Alt+Left"]
# move_right = ["Alt+Right"]
# move_up = ["Alt+Up"]
# move_down = ["Alt+Down"]

# Alternative: Function keys (easy to reach, large targets)
# move_left = ["Super+F1"]
# move_right = ["Super+F2"]
# move_up = ["Super+F3"]
# move_down = ["Super+F4"]

# -------------------------------------------------------------------------
# Window Focus - Keyboard Navigation
# -------------------------------------------------------------------------
#
# For users who can't use mouse, provide comprehensive keyboard navigation.
#

# Focus next window (cycle)
focus_next = ["Super+Tab", "Alt+Tab"]

# Focus previous window (cycle)
focus_prev = ["Super+Shift+Tab", "Alt+Shift+Tab"]

# Focus next window in direction
focus_north = ["Super+Up"]
focus_south = ["Super+Down"]
focus_east = ["Super+Right"]
focus_west = ["Super+Left"]

# -------------------------------------------------------------------------
# Workspace Switching - Simplified
# -------------------------------------------------------------------------
#
# Use simplified workspace switching with clear, easy-to-remember keys.
#

# Use only first 5 workspaces to reduce cognitive load
workspace_1 = ["Super+1"]
workspace_2 = ["Super+2"]
workspace_3 = ["Super+3"]
workspace_4 = ["Super+4"]
workspace_5 = ["Super+5"]

# Skip workspace 6-10 for simplicity (can uncomment if needed)
# workspace_6 = ["Super+6"]
# workspace_7 = ["Super+7"]
# workspace_8 = ["Super+8"]
# workspace_9 = ["Super+9"]
# workspace_10 = ["Super+0"]

# Workspace navigation - simplified
workspace_next = ["Super+Right"]  # Move to next workspace
workspace_prev = ["Super+Left"]  # Move to previous workspace

# -------------------------------------------------------------------------
# Scratchpad - Easy Access
# -------------------------------------------------------------------------

# Fewer scratchpad slots for simplicity
scratchpad_0 = ["Super+grave"]   # Primary
scratchpad_1 = ["Super+F1"]      # Secondary

# -------------------------------------------------------------------------
# Special Accessibility Keybindings
# -------------------------------------------------------------------------

# Toggle accessibility features
# toggle_accessibility = ["Super+Shift+a"]

# Toggle reduced motion
# toggle_reduced_motion = ["Super+Shift+r"]

# Toggle high contrast
# toggle_high_contrast = ["Super+Shift+h"]

# Toggle audio feedback
# toggle_audio_feedback = ["Super+Shift+s"]

# Toggle focus mode
# toggle_focus_mode = ["Super+Shift+f"]

# -------------------------------------------------------------------------
# Spatial Mode Toggle
# -------------------------------------------------------------------------

toggle_spatial = ["Super+s"]

# -----------------------------------------------------------------------------
# Window Rules - Accessibility Optimized
# -----------------------------------------------------------------------------
#
# Accessibility-focused window rules with larger sizes and predictable
# placement for easier interaction.
#

# [[window_rules]]
# Terminal - large size for visibility
# class = "Termite"
# size = [1000, 800]  # Larger than default
# float = true
# position = [50, 50]  # Predictable position

# [[window_rules]]
# Browser - large size, predictable placement
# class = "Firefox"
# size = [1600, 900]   # Large for readability
# float = true
# position = [0, 0]    # Always top-left

# [[window_rules]]
# Email client - large text, easy to read
# class = "Thunderbird"
# size = [1400, 900]
# float = true
# position = [50, 50]

# [[window_rules]]
# Communication apps - large for readability
# class = "Slack"
# size = [1200, 800]
# float = true

# [[window_rules]]
# class = "discord"
# size = [1200, 800]
# float = true

# [[window_rules]]
# File manager - large icons, easier to click
# class = "Thunar"
# size = [1200, 800]
# float = true

# [[window_rules]]
# System settings - large for accessibility
# class = "gnome-control-center"
# size = [1000, 700]
# float = true
# sticky = true  # Keep accessible

# -----------------------------------------------------------------------------
# Scratchpad Configuration - Accessibility
# -----------------------------------------------------------------------------
#
# Accessibility-focused scratchpad with larger windows.
#
[scratchpad]
slot_count = 5  # Fewer slots for simplicity
default_width = 1100  # Larger windows
default_height = 800
center_on_show = true
remember_position = true

# -----------------------------------------------------------------------------
# Accessibility Application Launching
# -----------------------------------------------------------------------------
#
# Quick launch commands for accessibility tools and frequently-used apps.
#
# [[spawn_commands]]
# Screen magnifier
# name = "magnifier"
# command = "magnifier"
# terminal = false
# keybindings = ["Super+Shift+m"]

# [[spawn_commands]]
# Screen reader
# name = "screen-reader"
# command = "orca"
# terminal = false
# keybindings = ["Super+Shift+r"]

# [[spawn_commands]]
# On-screen keyboard
# name = "onboard"
# command = "onboard"
# terminal = false
# keybindings = ["Super+Shift+k"]

# [[spawn_commands]]
# Accessibility settings
# name = "a11y-settings"
# command = "gnome-control-center a11y"
# terminal = false
# keybindings = ["Super+Shift+a"]

# [[spawn_commands]]
# Text-to-speech
# name = "espeak"
# command = "espeak"
# terminal = true
# keybindings = ["Super+Shift+s"]

# =============================================================================
# ACCESSIBILITY WORKFLOW EXAMPLES
# =============================================================================
#
# MOTOR IMPAIRMENT WORKFLOW:
#   - Use sticky keys: press modifiers sequentially, not simultaneously
#   - Use arrow keys for movement (more intuitive than hjkl)
#   - Enable click assist if mouse use is difficult
#   - Use dwell click if physical clicking is not possible
#   - Larger movement steps reduce number of keypresses needed
#
# VISUAL IMPAIRMENT WORKFLOW:
#   - Enable high contrast mode
#   - Enable large text mode
#   - Enable screen reader support
#   - Use audio feedback for action confirmation
#   - Larger window sizes improve visibility
#   - Thicker window borders improve visibility
#
# COGNITIVE CONSIDERATIONS WORKFLOW:
#   - Enable simplified mode (reduce visual clutter)
#   - Use fewer workspaces (5 instead of 10)
#   - Enable predictive window placement
#   - Enable workspace persistence
#   - Minimize notifications
#   - Consistent keybindings reduce cognitive load
#
# MOTION SENSITIVITY WORKFLOW:
#   - Enable reduced motion mode
#   - Disable spatial mode or use minimal settings
#   - Use maximum smoothing for spatial movement
#   - Avoid rapid window movements
#   - Use slower, more deliberate transitions
#
# =============================================================================
# ACCESSIBILITY CUSTOMIZATION GUIDE
# =============================================================================
#
# 1. IDENTIFY YOUR NEEDS:
#    - Visual, motor, cognitive, or combination?
#    - Which features help most?
#    - What are your primary challenges?
#
# 2. ADJUST VISUAL SETTINGS:
#    - Increase border_width to 8-12
#    - Increase titlebar_font_size to 14-18
#    - Enable high_contrast
#    - Increase min_window_size for usability
#
# 3. CUSTOMIZE KEYBINDINGS:
#    - Use keys you can comfortably press
#    - Add multiple binding options
#    - Enable sticky_keys for sequential pressing
#    - Use arrow keys instead of hjkl
#
# 4. OPTIMIZE MOVEMENT:
#    - Increase movement_step_size to 100-150
#    - Reduce number of workspaces if overwhelming
#    - Use predictable window placement
#    - Enable workspace_persistence
#
# 5. TEST AND REFINE:
#    - Use configuration for a few days
#    - Note what's difficult or uncomfortable
#   - Adjust settings gradually
#   - Don't change too much at once
#
# =============================================================================
# SYSTEM-LEVEL ACCESSIBILITY SETTINGS
# =============================================================================
#
# FloatWM works best when combined with system accessibility features:
#
# LINUX (GNOME):
#   Settings → Universal Access
#   - Enable sticky keys
#   - Enable slow keys
#   - Enable bounce keys
#   - Enable screen reader (Orca)
#   - Enable screen magnifier
#
# LINUX (KDE):
#   System Settings → Accessibility
#   - Activate sticky keys
#   - Activate bounce keys
#   - Enable screen reader
#
# ORCA SCREEN READER:
#   sudo apt install orca  # Debian/Ubuntu
#   orca --setup  # Initial configuration
#   orca --replace  # Start Orca
#
# ESPEAK (TEXT-TO-SPEECH):
#   sudo apt install espeak  # Debian/Ubuntu
#   espeak "Hello world"  # Test speech
#
# ON-SCREEN KEYBOARD:
#   sudo apt install onboard  # Debian/Ubuntu
#   onboard  # Launch on-screen keyboard
#
# =============================================================================
# ACCESSIBILITY RESOURCES
# =============================================================================
#
# LINUX ACCESSIBILITY:
#   - https://www.linuxfoundation.org/collaborate/workgroups/accessibility/
#   - GNOME Accessibility: https://wiki.gnome.org/Accessibility
#   - KDE Accessibility: https://accessibility.kde.org/
#
# ASSISTIVE TECHNOLOGY:
#   - Orca Screen Reader: https://wiki.gnome.org/Projects/Orca
#   - Espeak: http://espeak.sourceforge.net/
#   - Festival Speech Synthesis: http://www.cstr.ed.ac.uk/projects/festival/
#
# KEYBOARD ACCESSIBILITY:
#   - Sticky Keys: System setting to press modifiers sequentially
#   - Slow Keys: Adjust key sensitivity
#   - Bounce Keys: Ignore rapid repeated keypresses
#
# =============================================================================
# TROUBLESHOOTING ACCESSIBILITY ISSUES
# =============================================================================
#
# 1. KEYS NOT RESPONDING:
#    - Check if sticky keys is enabled in system settings
#    - Verify keybinding format is correct
#    - Try alternative keybindings
#    - Check if another application is grabbing keys
#
# 2. VISUAL DIFFICULTY:
#    - Increase border_width and titlebar_font_size
#    - Enable high_contrast mode
#    - Adjust window sizes to be larger
#    - Enable audio_feedback for action confirmation
#
# 3. MOTION SICKNESS/DIZZINESS:
#    - Enable reduced_motion mode
#    - Disable spatial mode: spatial_settings.enabled = false
#    - Increase smoothing to 0.8-0.9
#    - Minimize window movements
#
# 4. DIFFICULTY PRESSING MULTIPLE KEYS:
#    - Enable sticky_keys in FloatWM and system settings
#    - Use single-modifier keybindings
#    - Use function keys (larger targets)
#    - Consider on-screen keyboard
#
# 5. AUDIO FEEDBACK NOT WORKING:
#    - Check system audio is working
#    - Verify audio_feedback = true
#    - Adjust audio_volume
#    - Check system sound theme
#
# =============================================================================
# COMMANDS FOR ACCESSIBILITY
# =============================================================================
#
# Toggle accessibility features:
#   floatwmctl toggle-accessibility
#
# Toggle reduced motion:
#   floatwmctl toggle-reduced-motion
#
# Toggle audio feedback:
#   floatwmctl toggle-audio
#
# Increase border width:
#   floatwmctl set-border-width 12
#
# Increase title bar size:
#   floatwmctl set-titlebar-height 40
#
# Test audio feedback:
#   floatwmctl test-audio
#
# Get accessibility status:
#   floatwmctl a11y-status
#
# =============================================================================
# NEXT STEPS
# =============================================================================
#
# 1. CUSTOMIZE FOR YOUR NEEDS:
#    - Identify which accessibility features help you most
#    - Adjust settings to match your preferences
#    - Test with your actual workflow
#
# 2. ENABLE SYSTEM ACCESSIBILITY:
#    - Configure system-level accessibility settings
#   - Install assistive technologies (Orca, espeak, etc.)
#   - Test system and FloatWM integration
#
# 3. CREATE YOUR PERFECT SETUP:
#    - Fine-tune visual settings (sizes, colors, fonts)
#   - Customize keybindings for your comfort
#   - Add window rules for your applications
#
# 4. PROVIDE FEEDBACK:
#    - Share your experience with FloatWM developers
#   - Suggest improvements for accessibility
#   - Help make FloatWM more accessible for everyone
#
# For more information, see:
#   - docs/examples/basic-setup.example.toml - Basic configuration
#   - USER_GUIDE.md - Complete user manual
#   - docs/config_parser.md - Detailed configuration reference
#   - Your Linux distribution's accessibility documentation
#
# =============================================================================
# ACCESSIBILITY STATEMENT
# =============================================================================
#
# FloatWM is committed to being accessible to all users, regardless of
# their abilities. This configuration is a starting point, and we welcome
# feedback and suggestions for improvement.
#
# If you encounter accessibility barriers or have suggestions for improving
# FloatWM's accessibility, please:
#   - File an issue on GitHub: https://github.com/floatwm/floatwm/issues
#   - Tag with "accessibility" label
#   - Describe your use case and suggested improvements
#
# Together we can make FloatWM accessible to everyone.
#
# =============================================================================