https://github.com/morgant/xpomodmenu
An X11 menu to control `pomod`
https://github.com/morgant/xpomodmenu
menu mlvwm mlvwmrc pomod pomodoro pomodoro-timer x11 xmenu
Last synced: about 1 year ago
JSON representation
An X11 menu to control `pomod`
- Host: GitHub
- URL: https://github.com/morgant/xpomodmenu
- Owner: morgant
- License: mit
- Created: 2024-12-20T23:37:49.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-06T19:51:52.000Z (over 1 year ago)
- Last Synced: 2025-04-12T19:46:42.592Z (about 1 year ago)
- Topics: menu, mlvwm, mlvwmrc, pomod, pomodoro, pomodoro-timer, x11, xmenu
- Language: Shell
- Homepage:
- Size: 11.4 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# xpomodmenu
by Morgan Aldridge
## OVERVIEW
A minimal set of X11 utilities which interact with & control Lucas de Sena's [pomod](https://github.com/phillbush/pomod/) pomodoro timer server & client: `xpomodbell` & `xpomodmenu`. They are powered by several other tools by Lucas de Sena, including [wmlaunchbutton](https://github.com/phillbush/wmlaunchbutton) & [xmenu](https://github.com/phillbush/xmenu), plus [mpv](https://mpv.io) for audio playback. They are intended for use with the [MLVWM](https://github.com/morgant/mlvwm) window manager, specifically the [mlvwmrc](https://github.com/morgant/mlvwmrc) configurations, as a "Menu Extra" swallowed into the menu bar.
## FEATURES
* `xpomodbell`:
* Launches `pomod` and monitors it for pomodoro cycle changes
* Plays bell sounds at the start of a new cycle:
* Three temple bells when beginning a pomodoro (focus)
* A single temple bell when beginning a break (short or long)
* `xpomodmenu`:
* Shows the current state of `pomod` (configuration error, stopped, or current pomodoro cycle)
* Shows the elapsed time in the current pomodoro cycle
* Supports starting/stopping the current pomodoro cycles
* Supports launching a floating window showing the current pomodoro cycle and elapsed time
* `xpomoinfo`:
* Shows a floating window with:
* The current state of `pomod` (stopped or current pomodoro cycle) in the window title
* The elapsed time in the current pomodoro cycle in the window
* mlvwmrc:
* Menu Extra:
* Provides an icon in the MLVWM menu bar which will show the `xpomodmenu` when clicked on
* Application Styles:
* Provides icon & window styling for `xpomoinfo` floating window
## PREREQUISITES
* [mpv](https://mpv.io)
* [pomod](https://github.com/phillbush/pomod)
* [wmlaunchbutton](https://github.com/phillbush/wmlaunchbutton)
* [xmenu](https://github.com/phillbush/xmenu)
* `xterm`
## INSTALLATION
```
make && make install
```
### Menu Extra
Install the Menu Extra in your `~/.mlvwm/MenuExtras/` directory by running:
```
make install-mlvwmrc-menuextra
```
Next, edit your `~/.mlvwm/apps/.AppsManifest` configurationfile to add the following line:
```
Read .mlvwm/apps/xpomoinfo
```
Next, edit your `~/.mlvwm/MenuBar` configuration file to add the following line in the appropriate "Menu Extras" section:
```
Read .mlvwm/MenuExtras/xpomodmenu
```
Finally, restart `mlvwm`.
## USAGE
### Starting the Bell Server
While you can just start the `xpomod` server directly and `xpomodmenu` will work with it, you'll want to start the bell server which will play a notification sound when starting a new pomodoro focus or break cycle. The bell server will start the `xpomod` server to monitor for pomodoro cycle changes:
```
xpomodbell
```
Since this is intended to be used with `mlvwmrc`, it's suggested that you add the following line to your `~/.mlvwm/.initrc` configuration:
```
Exec "xpomodbell" exec /usr/local/bin/xpomodbell &
```
#### Options
`xpomodbell` does support a few command line options. Run `xpomodbell -h` for help.
##### Bell Sound Volume
You can specify the volume at which to play the bell notification sound by passing in a percentage (0..100) with the `-V` option (the default is `100`). For example:
```
xpomodbell -V 75
```
##### Pomodoro Work & Break Duration
You can specify the duration of the pomodoro work cycle by passing in a number of minutes (default is `25`) with the `-p` option. Similarly, the short & long break durations by passing in a number of minutes with the `-b` (short) and `-B` (long) options (default is `5` for short break and `30` for long break). For example:
```
xpomodbell -p 50 -b 15 -B 60
```
### The Pomodoro Menu
You can manually execute `xpomodmenu` in any way you prefer, which will show the pomodoro menu at your cursor. These instructions assume you've installed the Menu Extra as described in the installation instructions and click on the icon in the MLVWM menu bar to open the menu.
__TBD__
## CHANGE LOG
See [CHANGELOG.md](CHANGELOG.md) for detailed version history.
## LICENSE
Released under the [MIT license](LICENSE).
Mark James' [FamFamFam Silk Icons](https://github.com/markjames/famfamfam-silk-icons) licensed under the [Creative Commons Attribution 2.5 License](http://creativecommons.org/licenses/by/2.5/).
[Keisu temple bell](https://freesound.org/people/milivolt/sounds/367128/) by [milivolt](https://freesound.org/people/milivolt/) licensed under the [Creative Commons Attribution 4.0 License](https://creativecommons.org/licenses/by/4.0/).
temple_bell_002.wav by tec_studio -- https://freesound.org/s/668647/ -- License: Creative Commons 0
[temple_bell_002.wav](https://freesound.org/people/tec_studio/sounds/668647/) by [tec_studio](https://freesound.org/people/tec_studio/) licensed under the [Creative Commons Zero 1.0 License](http://creativecommons.org/publicdomain/zero/1.0/).