Repository navigation
Home
github-actions[bot] edited this page Oct 15, 2026
·
6 revisions
Welcome to the minfwm documentation!
minfwm is an infinite 2D canvas window manager for macOS 14+. It replaces the concept of traditional virtual desktops (Spaces) with a single continuous 2D surface. You can pan anywhere, zoom out for an overview with optional static window previews, organize windows freely, and navigate quickly with trackpad gestures and keyboard shortcuts.
- Getting Started: Requirements, installation, permissions, starting the daemon, and default shortcuts.
-
Configuration: Guide to configuring shortcuts, trackpad sensitivity, snapping, animations, and overview previews in
minfwm.toml. - Yabai Integration: Why the Yabai Scripting Addition is required, how to build and load it, and SIP prerequisites.
- Architecture: High-level overview of core geometry, macOS platform adapters, and IPC protocol.
-
Development: Building from source, testing with CTest, and developer tools (
dev-update). - Releases: Versioning scheme, upgrading releases, and checking installed version.
- macOS 14+ (Sonoma or newer).
- Accessibility Permission: Required for window discovery, focus tracking, and coordinate mapping.
- Disabled System Integrity Protection (SIP): Necessary to load the Yabai Scripting Addition.
- Compatible Yabai Scripting Addition: Allows windows to be positioned smoothly offscreen and above the menu bar. See the Yabai Integration guide for simple setup instructions.