An open API service indexing awesome lists of open source software.

https://github.com/semanticdata/obsidian-pomodoro

PomoBar is a minimalist Pomodoro timer that lives in your Obsidian status bar with optional audio notifications to keep you on track
https://github.com/semanticdata/obsidian-pomodoro

obsidian obsidian-plugin pomodoro productivity

Last synced: about 2 months ago
JSON representation

PomoBar is a minimalist Pomodoro timer that lives in your Obsidian status bar with optional audio notifications to keep you on track

Awesome Lists containing this project

README

          

# ๐Ÿ… PomoBar

**The Minimalist Pomodoro Timer That Keeps You Focused in Obsidian**

Boost your productivity without ever leaving your notes. PomoBar is a sleek, unobtrusive Pomodoro timer that lives in your status barโ€”with optional audio notifications to keep you on track. Seamlessly integrate the Pomodoro Technique into your workflow with visual and audible cues.

## โœจ Why PomoBar?

### ๐Ÿง˜ Stay Focused, Not Distracted

PomoBar lives in your status bar, providing a constant but subtle reminder of your work session without cluttering your workspace or interrupting your flow.

### ๐Ÿ”Š Optional Audio Notifications

Get gentle sound alerts when timers complete. Choose from built-in sounds or upload your own custom audio files from your vault.

### ๐Ÿ–ฑ๏ธ Intuitive & Quick Controls

Manage your timers with simple clicksโ€”no need to open new windows or type commands.

### ๐Ÿ”„ Automated Flow

Optional auto-progression automatically starts the next timer in your Pomodoro cycle, or pause after each session for manual control.

### โš™๏ธ Your Rhythm, Your Rules

Deep work sessions aren't one-size-fits-all. Custom-tune your work/break intervals to match your energy levels.

---

## ๐Ÿ“ธ See It In Action

| Default View | Running View |
| :------------------------------------------------------------: | :------------------------------------------------------------: |
| ![screenshot-1](./docs/screenshots/screenshot-1.png) | ![screenshot-2](./docs/screenshots/screenshot-2.png) |
| _Also available with icons!_ | _...and they change when running!_ |
| ![screenshot-icon-1](./docs/screenshots/screenshot-icon-1.png) | ![screenshot-icon-2](./docs/screenshots/screenshot-icon-2.png) |

---

## ๐ŸŽฎ How It Works

The timer appears in your status bar. Control everything with simple mouse clicks:

- **Left-click** - Start or pause the timer
- **Middle-click** - Instantly cycle between work, short break, and long break timers
- **Right-click** - Reset the current timer (when paused)

### โŒจ๏ธ Keyboard-Friendly Commands

Prefer keyboard shortcuts? PomoBar includes comprehensive commands you can assign to custom hotkeys in Obsidian's settings:

| Command | Description |
| ---------------------------- | ------------------------------------------------ |
| Start/Pause timer | Toggle the timer on or off |
| Reset current timer | Reset the timer for the current session |
| Cycle to next timer duration | Switch between work, short break, and long break |
| Toggle sound notifications | Enable or disable audio alerts on the fly |
| Toggle status bar visibility | Show or hide the timer display |
| Toggle icon visibility | Control the status bar icon display |

For more detailed instructions, check out our [full documentation](https://semanticdata.github.io/obsidian-pomodoro/).

## โš™๏ธ Configurable to Your Needs

PomoBar adapts to your unique work style:

- Flexible Durations - Customize work, short break, and long break durations
- Cycle Control - Set how many work sessions before a long break
- Audio Options - Choose from 6 built-in sounds or use your own files
- Volume Control - Adjust sound volume to your preference
- Visual Preferences - Show/hide icons and the entire status bar timer
- Auto-Progress - Automatically start the next session or pause for manual control

## ๐Ÿš€ Installation

### From Obsidian Community Plugins (Recommended)

1. Open **Settings** โ†’ **Community Plugins** in Obsidian
2. Disable **Safe Mode** if it's enabled
3. Click **Browse** and search for "PomoBar"
4. Click **Install**, then **Enable** the plugin

### Manual Installation

1. Download the latest release files (`main.js`, `manifest.json`, `styles.css`) from the [releases page](https://github.com/semanticdata/obsidian-pomodoro/releases)
2. Create a new folder named `pomobar` inside your vault's `.obsidian/plugins/` directory
3. Copy the downloaded files into this new folder
4. Reload Obsidian (Ctrl/Cmd + R) and enable the plugin in the settings

## ๐Ÿ’ฌ Community & Support

PomoBar is a free and open-source project built for the Obsidian community. We believe in the power of collaboration and welcome contributions of all kinds. Whether you're a developer, a designer, or just an enthusiastic user, you can help shape the future of this plugin.

- ๐Ÿ“– Documentation - [Full documentation](https://semanticdata.github.io/obsidian-pomodoro/)
- ๐Ÿ› Bug Reports - [Report an issue](https://github.com/semanticdata/obsidian-pomodoro/issues)
- ๐Ÿ’ก Feature Requests - [Start a discussion](https://github.com/semanticdata/obsidian-pomodoro/discussions)
- ๐Ÿ”ง Contributing - [Contribution guidelines](https://github.com/semanticdata/obsidian-pomodoro/blob/master/CONTRIBUTING.md)
- ๐Ÿ“œ License - [MIT License](https://github.com/semanticdata/obsidian-pomodoro/blob/master/LICENSE)

---

**Ready to boost your productivity?** Install PomoBar from the [Obsidian Community Plugins](https://obsidian.md/plugins?search=PomoBar) marketplace today!