Compare commits

..

14 Commits

+9 -17
View File
@@ -4,14 +4,13 @@ A fully automated break timer for wlroots-based desktop environments (SwayWM, et
## Features ## Features
- **Zero user interaction required** - Automatically tracks work/break cycles. - **Zero user interaction required** - Automatically tracks work/break cycles
- **Dual break timers** - Independent short breaks (20m work → 20s break) and long breaks (45m work → 5m break). - **Dual break timers** - Independent short breaks (20m work → 20s break) and long breaks (45m work → 5m break)
- **Automatic idle detection** - Uses swayidle to detect when you're away from the computer. - **Automatic idle detection** - Uses swayidle to detect when you're away from the computer
- **Pause/Unpause** - Manually pause the timer when needed (paused time doesn't count toward work duration). - **Pause/Unpause** - Manually pause the timer when needed (paused time doesn't count toward work duration)
- **Self-managing log** - Automatically trims old events to keep log size minimal. - **Self-managing log** - Automatically trims old events to keep log size minimal
- **Waybar integration** - Shows countdown timers in your status bar with context menu. - **Waybar integration** - Shows countdown timers in your status bar with context menu
- **No dependencies** - Only requires Python 3 (pre-installed on most Linux systems). - **No dependencies** - Only requires Python 3 (pre-installed on most Linux systems)
- **No daemon process** - Swaylock is the only long-running process. Other scripts are executed to modify or read the log file.
## How It Works ## How It Works
@@ -71,8 +70,7 @@ A fully automated break timer for wlroots-based desktop environments (SwayWM, et
"menu": "on-click", "menu": "on-click",
"menu-file": "/path/to/menu.xml", "menu-file": "/path/to/menu.xml",
"menu-actions": { "menu-actions": {
"skip-long": "break-event skip_long", "skip-long": "break-event skip_long"
"toggle-pause": "break-event toggle-pause"
} }
} }
} }
@@ -205,12 +203,6 @@ Right-click the break timer widget in Waybar to access the context menu:
└──────────────────────┘ └──────────────────────┘
``` ```
## Similar Projects
- [Workrave](https://workrave.org/) - The original, and a great app, but does not have very robust Wayland support at the time this tool was created.
- [BreakTimer](https://breaktimer.app/) - Very nice interface, but only supports a single timer.
- [ianny](https://github.com/zefr0x/ianny) - Supports Wayland, but otherwise I have not explored deeply.
## License ## License
MIT Public domain - use however you like!