Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/0xzer0x/prayer-times
Bash script to manage and display Islamic prayer times with support for Waybar and desktop notifications.
https://github.com/0xzer0x/prayer-times
bash bspwm dunst dwm hyprland i3 muslim muslim-prayer-times polybar prayer-times prayertimes sh shell-script sway waybar yad
Last synced: 3 months ago
JSON representation
Bash script to manage and display Islamic prayer times with support for Waybar and desktop notifications.
- Host: GitHub
- URL: https://github.com/0xzer0x/prayer-times
- Owner: 0xzer0x
- License: mit
- Created: 2023-09-08T13:18:36.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-03T09:39:01.000Z (5 months ago)
- Last Synced: 2024-10-13T02:08:50.155Z (4 months ago)
- Topics: bash, bspwm, dunst, dwm, hyprland, i3, muslim, muslim-prayer-times, polybar, prayer-times, prayertimes, sh, shell-script, sway, waybar, yad
- Language: Shell
- Homepage:
- Size: 470 KB
- Stars: 12
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
🌙 Prayer Times
A versatile Bash script designed to manage and display Islamic prayer times. It
retrieves prayer schedules based on the user's geographical coordinates and
provides notifications for each prayer. The script supports multiple languages
and integrates seamlessly with notification daemons like **dunst** and **mako**.
Inspired by [Nofarah Tech](https://www.youtube.com/@NofarahTech)'s prayer times scripts, this version also includes
added support for status bars like [Waybar](https://github.com/Alexays/Waybar) and integrated desktop notifications.
### 🚀 Quick Start
1. Clone the repo
```bash
git clone https://github.com/0xzer0x/prayer-times.git
```
2. Run the install script
```bash
cd prayer-times
./install.sh
```
### 📦 Dependencies
- `jq`
- `at`
- `yad`
- `mpv`
- `curl`
- `dunst` (x11)
- `polybar` (x11)
- `mako` (wayland)
- `waybar` (wayland)
- [Nerd Font](https://www.nerdfonts.com/) (recommended)
### 🔧 Procedures
1. Copy files to their corresponding location on your system
2. Set the parameters for the script
- `lat`: latitude
- `long`: longitude
- `method`: calculation method
- `print_lang`: language to print prayer times schedule in (`ar`/`en`)
- `notify`: notification daemon (`mako`/`dunst`)
3. Activate systemd user unit
4. Add statusbar module
5. Add notification daemon rule
6. Configure Yad dialog to show in floating mode
### 🔄 Systemd Unit
- Run one of the following commands to activate the service for your user
- `systemctl --user enable --now prayer-times.service # start on boot`
- `systemctl --user enable --now prayer-times.timer # start on boot + every 8 hours`
### 🖥️ Statusbar Module
#### Polybar
- Add the following to your [polybar config](https://github.com/polybar/polybar/wiki/Configuration) file (`~/.config/polybar/config[.ini]`) then add the module
- Modify colors according to your liking (replace #83CAFA)
```ini
[module/prayers]
type = custom/script
exec = $HOME/.local/bin/prayer-times status
interval = 60
label = %{A:$HOME/.local/bin/prayer-times yad:}%{F#83CAFA} %{F-} %output%%{A}
```
#### Waybar (Wayland)
- Add the following custom module to your [waybar config](https://github.com/Alexays/Waybar/wiki/Configuration) (`~/.config/waybar/config`)
```json
"custom/prayers": {
"interval": 60,
"return-type": "json",
"exec": "$HOME/.local/bin/prayer-times waybar",
"on-click": "$HOME/.local/bin/prayer-times yad",
"format": " {}",
}
```
- You can style the module using the class of the next prayer (e.g. `Asr`)
### 🔔 Notification Athan
#### Dunst
- Add the following rule to your dunstrc file (`~/.config/dunst/dunstrc`)
```ini
[play_athan]
summary = "Prayer Times"
script = "$HOME/.local/bin/toggle-athan"
```
#### Mako (Wayland)
- Add the following criteria/rule to mako config (`~/.config/mako/config`)
```ini
[summary="Prayer Times"]
on-notify=exec $HOME/.local/bin/toggle-athan
on-button-left=exec $HOME/.local/bin/toggle-athan
```
### 🖼️ Yad Dialog
- Window Title: `Prayers`
- Configure your window manager to show the Yad window in floating mode and you're all set!
- Example window rule for [Hyprland](https://hyprland.org/)
```ini
windowrulev2 = float,class:(yad)
windowrulev2 = move cursor -50% 30,title:(Prayers)
```
### 📚 References
- Nofarah Tech | نوفرة تك ([video](https://www.youtube.com/watch?v=BnSXo5p1ZLw)) ([dotfiles](https://github.com/HishamAHai/dotfiles/tree/main/.local/bin))
- [Aladhan API](https://aladhan.com/prayer-times-api#GetTimings)
- [Polybar config](https://github.com/polybar/polybar/wiki/Module:-script)
- [Default dunstrc](https://github.com/dunst-project/dunst/blob/master/dunstrc)
- [Mako man page](https://github.com/emersion/mako/blob/master/doc/mako.5.scd)
- [Waybar Custom Module](https://github.com/Alexays/Waybar/wiki/Module:-Custom)