User guide#

Mousetroke runs actions when you draw with a mouse button held down, push into a screen corner, or use a screen edge. Start with the built-in gestures, then change their actions without learning a programming language.

These guides cover Windows and macOS. Mac support is in beta; platform differences are called out where they affect an action or script. Interface names below follow the English UI.

Start using gestures#

• Getting started: install, first run, default gestures and pause.

• Mouse gestures: record strokes and shapes, add buttons or keys, and find or edit gestures.

• Screen corners and edges: volume, brightness, clicks and edge rubbing.

• Actions: choose what a gesture does, including selected-text web search.

• Per-app rules: overrides, exclusions and fullscreen behavior.

Send shortcuts and write scripts#

• Send-keys syntax: copy-and-paste shortcut examples and the complete key-name table.

• Lua basics: a first script, the entry function and debugging.

• Lua API: every function in the ms table, with platform notes.

• Lua recipes: output text, use the clipboard, search, control windows and more.

Maintain and troubleshoot#

• Configuration, backup and updates: files, restore, hot reload, updates and uninstall.

• Troubleshooting: missing gestures, permissions, text input and logs.

For a quick win, draw your first gesture. To make a gesture type text, jump to Lua recipes.