Skip to content

2qp/eyedle

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Eyedle - Overlay for Eye Breaks

Features

  • Customizable Timer
  • Overlay
  • Pre/Post Scripting: Automate actions before and after the break notifications.

Key Design Goals

Eyedle was built with efficiency in mind:

  • Low Resource Usage
  • Minimal Design
  • Optimized Performance

Keep these goals in mind for any future updates or changes.


Screenshots

screenshot 1


Installation

Prerequisites

To run Eyedle, you’ll need the following:

  • macOS 15 (Sequoia) or higher

Installation Steps

  1. Download the ZIP file from Releases
  2. Extract the downloaded ZIP archive.
  3. Move the .dmg file to your Documents or /Users/<your-username>/bin folder.
  4. Open the .dmg file.

do not run it directly from the Downloads to avoid App Translocation.


Usage

Scripting

Eyedle supports the following file extensions for automation scripts:

  • .scpt (AppleScript)
  • .sh (Shell Script)

Script directories for pre- and post-notification actions:

USER_PRE_NOTIFY_SCRIPTS_DIR="$HOME/documents/eyedle/pre"
USER_POST_NOTIFY_SCRIPTS_DIR="$HOME/documents/eyedle/post"

Automation Phases

Eyedle provides two main automation phases: PRE_NOTIFY and POST_NOTIFY.

  1. PRE_NOTIFY:

    • Purpose: Executes before the notification is triggered.
    • Functionality: You can prevent the overlay from showing (e.g., with conditions), or prepare system states before the notification occurs.
    • Script Directory:

    Place your PRE_NOTIFY scripts in the following directory:

    $HOME/documents/eyedle/pre/

    Example: Preventing:

    echo "skip"  # Prevent notification/overlay

    In AppleScript:

    return "skip"  # Skip notification/overlay
  2. POST_NOTIFY:

    • Purpose: Executes after the notification and right on break time starts.
    • Functionality: Perform post-notification actions, such as pausing music or adjusting system settings.
    • Script Directory:

    Place your POST_NOTIFY scripts in the following directory:

    $HOME/documents/eyedle/post/

    Example: Pausing music after a notification:

    Shell Script:

    # pause_music.sh
    osascript -e 'tell application "Music" to pause'

    AppleScript:

    tell application "Music"
        if player state is playing then
            pause
        end if
    end tell

Configuration

  • Notify Duration
  • Break Interval
  • Break Duration

Contributing

#

License

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

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors