Omarchy Athkar Plugin (abdulrahman.athkar)
A native, elegant Islamic Dhikr, Dua & Tasbeeh companion for the Omarchy Desktop (Quickshell). Integrates the complete UmmahAPI supplications catalog with 28 categories, 136+ authentic Duas, smart scheduled time-of-day reminders, interactive Tasbeeh counter, and multi-action menubar widget.
Developed by @abdalrohman.
<p align="center"> <img src="assets/screenshot_reader.png" width="80%" alt="Athkar Active Reader & Tasbeeh" /> </p> <p align="center"> <img src="assets/screenshot_library.png" width="80%" alt="Athkar 28-Category Library" /> </p>
✨ Features
📿 Menubar Widget (BarWidget.qml)
- Real-Time Display: Positioned in the active bar with Islamic Tasbeeh glyph (
📿), countdown to next periodic reminder, active Dhikr text, or current Tasbeeh progress (📿 [12/33]). - Multi-Action Interactions:
- Left-Click: Open and toggle the detailed popup panel.
- Middle-Click: Increment the Tasbeeh counter directly from the bar without opening the panel.
- Right-Click: Cycle through widget display formats.
- Scroll Wheel: Quick switch between Previous / Next supplications.
- Multiple Display Formats (Right-Click to cycle):
[Icon] Next in Xm(e.g.📿 7m 30s)[Icon] Current Thikr(e.g.📿 سبحان الله وبحمده)[Icon] [Tasbeeh X/Y](e.g.📿 [12/33])[Icon]only
📖 Popup Details Panel (Panel.qml)
1. Active Reader & Interactive Tasbeeh Mode
- Calligraphy Display: Clear, beautiful Arabic typography with full vowel marks (Tashkeel) and Hadith virtue notes (فضيلة الذكر).
- Phonetic Transliteration & English Translation: Toggleable Latin pronunciation and accurate English meanings.
- Authentic Hadith Citations: Sourced directly from Sahih al-Bukhari, Sahih Muslim, Sunan Abi Dawud, Jami` at-Tirmidhi, and Sunan an-Nasa'i.
- Interactive Tasbeeh Counter:
- Click anywhere or press the Spacebar / Enter keys to count.
- Optional subtle audio tick (
click.wav) on each count and completion chime (complete.wav) upon reaching the target. - Auto-advance to the next Dhikr upon completing repetitions.
- Action Toolbar:
- ⭐ Favorites: Star and pin favorite supplications.
- 📋 Copy: Quick copy Arabic text and English translation to clipboard.
- 🔀 Next / Prev: Navigate through supplications.
- 🔄 Reset: Reset current count.
2. 28-Category Library Explorer & Live Search
- UmmahAPI Integration (100% Offline-First):
- Bundled with 28 curated categories and 136+ supplications:
- Morning Adhkar, Evening Adhkar, Wudu & Purification, During Prayer, After Prayer, Sleep & Waking, Food & Drink, Travel, Home, Masjid, Distress & Anxiety, Forgiveness & Istighfar, Illness & Healing, Weather & Nature, Knowledge, Parents & Family, Guidance & Istikhara, Gratitude, Protection, General Dhikr, Marriage, Hajj & Umrah, Grief & Loss, Children, Provision & Wealth, Night Prayer (Tahajjud), Quran Recitation, and Short Periodic Dhikr.
- Bundled with 28 curated categories and 136+ supplications:
- Instant Search: Search in real time across Arabic text, English title, translation, and Hadith source.
- Personal Custom Athkar Creator: Add, edit, and save your own custom Duas and set personalized repetition targets.
3. Smart Scheduled Reminders & Settings
- Time-of-Day Reminders:
- 🌅 Morning Adhkar: Configurable morning time slot (default:
07:00). - 🌇 Evening Adhkar: Configurable evening time slot (default:
17:00). - 🌙 Bedtime Adhkar: Configurable bedtime slot (default:
22:30).
- 🌅 Morning Adhkar: Configurable morning time slot (default:
- Periodic Background Reminders:
- Regular notifications with randomized or sequential rotation every
1m,3m,5m,10m,15m,30m,1h, or2h. - Notification category filtering: choose whether periodic popups draw from all Duas, short Dhikr only, morning/evening only, or favorites only.
- Regular notifications with randomized or sequential rotation every
- Do Not Disturb (DND) / Pause:
- One-click button to pause all desktop notifications for
30m,1h, or until tomorrow.
- One-click button to pause all desktop notifications for
- Audio & Haptic Feedback:
- Master volume slider (0% – 100%) applied via
pw-play/paplay/mpv/ffplay. - Independent toggles for reminder chime, count tick sound, and completion sound.
- Master volume slider (0% – 100%) applied via
⌨️ Keyboard Shortcuts
| Shortcut | Action |
|---|---|
Space / Enter |
Increment Tasbeeh counter (+1) |
N / L |
Next supplication |
P / H |
Previous supplication |
R |
Reset current counter to 0 |
F |
Toggle favorite star on active supplication |
1 |
Switch to Tasbeeh & Active Reader tab |
2 |
Switch to Library Explorer & Search tab |
3 |
Switch to Settings drawer |
Esc |
Close panel |
🛠️ Installation & Activation
Method 1: Via Omarchy CLI (Recommended)
omarchy plugin add https://github.com/abdalrohman/omarchy-athkar --enable
Method 2: Manual Installation
- Clone the repository into your Omarchy plugins directory:
git clone https://github.com/abdalrohman/omarchy-athkar.git ~/.config/omarchy/plugins/abdulrahman.athkar
- Enable the plugin in your center bar:
omarchy plugin enable abdulrahman.athkar center
- Restart your Omarchy shell:
omarchy restart shell
⚙️ Configuration & State Persistence
State and user preferences are automatically saved at:
~/.local/state/omarchy/settings/athkar.json
State loading is strictly bounded at the descriptor level (capped at 64 KiB via head -c 65537). If a state file is oversized or unreadable, the plugin safely falls back to defaults. Writes are atomic and symlink-safe.
📦 Dependencies & System Requirements
head(coreutils) from base system (used for descriptor-bounded state reads)python3(for atomic state writes and clipboard/audio helpers)omarchy-notification-send(from Omarchy desktop)- Audio player (
pw-play,paplay,mpv, orffplay) for chime/tasbeeh playback
📄 License
Released under the MIT License by @abdalrohman.