Watch gh-radar's animated ticker and notifications in action!

✨ Key Features

Animated Ticker: Waybar text changes dynamically when a new push occurs. It shows the branch and commit message, then the repository name, and finally returns to your username.
Audio Alerts: Plays a retro notification sound instantly upon detecting a new push.
Avatar Notifications: Sends a native desktop notification containing the committer's actual GitHub avatar and commit details.
Interactive Buttons: Left-click to open your GitHub profile, Right-click to open notifications directly from Waybar.
API Optimized: Uses GitHub's ETag headers to respect API rate limits and keep network usage near zero when idle.

🛠️ Installation & Setup

1. Clone & Copy Files

git clone https://github.com/ahmed-x86/gh-radar.git
cd gh-radar

# Copy sound to your config
cp -r sounds ~/.config/

# Setup Waybar scripts directory
mkdir -p ~/.config/waybar/scripts
cp github_radar.py ~/.config/waybar/scripts/
chmod +x ~/.config/waybar/scripts/github_radar.py

2. Add Your Credentials (.env)

Create a .env file to authenticate with GitHub:

nano ~/.config/waybar/scripts/.env

Add the following (replace with your info):

GITHUB_USERNAME=ahmed-x86
GITHUB_PAT=your_personal_access_token_here

3. Waybar Configuration

Add this module to your config.jsonc (e.g., in modules-right):

"custom/github-radar": {
    "format": "{}",
    "return-type": "json",
    "exec": "python3 -u ~/.config/waybar/scripts/github_radar.py",
    "on-click": "xdg-open https://github.com/ahmed-x86",
    "on-click-right": "xdg-open https://github.com/notifications",
    "restart-interval": 20
}

4. Waybar Styling

Make it look authentic by adding this to your style.css:

#custom-github-radar {
    background-color: #24292e;
    color: #ffffff;
    border-radius: 10px;
    padding: 0px 10px;
    margin: 4px 5px;
    font-weight: bold;
    border: 1px solid #444c56;
    transition: all 0.3s ease;
}

#custom-github-radar:hover {
    background-color: #2ea043;
    color: #ffffff;
    border-color: #2ea043;
}

Dependencies: Ensure you have requests and python-dotenv installed via pip. The script uses mpv or paplay for sounds.

> i rice my desktop btw