Skip to content

Commit cd1cf26

Browse files
authored
Update README.md
1 parent 80ed373 commit cd1cf26

1 file changed

Lines changed: 82 additions & 2 deletions

File tree

README.md

Lines changed: 82 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,82 @@
1-
# MiniMediaController-Windows
2-
A persistent, always-on-top media controller for Spotify, YouTube, and browser playback using Python and WinSDK.
1+
# 🎵 MiniMediaController
2+
3+
A lightweight, persistent, "Always-on-Top" media controller for Windows. This app allows you to monitor and control your music or videos through a tiny, customizable widget that stays above all other windows.
4+
5+
6+
7+
---
8+
9+
## ✨ Features
10+
11+
* **Always on Top:** Never lose your controls behind your browser or IDE.
12+
* **Universal Media Support:** Automatically hooks into any active Windows media session (Spotify, YouTube/Chrome, VLC, Apple Music, etc.).
13+
* **Vertical Compact UI:** A slim, stacked design that fits perfectly in the corner of your screen.
14+
* **Intelligent Truncation:** Long song titles or artist names are automatically shortened to keep the layout clean.
15+
* **Ghost Mode (Opacity):** Use the "O" slider to make the controller semi-transparent so it doesn't block your work.
16+
* **System Volume Control:** Integrated "V" slider to adjust your master Windows volume.
17+
* **Live Progress Bar:** High-visibility green bar to track your playback position.
18+
19+
---
20+
21+
## 🚀 How to Get the App
22+
23+
### Option 1: Download the EXE (Easiest)
24+
1. Navigate to the **[Releases](https://github.com/YOUR_USERNAME/YOUR_REPO/releases)** tab.
25+
2. Download the `MiniMediaController.exe` file.
26+
3. **Note:** Because this is an unsigned community tool, Windows Defender may show a "Windows protected your PC" popup. Click **More Info** -> **Run Anyway**.
27+
28+
### Option 2: Run from Source
29+
If you prefer to run the script directly, ensure you have **Python 3.10+** installed.
30+
31+
1. **Clone the repository:**
32+
```bash
33+
git clone [https://github.com/YOUR_USERNAME/YOUR_REPO.git](https://github.com/YOUR_USERNAME/YOUR_REPO.git)
34+
cd YOUR_REPO
35+
```
36+
2. **Install the required libraries:**
37+
```bash
38+
pip install winsdk pycaw comtypes
39+
```
40+
3. **Launch the app:**
41+
```bash
42+
python media_controller.py
43+
```
44+
45+
---
46+
47+
## 🛠️ Compiling it yourself
48+
49+
If you want to modify the code and package your own executable:
50+
51+
1. Install **PyInstaller**:
52+
```bash
53+
pip install pyinstaller
54+
```
55+
2. Run the build command:
56+
```bash
57+
pyinstaller --noconsole --onefile --name "MiniMediaController" media_controller.py
58+
```
59+
3. Your standalone app will be waiting in the `dist/` folder.
60+
61+
---
62+
63+
## 🖱️ How to Use
64+
65+
* **Move the Window:** Click and drag the **Song Title**, **Artist Name**, or any **Dark Background** area.
66+
* **Adjust Volume (V):** Slide to change your system's master volume.
67+
* **Adjust Opacity (O):** Slide to make the window "ghostly" (transparent).
68+
* **Close (✕):** Terminate the app and all background media-listening processes.
69+
70+
---
71+
72+
## ⚙️ Run on Startup
73+
74+
To have your MiniMediaController ready every time you boot your PC:
75+
1. Press `Win + R`, type `shell:startup`, and hit Enter.
76+
2. Right-click your `MiniMediaController.exe` and select **Create Shortcut**.
77+
3. Paste that shortcut into the Startup folder.
78+
79+
---
80+
81+
## 📝 License
82+
This project is open-source. Feel free to fork, modify, and use it however you like!

0 commit comments

Comments
 (0)