https://github.com/TiagoDanin/Polybar-Break-Timer
Take a break
https://github.com/TiagoDanin/Polybar-Break-Timer
breaktimer polybar polybar-scripts
Last synced: 5 months ago
JSON representation
Take a break
- Host: GitHub
- URL: https://github.com/TiagoDanin/Polybar-Break-Timer
- Owner: TiagoDanin
- License: mit
- Created: 2018-10-22T13:31:33.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-25T00:27:34.000Z (about 2 years ago)
- Last Synced: 2024-11-09T02:52:23.626Z (6 months ago)
- Topics: breaktimer, polybar, polybar-scripts
- Language: JavaScript
- Homepage: https://tiagodanin.github.io/Polybar-Break-Timer/
- Size: 29.3 KB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- Awesome-Polybar - Break Timer
README
# Polybar Break Timer
Take a break
- Mouse scroll = Set Time
- Click Left = Enable
- Click Right = Disable
Inspired in [gnome-break-timer](https://github.com/GNOME/gnome-break-timer).
## Installation
This is a [Node.js](https://nodejs.org/) module available through the
[npm registry](https://www.npmjs.com/). It can be installed using the
[`npm`](https://docs.npmjs.com/getting-started/installing-npm-packages-locally)
or
[`yarn`](https://yarnpkg.com/en/)
command line tools.
```sh
npm install polybar-break-timer -g
```
## Usage
Polybar Config:
```
; Polybar Break Timer
[module/breaktimer]
type = custom/script
format-prefix = "Break Timer "
format-foreground = ${colors.verdeclaro}
exec = polybar-break-timer $HOME/.config/polybar/.env/break-timer 20
click-left = echo left >> $HOME/.config/polybar/.env/break-timer
click-middle = echo middle >> $HOME/.config/polybar/.env/break-timer
click-right = echo right >> $HOME/.config/polybar/.env/break-timer
scroll-up = echo scrollUp >> $HOME/.config/polybar/.env/break-timer
scroll-down = echo scrollDown >> $HOME/.config/polybar/.env/break-timer
tail = true
```
And create a file in $HOME/.config/polybar/.env/break-timer.
## Dependencies
- [node-notifier](https://ghub.io/node-notifier): A Node.js module for sending notifications on native Mac, Windows (post and pre 8) and Linux (or Growl as fallback)
- [polybar-helpers](https://ghub.io/polybar-helpers): Polybar - Helpers to create plugin/module using NodeJS
- [tail](https://ghub.io/tail): tail a file in node
## License
MIT