https://github.com/qdzhang/tomato-timer

A tomato-timer using pomodoro technique in Emacs
https://github.com/qdzhang/tomato-timer

emacs emacs-lisp emacs-package pomodoro pomodoro-timer

Last synced: 20 days ago
JSON representation

A tomato-timer using pomodoro technique in Emacs

• Host: GitHub
• URL: https://github.com/qdzhang/tomato-timer
• Owner: qdzhang
• Created: 2022-10-21T00:56:41.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-09-05T01:45:43.000Z (4 months ago)
• Last Synced: 2024-10-30T19:46:23.466Z (2 months ago)
• Topics: emacs, emacs-lisp, emacs-package, pomodoro, pomodoro-timer
• Language: Emacs Lisp
• Homepage:
• Size: 27.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.org

Awesome Lists containing this project

README

        
* Tomato-timer

A tomato-timer using pomodoro technique. Use the built-in =notifications=

library.

[[tomato-timer.png]]

** Installation

Download the repository, then

#+begin_src elisp

(load "/path/to/tomato-timer.el")

(require 'tomato-timer)

#+end_src

** Usage

=M-x Tomato-timer= . This function will start a new tomato timer.

Use =list-timers= to show all timer. If you want to close a tomato timer, put

your point in the entry, press =c= will cancel it.

** Customization

- =tomato-timer-play-sound-p= : whether play sound when a tomato-timer

  ends. Default is =t= , set to nil to make it silent.

- =tomato-timer-audio-file-path= : the path of alert audio file. Default is the

  plugin directory.

- =tomato-timer-audio-player= : the audio player to play the alert

  audio. Default is mpv.

- =tomato-timer-mpv-args= : the extra mpv arguments. Default is =--no-config= in

  order to avoid conflict with your other fancy mpv configurations.

- =tomato-timer-work-time= : the time in minutes for a tomato-timer

  period. Default is =25=.

- =tomato-timer-show-modeline-indicator-p= : whether show timer indicator in

  modeline. Default is =t=, set =nil= will not show indicator.

- =tomato-timer-notification-title= : the title of the notification. Default is

  =Tomato ends= .

- =tomato-timer-notification-body=  : the body of the notification. Default is

  = min passed, take a break!= .

- =tomato-timer-mode-line-indicator-delimiter= : the delimiter of the mode line

  indicator. It is a list contains two string elements, first is the left delimiter,

  and the second is the right delimiter. Default is ='("" "")= .

** Credit

The mode line indicator is modified from syohex's [[https://github.com:/syohex/emacs-mode-line-timer][emacs-mode-line-timer]].