Skip to content

Commit e9b6d7d

Browse files
Add README.md
1 parent 288f5e5 commit e9b6d7d

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# 🎮 Github Game Status
2+
3+
**GitHub Game Status** is a simple desktop app built with Rust + Slint that automatically updates your GitHub status based on running games or processes.
4+
5+
## ✅ Features
6+
7+
- Save your GitHub CLI (gh) path and default status text + emoji.
8+
- Add multiple games/processes with custom status and emoji.
9+
- Live monitoring of running processes — updates GitHub status in real time.
10+
- Supports clearing all saved data in one click.
11+
- Lightweight, fully local — no internet services except GitHub CLI.
12+
13+
## 📁 Data Files
14+
- setupdata.json — stores GitHub CLI path and default status.
15+
- processesdata.json — stores list of games and their statuses.
16+
17+
Everything is saved locally in human-readable JSON files.
18+
19+
## ⚙️ How It Works
20+
21+
- You set up your GitHub CLI path and default status (text + emoji).
22+
- You add game executables file names and status data for them(e.g., RDR2.exe → "Playing in the Red Dead Redemption 2 🤠").
23+
- Start monitoring from the UI.
24+
- When a listed process runs, the app updates your GitHub status automatically via gh status.
25+
- Once closed, monitoring stops immediately.
26+
27+
28+
## ❗ Dependencies
29+
30+
- `gh ext install vilmibm/gh-user-status`
31+
32+
---
33+
34+
## 📄 License
35+
36+
This project is licensed under the **MIT License**.
37+
See [LICENSE](LICENSE) for full terms.

0 commit comments

Comments
 (0)