Mouseless

https://mouseless.click/docs/
Admin
Mouseless is a productivity application that enables users to control their mouse pointer and...
Tokens:11,341
Snippets:206
Trust Score:7.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install Mouseless via .flatpakref File

Source: https://mouseless.click/docs/getting_started.html

Alternative installation method using a reference file.

```bash
# Install mouseless
flatpak install --user \
  https://dl.sonuscape.net/flatpak/net.sonuscape.mouseless.flatpakref

# Run
flatpak run net.sonuscape.mouseless
```

--------------------------------

### Custom Monitor Assignment Format

Source: https://mouseless.click/docs/customizing_mouseless.html

Example format for mapping grid configurations to monitors.

```text
A, B
```

--------------------------------

### Install Mouseless via Homebrew

Source: https://mouseless.click/docs/print.html

Commands to install the stable or preview versions of Mouseless using the Homebrew package manager.

```bash
brew install --cask mouseless
```

```bash
brew install --cask mouseless@preview
```

--------------------------------

### Install Mouseless via Standalone Bundle

Source: https://mouseless.click/docs/getting_started.html

Manual installation method using a self-contained file that requires manual updates.

```bash
# Download latest bundle and .sha256sum
curl -LO https://dl.sonuscape.net/flatpak/bundle/mouseless/latest/Mouseless.flatpak
curl -LO https://dl.sonuscape.net/flatpak/bundle/mouseless/latest/Mouseless.flatpak.sha256sum

# Verify download, then install only if it passes
sha256sum -c Mouseless.flatpak.sha256sum && \
  flatpak install --user ./Mouseless.flatpak

# Run
flatpak run net.sonuscape.mouseless
```

--------------------------------

### Install Mouseless via Flatpak Repository

Source: https://mouseless.click/docs/getting_started.html

Recommended method for easy updates and software manager integration.

```bash
# Add GPG-signed repo
flatpak remote-add --user --if-not-exists sonuscape \
  https://dl.sonuscape.net/flatpak/sonuscape.flatpakrepo

# Install mouseless (stable channel)
flatpak install net.sonuscape.mouseless

# Run
flatpak run net.sonuscape.mouseless
```

--------------------------------

### Manage Version History and Pinning

Source: https://mouseless.click/docs/getting_started.html

Commands to list remotes, view commit history, and install a specific version.

```bash
# List your remotes (to find <remote> for the next command)
flatpak remotes

# View commit (version) history
#  - <remote> is the name from `flatpak remotes` above
#  - it's `sonuscape` if you installed the .repo file
flatpak remote-info --log <remote> net.sonuscape.mouseless

# Install specific version
flatpak update --commit=<GOOD_COMMIT_HASH> net.sonuscape.mouseless

# Prevent future updates
flatpak mask net.sonuscape.mouseless
```

--------------------------------

### Revert Method 1 changes

Source: https://mouseless.click/docs/wayland_configuration.html

Removes configuration files and group assignments created during the first setup method.

```bash
sudo rm /etc/udev/rules.d/99-mouseless-input.rules
sudo rm -f /etc/modules-load.d/uinput.conf
sudo groupdel mouseless
sudo gpasswd -d $USER input
sudo udevadm control --reload-rules && sudo udevadm trigger
```

--------------------------------

### Run Mouseless on Windows

Source: https://mouseless.click/docs/command_line.html

Launch the executable using PowerShell for either single-user or all-users installations.

```powershell
& "$env:LOCALAPPDATA\Programs\Mouseless\mouseless.exe" -d
```

```powershell
& 'C:\Program Files\Mouseless\mouseless.exe' -d
```

--------------------------------

### Excluded Input Device Configuration

Source: https://mouseless.click/docs/customizing_mouseless.html

Example format for excluding input devices by ID in the configuration.

```text
ids:046d:c52b
```

--------------------------------

### Run Mouseless on Linux

Source: https://mouseless.click/docs/command_line.html

Launch the application using the flatpak command.

```bash
flatpak run net.sonuscape.mouseless -d
```

--------------------------------

### Configure udev rule for virtual device creation

Source: https://mouseless.click/docs/wayland_configuration.html

Sets permissions for the uinput kernel module to allow virtual device creation.

```bash
sudo tee /etc/udev/rules.d/99-mouseless-input.rules <<EOF
# Output: Virtual device creation
KERNEL=="uinput", GROUP="mouseless", MODE:="0660"
EOF
```

--------------------------------

### Create Mouseless group and assign user

Source: https://mouseless.click/docs/wayland_configuration.html

Creates a system group for Mouseless and adds the current user to the input and mouseless groups.

```bash
sudo groupadd --system mouseless
sudo usermod -aG input,mouseless $USER
```

--------------------------------

### Configure systemd temporary files

Source: https://mouseless.click/docs/wayland_configuration.html

Sets ownership and permissions for input devices using systemd-tmpfiles.

```bash
# Forces current user/group ownership on input devices
sudo tee /etc/tmpfiles.d/mouseless-input.conf <<EOF
z /dev/uinput       0660 $USER $(id -gn) - -
z /dev/input/event* 0660 $USER $(id -gn) - -
EOF
```

--------------------------------

### Load uinput module

Source: https://mouseless.click/docs/wayland_configuration.html

Loads the uinput module immediately and ensures it persists across system reboots.

```bash
sudo modprobe uinput
echo "uinput" | sudo tee /etc/modules-load.d/uinput.conf
```

--------------------------------

### Mouseless Configuration File Paths

Source: https://mouseless.click/docs/customizing_mouseless.html

The file paths for the config.yaml file across different operating systems.

```text
~/Library/Application Support/Mouseless/configs/config.yaml
```

```text
~/AppData/Local/Mouseless/configs/config.yaml
```

```text
~/.var/app/net.sonuscape.mouseless/data/mouseless/configs/config.yaml
```

--------------------------------

### Resume Normal Updates

Source: https://mouseless.click/docs/getting_started.html

Removes the mask and updates the application to the latest version.

```bash
# Remove mask
flatpak mask --remove net.sonuscape.mouseless
# Update app
flatpak update net.sonuscape.mouseless
```

--------------------------------

### Run Mouseless on macOS

Source: https://mouseless.click/docs/command_line.html

Recommended method for launching the application from a terminal on macOS.

```bash
open -W --stdout $(tty) --stderr $(tty) --stdin $(tty) /Applications/Mouseless.app --args -d
```

--------------------------------

### Command URL List

Source: https://mouseless.click/docs/deep_links.html

The available deep link URLs for controlling Mouseless actions.

```text
mouseless://toggle-overlay
mouseless://show-overlay
mouseless://hide-overlay
mouseless://toggle-free-mode
mouseless://enter-free-mode
mouseless://exit-free-mode
mouseless://toggle-enabled
mouseless://settings
```

--------------------------------

### Update Flatpak on Older Distributions

Source: https://mouseless.click/docs/getting_started.html

Commands to resolve URI size errors on older systems by upgrading Flatpak.

```bash
sudo add-apt-repository ppa:flatpak/stable   # maintained by Flatpak team
sudo apt update && sudo apt install flatpak
```

--------------------------------

### Apply systemd-tmpfiles permissions

Source: https://mouseless.click/docs/wayland_configuration.html

Applies the permissions defined in the temporary files configuration.

```bash
sudo systemd-tmpfiles --create /etc/tmpfiles.d/mouseless-input.conf
```

--------------------------------

### Reload udev rules

Source: https://mouseless.click/docs/wayland_configuration.html

Applies the newly created udev rules to the system.

```bash
sudo udevadm control --reload-rules && sudo udevadm trigger
```

--------------------------------

### List Mouseless Commands

Source: https://mouseless.click/docs/print.html

Prints the available deep link commands using the CLI flag.

```bash
mouseless --links
```

--------------------------------

### Mouseless Deep Link Commands

Source: https://mouseless.click/docs/deep_links.html

A list of available commands that can be triggered by opening the corresponding mouseless:// URL.

```APIDOC
## Deep Link Commands

### Description
Trigger Mouseless actions by opening the following URLs in any application or script that supports URL handling.

### Commands
| Action | URL |
| --- | --- |
| Toggle overlay | mouseless://toggle-overlay |
| Show overlay | mouseless://show-overlay |
| Hide overlay | mouseless://hide-overlay |
| Toggle free mode | mouseless://toggle-free-mode |
| Enter free mode | mouseless://enter-free-mode |
| Exit free mode | mouseless://exit-free-mode |
| Toggle enabled | mouseless://toggle-enabled |
| Open settings | mouseless://settings |

### Usage Examples
- **macOS**: `open mouseless://toggle-overlay`
- **Windows**: `start mouseless://toggle-overlay`
- **Linux**: `xdg-open mouseless://toggle-overlay`
- **AutoHotkey**: `Run "mouseless://toggle-overlay"`
```

--------------------------------

### Configure Persistent Debug Options

Source: https://mouseless.click/docs/command_line.html

JSON objects for the debug_options field to persist settings across restarts.

```json
{ "overlay_renderer": "cairo", "use_dmabuf": false }
```

```json
{ "overlay_offset": { "x": 100, "y": -50 } }
```

--------------------------------

### Triggering Commands via AutoHotkey

Source: https://mouseless.click/docs/deep_links.html

Syntax for executing Mouseless commands within an AutoHotkey script.

```autohotkey
Run "mouseless://toggle-overlay"
```

--------------------------------

### Exclude Mouseless virtual devices in keyd

Source: https://mouseless.click/docs/app_conflicts.html

Prevents keyd from grabbing Mouseless virtual devices to avoid keyboard unresponsiveness caused by feedback loops.

```ini
[ids]

*
# Exclude Mouseless virtual devices via vendor prefix
-736e

[main]
...
```

--------------------------------

### Triggering Commands via Shell

Source: https://mouseless.click/docs/deep_links.html

Commands to trigger Mouseless actions from the terminal or shell-based automation tools.

```bash
open mouseless://toggle-overlay
```

```bash
start mouseless://toggle-overlay
```

```bash
xdg-open mouseless://toggle-overlay
```

--------------------------------

### Pin Specific Version of Mouseless

Source: https://mouseless.click/docs/getting_started.html

Prevents automatic updates by masking the application.

```bash
flatpak mask net.sonuscape.mouseless
```

--------------------------------

### Disable animations for Mouseless overlay on Hyprland

Source: https://mouseless.click/docs/troubleshooting.html

Use this rule in your Hyprland configuration to prevent animation delays for the overlay surface.

```text
layerrule = noanim, mouseless-overlay
```
Tokens:
Raw