Skip to content

Saml1211/OverlayX

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OverlayX

OverlayX is a lightweight macOS utility that displays a persistent red crosshair overlay following your mouse cursor. Perfect for screen alignment, accessibility needs, and visual assistance during presentations or daily computer use.

Features

  • Always-on-top crosshair overlay
  • Click-through functionality (doesn't interfere with mouse interactions)
  • Lightweight and efficient (< 1% CPU usage, ~20MB RAM)
  • Perfect for accessibility and visual alignment
  • High-contrast mode for better visibility
  • Multi-monitor support with per-display DPI scaling
  • Customizable keyboard shortcuts
  • Menu bar controls for quick access

System Requirements

  • macOS 11.0 or later
  • Universal Binary (supports both Apple Silicon and Intel Macs)
  • Minimal system resources (< 1% CPU, ~20MB RAM)
  • Required Permissions:
    • Accessibility (System Settings → Privacy & Security → Accessibility)
    • Input Monitoring (System Settings → Privacy & Security → Input Monitoring)

Installation

Homebrew (Recommended)

brew install --cask overlayx

Manual Installation

  1. Download the latest release from the Releases page
  2. Move OverlayX.app to your Applications folder
  3. First launch: Right-click and select "Open" to bypass Gatekeeper

Building from Source

  1. Open OverlayX.xcodeproj in Xcode
  2. Build and run the project (⌘R)
  3. Xcode 13.0 or later required for development

Usage

Basic Controls

  • Start: Launch OverlayX.app
  • Quit: Click menu bar icon → Quit, or press ⌘Q while the app is focused
  • Toggle Overlay: ⌘⇧X (customizable in Preferences)
  • Toggle High Contrast: ⌘⇧H
  • Reset Position: ⌘⇧R

Menu Bar Controls

  • Click the crosshair icon in the menu bar for quick access to:
    • Toggle Overlay
    • High Contrast Mode
    • Preferences
    • Help
    • Quit

Multi-Monitor Support

  • Automatically follows cursor across all connected displays
  • Independent DPI scaling per display
  • Maintains correct position during display configuration changes

Troubleshooting

Overlay Not Visible

  1. Check System Settings → Privacy & Security:
    • Ensure OverlayX is allowed in Accessibility
    • Ensure OverlayX is allowed in Input Monitoring
  2. Try toggling the overlay (⌘⇧X)
  3. Restart the application

Performance Issues

  • If experiencing lag:
    • Check system resource usage in Activity Monitor
    • Disable high-contrast mode
    • Reduce refresh rate in Preferences
    • Ensure latest version is installed

Multiple Displays

  • If overlay position is incorrect:
    • Open Preferences → Display
    • Click "Recalibrate Displays"
    • Or use ⌘⇧R to reset position

Known Issues

  • May require re-enabling permissions after macOS updates
  • DPI scaling might need manual adjustment on some display configurations
  • Menu bar icon may be hidden on systems with many menu bar items

License

MIT License

About

Swift-based overlay application for macOS.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published