Skip to content

Mastind/Highlight-Helper

Repository files navigation

Highlight-Helper

A macOS screen reading highlight bar tool that helps you focus on the current line while reading documents.

Born out of personal necessity as someone with ADHD, this tool brings the familiar experience of physical reading guides to the digital world, making screen reading more manageable and less overwhelming.

✨ Features

  • 🎯 Smart Tracking - Transparent highlight bar follows your mouse cursor
  • 🎨 Customizable - Adjust color, opacity, and height to your preference
  • ⌨️ Keyboard Shortcuts - Quick toggle with ⌘T
  • 💾 Auto-Save - Your settings are automatically saved
  • 🖥️ Always on Top - Works over any application
  • 🌙 Unobtrusive - Mouse events pass through the highlight bar

📋 System Requirements

  • macOS 12.0 or later
  • Accessibility permissions required

🚀 Installation

Download Pre-built App

  1. Download the latest release from Release
  2. Unzip the downloaded file
  3. Drag HighlightHelper.app to your Applications folder
  4. Double-click to launch

If macOS warns that the app is from an unidentified developer:

  1. Right-click HighlightHelper.app
  2. Choose Open
  3. Click Open again

First Launch Setup

On first launch, you'll need to grant accessibility permissions:

  1. macOS will prompt you to open System Settings
  2. Go to Privacy & SecurityAccessibility
  3. Click the 🔒 lock icon to unlock
  4. Click the + button and add HighlightHelper
  5. Make sure it's checked ✅
  6. Restart the app

📖 Usage

Basic Operation

  • Move your mouse - The highlight bar automatically follows
  • Menu bar icon - Click to access settings and controls

Keyboard Shortcuts

  • ⌘T - Toggle highlight bar visibility
  • ⌘, - Open settings
  • ⌘Q - Quit application

Settings

Use the menu bar icon → Settings to open the settings window.

Customize your highlight bar:

  • Color - Choose any color you like
  • Opacity - Adjust from 10% to 80%
  • Height - Set from 20px to 150px

All settings are automatically saved and restored on next launch.

Note

In the current version, HighlightHelper → Settings... from the standard macOS app menu may not work correctly. If that happens, please open settings from the menu bar icon instead.

🛠️ Development

Prerequisites

  • Xcode 14.0 or later
  • macOS 12.0 or later
  • Swift 5.0 or later

Building from Source

# Clone the repository
git clone https://github.com/Mastind/Highlight-Helper.git

# Navigate to project directory
cd HighlightHelper

# Open in Xcode
open HighlightHelper.xcodeproj

# Build and run (⌘R in Xcode)

Project Structure

HighlightHelper/
├── HighlightBarApp.swift      # Main app delegate and menu bar
├── HighlightWindow.swift      # Floating window implementation
├── SettingsView.swift         # Settings interface
├── SettingsManager.swift      # Persistent settings storage
└── Assets.xcassets/           # App icons and assets

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🐛 Known Issues

  • The app requires accessibility permissions to track mouse position globally
  • On first launch, you may need to manually restart the app after granting permissions
  • Depending on the build, keyboard shortcuts may only work while the app is active
  • Unsigned builds may trigger a macOS security warning on first launch
  • The standard macOS app menu entry HighlightHelper → Settings... may not open the settings window correctly in the current version. Please use the menu bar icon → Settings entry instead, which works reliably.

👏 Acknowledgments

  • Claude (Anthropic) - For the patient guidance and coding assistance throughout this project. As someone new to Swift development, I couldn't have built this without the step-by-step help and explanations. (Yeah, Claude himself wrote this sentence.)
  • Inspired by physical reading guides and book highlighters
  • Built with Swift and SwiftUI

📸 Screenshots

Main Interface

Highlight Bar in Action

Settings Window

Settings Window

App Icon


Made with ❤️ for better reading experience

⭐ Star this repo if you find it helpful!

About

A macOS screen reading highlight bar tool that helps you focus on the current line while reading documents.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages