Gentle Pomodoro

by jamiestudio-lab
5
4
3
2
1
Score: 51/100

Description

A gentle, task-aware Pomodoro timer for Obsidian. Watch a soft day→night gradient instead of a ticking clock, link sessions to your Tasks-plugin items, and keep Dataview-ready daily logs.

Reviews

No reviews yet.

Stats

4
stars
992
downloads
0
forks
51
days
1
days
1
days
0
total PRs
0
open PRs
0
closed PRs
0
merged PRs
2
total issues
0
open issues
2
closed issues
123
commits

README file from

Github

Gentle Pomodoro

A visually soothing, task-integrated Pomodoro timer for your daily focus work. Two ambient themes — Classic (day→night gradient) or Frosted Glass (drifting color orbs behind a frosted pane) — instead of a ticking clock, task linking with the Tasks plugin, and Dataview-friendly daily logs.

v0.5.6 (beta). Available in the Obsidian Community Plugins catalog. See Install.

Features

🍅 Gentle visual timer

  • Two themes: Classic (the original day → dusk → night gradient) and Frosted Glass (three drifting color orbs behind a 3D frosted pane — pastel-twilight palette in light mode, fireplace warmth in dark mode). Switch in the main Obsidian Settings tab.
  • Ambient shape that transitions through warm → cool colors as the timer runs.
  • Configurable focus / short break / long break durations. Classic Pomodoro: long break every 4 focus sessions (configurable).
  • Overtime tracking — the timer counts up with a subtle glow after the session ends.
  • Estimated end time — while a session runs, the timer shows the wall-clock time you'll finish (e.g. Ends 15:30, with (+1 day) if it crosses midnight): a calm way to know when you're free without watching the countdown. Toggle in settings.
  • Optional audio cues (war drum on start, bell/ding on finish) — bundled into the plugin, no extra downloads needed.
  • Respects prefers-reduced-motion: timer animations soften when the OS requests it.

✅ Task integration

  • Pick tasks straight from your vault. Compatible with the Tasks format: - [ ] Task ⏳ 2025-12-23 🆔 abc123 — on any list bullet (-, *, +, or numbered).
  • Smart filtering: Overdue, Today, Tomorrow, and upcoming tasks. Choose the lookahead window (3 / 5 / 7 / 14 / 30 days) in settings; overdue tasks always show.
  • One-click Unlink current task.
  • Opt-in (beta — edits your task files): adds a lifetime 🍅 N count to the task line each time you finish a focus session for it, placed before the Tasks date fields so they keep parsing (e.g. - [ ] Write docs 🍅 3 ⏳ 2025-12-23).
  • Recovery actions (settings buttons + commands): if an older version left markers after your task dates and broke their parsing — Check counts them without changing anything, Repair moves them back in place, Remove deletes the misplaced ones, and Remove all deletes every marker the counter ever wrote (back up your vault first). The writing actions ask for confirmation with exact counts and never touch a 🍅 N you typed yourself.

📊 Daily focus goal

  • Set a daily focus target (default 2h, set to 0 to disable).
  • Status bar shows progress: Today 1h 12m / 2h. Turns green when the goal is met.
  • One-time "goal hit" notice each day. Resets automatically at local midnight.

📝 Dataview-friendly daily logs

  • One markdown file per day: <folder>/YYYY-MM-DD-gentle-pomodoro-log.md.
  • One inline-field line per session (start, end, pauses, duration, status, type).
  • Rename-safe when tasks carry 🆔 — past log lines update on rename, or via the Refresh log task names by ID command.

🧭 Status bar

  • Compact mode/time indicator with today's total focus.
  • Click the dot to open the timer; click the label to toggle the time-left display.

🎵 Lofi study music

  • Paste a YouTube link — a video, a 24/7 live stream (Lofi Girl!), or a playlist — in the plugin settings and a ▶️ play/pause/stop row appears in the timer panel. Audio-only by design: no video is ever shown.
  • Fades in and out: ▶️ eases the music up from silence, ⏸ and ⏹ ease it down before stopping — no snapping in mid-bar. Change your mind mid-fade and it simply carries on.
  • Gentle ducking: session cues (drum, bell, ding) briefly dip the music and ease it back up, so they stay audible without jolting the mix.
  • Loops by default (turn off Loop music to play once), with a Low / Mid / High music volume next to the sound volume in the in-view settings.
  • Resumes where you left off: pause (or close the panel, or quit Obsidian) and the track is queued at that moment next time — press ▶️ to carry on. Nothing auto-plays; ⏹ Stop — or changing the URL — clears the position so the mix starts from the top instead. A link with its own timestamp (?t=90, or an older #t=1m30s) opens there.
  • Fully manual — independent of your sessions; stops when you close the timer panel. If playback truly stops or stalls (stream offline, lost connection), a notice tells you.
  • Desktop only, for now. On iPhone and iPad, YouTube refuses to load its player inside Obsidian at all (error 153): it requires the embedding page to identify itself with an HTTP Referer, and iOS doesn't send one for an app served from a custom scheme. Nothing the plugin can set changes this — it's the same wall other iOS webview apps hit — so the music player is a desktop feature until Obsidian or Apple changes that. Every other feature works on mobile as before.

📱 Mobile (iPad & phone)

  • Touch-friendly: bigger tap targets, one smooth-scrolling panel, and a layout that adapts to the screen — on a short/landscape phone the timer shrinks and gets out of the way.
  • Tap the timer shape to peek at the hidden countdown — it fades back on its own after a couple of seconds. The daily-goal progress shows in the view (Obsidian hides the status bar on mobile).
  • Sound: press Start once to unlock audio, and note iOS's hardware silent switch mutes it — platform constraints, not bugs.
  • Lofi music doesn't play on iPhone or iPad — YouTube won't load its player inside Obsidian there (error 153). See Lofi study music for why; it isn't the link, and no other link works.

Install

  1. Open Settings → Community plugins → Browse.
  2. Search for Gentle Pomodoro and click Install.
  3. Enable it in Community plugins.

Or grab it directly from the Obsidian catalog page.

Manual

  1. Download main.js, manifest.json, and styles.css from the latest release. Audio is bundled into main.js — no extra files needed.
  2. Drop them into <vault>/.obsidian/plugins/gentle-pomo/.
  3. Reload and enable in Community Plugins.

Configure

Settings tab (Settings → Gentle Pomodoro), grouped into sections (findable via Obsidian's settings search on Obsidian 1.13+):

  • Display & behavior: log folder path, auto-open on startup, and show status bar.
  • Timer appearance: theme (Classic default or Frosted glass), day/night indicator, and estimated end time (shown while a session runs).
  • Music: YouTube music URL (video, live stream, or playlist — audio-only playback in the timer panel), show music player (turning it off also stops playback), loop music (replay from the start when it ends; on by default), and resume where you left off (reopen the music at the moment you paused; on by default).
  • Long break: duration (default 15m) and frequency (every N focus sessions, default 4).
  • Daily focus goal: minutes (default 120, 0 disables) and goal-hit notice toggle.
  • Task selector: tasks folder path; show task selector (defaults to hidden until you set a tasks folder path; turning it off unlinks the current task); task lookahead window — how many days ahead the selector reaches (3 / 5 / 7 / 14 / 30 days; default 3), with overdue tasks always shown.
  • Task integration: increment task pomodoro count on finish (opt-in, beta — edits your task files), plus the marker recovery actions: check / repair / remove misplaced / remove all.

In-view panel (gear icon on the timer) — grouped into sections:

  • Timing: focus / short break / long break durations (press Enter to apply).
  • Audio: sound toggle, Low / Mid / High volume, and Low / Mid / High music volume.
  • Auto-start: auto-start break, auto-start focus. When on, a session that runs out automatically plays the end cue and starts the next one. The buttons stay explicit: Stop (finish & next) always switches to the next session paused, while Skip starts it (when auto-start is on).
  • Full-width Reset to defaults button at the bottom.

Layout adapts to narrow sidebars: the timer visual stays sticky at the top, controls keep a comfortable minimum width and the panel scrolls horizontally if needed.

Log format

Each session appends one line to the day's log file:

- 🍅 Focus | Task:: [[Projects/Docs.md|Write docs]] | ID:: abcd12 | Start:: 2025-12-23 10:00:00 | End:: 2025-12-23 10:25:00 | Scheduled:: 1500 | Pauses:: [] | Total:: 1500 | Status:: finished | Type:: focus
- ☕ Rest | Start:: 2025-12-23 10:25:00 | End:: 2025-12-23 10:30:00 | Scheduled:: 300 | Total:: 300 | Type:: short-break
- ☕ Rest | Start:: 2025-12-23 11:00:00 | End:: 2025-12-23 11:15:00 | Scheduled:: 900 | Total:: 900 | Type:: long-break

Type:: is focus | short-break | long-break. Field order is stable — safe to pin Dataview queries against it.

Commands

  • Open view
  • Start / Pause / Finish & next / Skip to next
  • Refresh log task names by ID
  • Show status bar / Hide status bar
  • Check for misplaced pomodoro count markers / Repair misplaced pomodoro count markers / Remove misplaced pomodoro count markers / Remove all pomodoro count markers

Compatible plugins

  • Tasks — the task picker reads its emoji-marker format.
  • Dataview — daily log lines use inline fields, ready to query.

Network use

The plugin makes no network requests on its own — timers, logs, and sounds are all local (audio cues are bundled into main.js).

The one exception is the optional lofi-music feature: when you paste a YouTube URL into YouTube music URL (and Show music player is on), the timer panel embeds YouTube's privacy-enhanced player from www.youtube-nocookie.com to stream the audio, which loads content from YouTube/Google servers. Requests happen only while the timer panel is open with that feature configured; clearing the URL or turning the toggle off stops them entirely. YouTube's handling of those requests is covered by Google's privacy policy.

Issues & feedback

Found a bug or have an idea? Please open an issue on the GitHub issue tracker — bug reports and feature requests are welcome.

Development

npm install
npm run dev          # rollup --watch (rebuilds main.js)
npm run build        # one-shot production build
npm test             # vitest
npm run lint
npm run format       # prettier --write .

CI on every push runs lint, format-check, tests, and build. Release tags push a GitHub Release with main.js, manifest.json, and styles.css attached.

Credits

AI disclaimer

Parts of this plugin were developed with AI assistance (Codex, Gemini, Claude). All code reviewed and tested by the maintainer before release.

License

MIT