Skip to content

TheStoicSpirit/Break-Reminder

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Break Reminder 🧘‍♂️

Lightweight Windows utility for healthy work habits. Get periodic reminders to hydrate, stretch, walk, and rest your eyes.

License Platform PowerShell

Features

  • 120+ professional break messages
  • Choose to take a break or skip
  • Easy scheduling (hourly, custom intervals)
  • Fully customizable
  • Minimal resource usage
  • Modern borderless UI

Quick Start

Requirements: Windows 7+, PowerShell 5.1+ (pre-installed on Win10/11)

  1. Download and extract
  2. Run src\main.ps1 to test
  3. Schedule it (see below)

Auto-Schedule Setup

Task Scheduler:

  1. Open Task Scheduler → Create Basic Task
  2. Set trigger: Daily, repeat every 1 hour
  3. Action: Start powershell.exe
  4. Arguments: -WindowStyle Hidden -ExecutionPolicy Bypass -File "C:\path\to\Break-Reminder\src\main.ps1"
  5. Enable "Run with highest privileges"

No terminal window - Runs silently in background

Customize

Messages: Edit data\messages.txt (one per line)

Settings: Edit data\config.ini

BreakAction=sleep    # Options: sleep, lock, hibernate, shutdown
EnableLogging=true

Structure

break-reminder/
├── src/main.ps1         # Main script
├── data/
│   ├── messages.txt     # Your messages
│   └── config.ini       # Settings
├── docs/                # Documentation
└── .github/             # Issue templates

Troubleshooting

Script won't run?

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

System won't sleep? Check power settings and user permissions.

Change frequency? Edit Task Scheduler trigger interval.

Contributing

Fork → Branch → PR. See CONTRIBUTING.md for details.

License

AGPL-3.0 - See LICENSE


Made with ❤️ for healthier work habits | Issues | Contribute

About

A simple tool that reminds you to take regular breaks while working at your computer

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors