https://github.com/kzhovn/statusbar-pomo-obsidian

A status bar pomodoro timer plugin for Obsidian.
https://github.com/kzhovn/statusbar-pomo-obsidian

obsidian-md obsidian-plugin

Last synced: about 1 month ago
JSON representation

A status bar pomodoro timer plugin for Obsidian.

• Host: GitHub
• URL: https://github.com/kzhovn/statusbar-pomo-obsidian
• Owner: kzhovn
• License: mit
• Created: 2021-06-20T18:24:05.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-04-10T07:00:59.000Z (over 1 year ago)
• Last Synced: 2024-06-17T22:48:15.087Z (3 months ago)
• Topics: obsidian-md, obsidian-plugin
• Language: TypeScript
• Homepage:
• Size: 3.16 MB
• Stars: 70
• Watchers: 2
• Forks: 19
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - kzhovn/statusbar-pomo-obsidian - A status bar pomodoro timer plugin for Obsidian. (TypeScript)

README

        
# Status Bar Pomo Timer for Obsidian

Plugin that displays a [pomodoro timer](https://en.wikipedia.org/wiki/Pomodoro_Technique) in the [Obsidian](https://obsidian.md/) status bar. 

![timer screenshot](timer_screenshot.png)

## Use

Click the clock icon in the left ribbon panel to start. Click again to toggle pause.

All of these actions are available from the command pallete. You can also set a hotkey to quit the timer.

## Settings

You can change the duration of the pomodoro timer, breaks, and interval between long breaks, and toggle the end of timer sound and white noise.

Autostart timer allows you to toggle whether the next break or pomodoro start automatically after the next, or waits for you to start it. If disabled, you can specify a number of pomodoro-and-break cycles that run automatically (for instance, if you want to run two pomodoros and their corresponding breaks without stopping and then pause, enter 2).

### Logging

If you enable logging, the plugin will write to the file you specify as your log file at the end of each pomodoro. If no such file exists, it will be created at the end of your first pomo. By default, the log message is "🍅 dddd, MMMM DD YYYY, h:mm A" (e.g. "🍅 Friday, July 16 2021, 6:18 PM"), but you can specify your own message using [moment display format](https://momentjs.com/docs/#/displaying/format/).

"Log to daily note" will append the log to the daily note. Please note that this currently *only* works by appending to the end of the file.

"Log active note" will include a link to the active note at the time the pomodoro timer started in the log message. Be default, the link to the note will appear after the timestamp, but you can customize the location using [{{logFile}}].

You can open the current log file by clicking the timer.