https://github.com/andrewrgarcia/ghost-timer
A lightweight floating countdown timer, built in C using XOSD.
https://github.com/andrewrgarcia/ghost-timer
Last synced: 17 days ago
JSON representation
A lightweight floating countdown timer, built in C using XOSD.
- Host: GitHub
- URL: https://github.com/andrewrgarcia/ghost-timer
- Owner: andrewrgarcia
- License: mit
- Created: 2025-03-17T18:06:11.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2025-03-18T00:52:28.000Z (2 months ago)
- Last Synced: 2025-05-05T20:16:51.597Z (17 days ago)
- Language: C
- Homepage:
- Size: 7.81 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GhostTimer ⏳👻
*A lightweight floating countdown timer for Linux, built in C using XOSD.*
## Overview
GhostTimer is a **C-based countdown timer** that displays a **non-intrusive on-screen timer** using `osd_cat`. It updates smoothly **without flickering** and changes colors as time runs out:
- 🔵 **Cyan** → More than 50% time remaining
- ⚪ **White** → Between 50% and 25% remaining
- 🟠 **Orange** → Less than 25% remaining
- 🔴 **Red** → Less than 10% remaining
- ⏳ **"Time's Up!"** → Displays in red, then disappears
## Installation
### **1️⃣ Install Dependencies**
GhostTimer requires `xosd-bin` for on-screen display:
```bash
sudo apt install xosd-bin
```
### **2️⃣ Clone & Build**
```bash
git clone https://github.com/yourusername/ghost-timer.git
cd ghost-timer
make
```
### **3️⃣ Run**
```bash
make run
```
## Usage
- Enter the **hours, minutes, and seconds** when prompted.
- The **timer floats on-screen** and updates in real-time.
- When time runs out, it displays **"Time's Up!"** in red, then disappears.
## Features
✔ **Written in C for performance**
✔ **[ALMOST] Non-blinking, real-time updates**
✔ **Floating on-screen timer (XOSD-based)**
✔ **Automatic color transitions (White → Orange → Red)**
✔ **Graceful exit with `Ctrl+C`**
✔ **Minimal CPU usage**
## Uninstall
```bash
sudo make uninstall
```
## Contributing
Contributions are welcome! Feel free to **fork, submit PRs, or suggest improvements**.
## License
This project is licensed under the **MIT License**.