Skip to content

README.md

Latest commit

 

History

History
130 lines (93 loc) · 4.59 KB

README.md

File metadata and controls

130 lines (93 loc) · 4.59 KB

InputFlow

Status: Public Beta License: GPLv3

InputFlow is a native C++17 Linux companion for Microsoft PowerToys "Mouse Without Borders", enabling seamless cursor and keyboard sharing between Linux and Windows.

🚀 Quick Start (Tray & UI Setup)

Recommended first-run flow for most users:

  1. Install Prerequisites:
    • Fedora: sudo dnf install python3-gobject gtk3 libayatana-appindicator3
    • Ubuntu/Debian: sudo apt install python3-gi gir1.2-gtk-3.0 libayatana-appindicator3-0.1
  2. Launch Setup UI: Run ./mwb-desktop-ui.sh menu
  3. Configure:
    • Go to Settings -> Enter your Windows Host IP and Security Key.
  4. Pair with Windows:
    • In the same UI, use the Export Helper option.
    • Run the exported .ps1 script on your Windows machine to register the Linux peer.
  5. Start: Choose Start Service or launch the tray with ./build/mwb_tray.

For the full beta setup, health-check, diagnostics, connection-quality, and packaging-verification workflow, see docs/beta-workflow.md.

🛠️ Build & Installation

1. Prerequisites

Ubuntu / Debian:

sudo apt-get install -y build-essential cmake pkg-config libssl-dev zlib1g-dev \
    python3-gi gir1.2-gtk-3.0 libayatana-appindicator3-dev

Fedora:

sudo dnf install -y gcc-c++ cmake make pkgconf-pkg-config openssl-devel zlib-devel \
    python3-gobject gtk3 libayatana-appindicator3-devel

2. Compile

cmake -S . -B build -DMWB_BUILD_TRAY=ON
cmake --build build -j$(nproc)

3. Setup /dev/uinput (Crucial for Mouse/Keyboard)

sudo modprobe uinput
sudo groupadd -r inputflow
sudo usermod -aG inputflow $USER
echo 'KERNEL=="uinput", GROUP="inputflow", MODE="0660", OPTIONS+="static_node=uinput"' | sudo tee /etc/udev/rules.d/99-inputflow-uinput.rules
sudo udevadm control --reload-rules && sudo udevadm trigger

Logout and back in for group changes to take effect.

✨ Features

  • Absolute Cursor Movement: Precise pointer control across screens.
  • Keyboard Sync: Full keyboard sharing with media key support.
  • Rich Clipboard: Text, HTML, and Image synchronization.
  • Systemd Integration: Runs as a lightweight user service.
  • Tray Tool: Quick access to settings and connection status.
  • Auto-Reconnect: Smart backoff logic when Windows goes offline.

⚠️ Public Beta Status

InputFlow is usable today but is still stabilizing. Expect rough edges around reconnection and desktop-environment edge cases.

What is working well:

  • Windows-to-Linux keyboard/mouse input.
  • Full Clipboard sync (Text/HTML/Images).
  • systemd service management.
  • Windows pairing-helper for easy setup.

📖 Advanced Usage & CLI

For power users who prefer manual control:

./build/mwb_client run --config ~/.config/mwb-client/config.ini
./build/mwb_client discover
./build/mwb_client doctor --config ~/.config/mwb-client/config.ini

See the full documentation section for environment variables and protocol details.

User-facing beta operations:

Detailed Documentation

Attribution

This repository started as a fork of chrischip/mwb-client-linux and has been substantially expanded with service management, rich clipboard support, and recovery tooling.

Configuration (config.ini)

Supports key_file, key_secret_id (keyring), screen_width/height overrides, and more. Default path: ~/.config/mwb-client/config.ini.

Screen Sizing

The client detects screen size in this order:

  1. Config/CLI overrides
  2. KDE logical geometry (kscreen-doctor)
  3. DRM connector modes (/sys/class/drm)
  4. 1920x1080 fallback

Network & Protocol

  • Port: 15101 (Input), 15100 (Clipboard).
  • Encryption: AES-256-CBC (PowerToys compatible).

License

GNU GPL v3.0 — see LICENSE.

InputFlow is independent and not affiliated with Microsoft. Interoperability is based on the open-source microsoft/PowerToys implementation.