110 lines
3.5 KiB
Markdown
110 lines
3.5 KiB
Markdown
# ⚡ Focus Task
|
|
|
|
A productivity plugin for Obsidian that combines task management with focused time tracking, heavily inspired by [Blitzit](https://www.blitzit.app/).
|
|
|
|
## Features
|
|
|
|
### 🎯 Task Management
|
|
- Create tasks with time estimates
|
|
- Organize tasks into customizable lists (Work, Personal, Learning, etc.)
|
|
- Track actual time spent vs. estimated time
|
|
- Filter tasks by list, status, or date
|
|
|
|
### 🍅 Pomodoro Timer
|
|
- Built-in Pomodoro technique support
|
|
- Configurable work sessions (default: 25 minutes)
|
|
- Short and long breaks
|
|
- Auto-start breaks option
|
|
- Visual progress indicator
|
|
|
|
### ⏱️ Stopwatch Mode
|
|
- Free-form time tracking without Pomodoro constraints
|
|
- Alerts when exceeding time estimates
|
|
|
|
### 📊 Statistics
|
|
- Daily completed tasks counter
|
|
- Total focus time tracking
|
|
- Streak tracking for consecutive productive days
|
|
- Pomodoro completion count
|
|
|
|
### 📝 Daily Note Integration
|
|
- Automatically log completed tasks to your daily note
|
|
- Customizable date format and section heading
|
|
- Tracks time spent vs. estimated time
|
|
|
|
### 🎉 Celebrations & Feedback
|
|
- Celebration messages on task completion
|
|
- Sound notifications (optional)
|
|
- Visual feedback for early/late completions
|
|
|
|
## Installation
|
|
|
|
### Manual Installation
|
|
1. Download the latest release from the releases page
|
|
2. Extract the files into your vault's `.obsidian/plugins/focus-task/` folder
|
|
3. Reload Obsidian
|
|
4. Enable the plugin in Settings → Community Plugins
|
|
|
|
### From Source
|
|
1. Clone this repository into your vault's `.obsidian/plugins/` folder
|
|
2. Run `npm install` to install dependencies
|
|
3. Run `npm run build` to compile the plugin
|
|
4. Reload Obsidian and enable the plugin
|
|
|
|
## Usage
|
|
|
|
### Opening Focus Task
|
|
- Click the ⚡ icon in the ribbon (left sidebar)
|
|
- Use the command palette: "Open Focus Task Panel"
|
|
|
|
### Adding Tasks
|
|
- Click "+ Add Task" in the panel
|
|
- Use the command palette: "Quick Add Task"
|
|
- Set a time estimate and assign to a list
|
|
|
|
### Starting a Focus Session
|
|
- **Pomodoro Mode (▶)**: Click the play button on a task to start a timed Pomodoro session
|
|
- **Stopwatch Mode (⏱)**: Click the stopwatch icon to track time freely
|
|
|
|
### Keyboard Shortcuts
|
|
You can assign hotkeys to these commands in Settings → Hotkeys:
|
|
- `Focus Task: Open Focus Task Panel`
|
|
- `Focus Task: Quick Add Task`
|
|
- `Focus Task: Toggle Timer (Play/Pause)`
|
|
- `Focus Task: Complete Current Task`
|
|
- `Focus Task: Start Focus Mode on Next Task`
|
|
|
|
## Settings
|
|
|
|
### Pomodoro Timer
|
|
- **Work Duration**: Length of work sessions (5-60 minutes)
|
|
- **Short Break**: Length of short breaks (1-15 minutes)
|
|
- **Long Break**: Length of long breaks (5-30 minutes)
|
|
- **Long Break Interval**: Pomodoros before a long break
|
|
|
|
### General
|
|
- **Default Time Estimate**: Default estimate for new tasks
|
|
- **Enable Sounds**: Toggle sound notifications
|
|
- **Enable Celebrations**: Toggle celebration messages
|
|
|
|
### Daily Note Integration
|
|
- **Log completed tasks**: Enable/disable daily note logging
|
|
- **Filename format**: Set your daily note naming convention (YYYY-MM-DD)
|
|
- **Section heading**: Customize the heading for logged tasks
|
|
|
|
### Lists
|
|
- Create custom lists with names, icons, and colors
|
|
- Default lists: Work, Personal, Learning
|
|
|
|
## Credits
|
|
|
|
This plugin is heavily inspired by [Blitzit](https://www.blitzit.app/), a fantastic productivity app. Focus Task brings similar functionality directly into Obsidian.
|
|
|
|
## License
|
|
|
|
MIT License - see [LICENSE](LICENSE) for details.
|
|
|
|
## Support
|
|
|
|
- [Report Issues](https://git.cribdev.com/crib/focus-task/issues)
|
|
- [Source Code](https://git.cribdev.com/crib/focus-task) |