Skip to content

Commit 57ded0c

Browse files
committed
chore: change name to muc
1 parent 4b60a88 commit 57ded0c

6 files changed

Lines changed: 51 additions & 54 deletions

File tree

.github/workflows/python-publish.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ jobs:
2424

2525
- uses: actions/setup-python@v5
2626
with:
27-
python-version: "3.x"
27+
python-version: "3.13"
2828

2929
- name: Build release distributions
3030
run: |

README.md

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# MU Soundboard 🎵🎮
1+
# MUC Soundboard 🎵🎮
22

33
Play audio files through your microphone in multiplayer games like CS, Battlefield, and COD using hotkeys. Built with Python and Rich for a beautiful CLI experience!
44

@@ -10,7 +10,7 @@ Play audio files through your microphone in multiplayer games like CS, Battlefie
1010
- 🎛️ **Multiple formats** - Supports WAV, MP3, OGG, FLAC, M4A
1111
- 🔊 **Auto-detection** - Finds VB-Cable and virtual audio devices automatically
1212
- 📁 **Organized library** - Subdirectory support for sound organization
13-
- ⚙️ **Persistent config** - Saves your settings to `~/.mu/config.json`
13+
- ⚙️ **Persistent config** - Saves your settings to `~/.muc/config.json`
1414
- 🎮 **Gaming ready** - Perfect for CS, Battlefield, COD, and more!
1515

1616
## 📋 Prerequisites
@@ -36,9 +36,9 @@ Play audio files through your microphone in multiplayer games like CS, Battlefie
3636

3737
1. **Install via uv or pip:**
3838
```bash
39-
uv add mu
39+
uv add muc
4040
# optional: with yt-dlp for downloading audio
41-
uv add mu[yt-dlp]
41+
uv add muc[yt-dlp]
4242
```
4343

4444
2. **Add your audio files:**
@@ -63,14 +63,14 @@ Play audio files through your microphone in multiplayer games like CS, Battlefie
6363
### Step 2: Run Setup Wizard
6464

6565
```bash
66-
mu setup
66+
muc setup
6767
```
6868

6969
The setup wizard will:
7070
1. 📋 List all available audio devices in a beautiful table
7171
2. 🔍 Auto-detect VB-Cable or similar virtual devices
7272
3. ✓ Let you confirm or manually select the output device
73-
4. 💾 Save your configuration to `~/.mu/config.json`
73+
4. 💾 Save your configuration to `~/.muc/config.json`
7474

7575
**IMPORTANT**: Select `CABLE Input` as the output device, not `CABLE Output`.
7676

@@ -84,49 +84,49 @@ CABLE Output ← Game reads FROM here
8484

8585
### CLI Commands
8686

87-
MU provides a modern CLI with multiple commands:
87+
MUC provides a modern CLI with multiple commands:
8888

8989
```bash
9090
# Setup and configuration
91-
mu setup # Run setup wizard
92-
mu devices # List all audio devices
91+
muc setup # Run setup wizard
92+
muc devices # List all audio devices
9393

9494
# Sound management
95-
mu sounds # List available sounds in your library
96-
mu play [name] # Play a specific sound (prompts if no name)
97-
mu stop # Stop currently playing sound
95+
muc sounds # List available sounds in your library
96+
muc play [name] # Play a specific sound (prompts if no name)
97+
muc stop # Stop currently playing sound
9898

9999
# Hotkey control
100-
mu hotkeys # Show hotkey bindings (F1-F10)
101-
mu listen # Start hotkey listener (press ESC to stop)
100+
muc hotkeys # Show hotkey bindings (F1-F10)
101+
muc listen # Start hotkey listener (press ESC to stop)
102102

103103
# Interactive mode
104-
mu interactive # Launch full interactive menu
104+
muc interactive # Launch full interactive menu
105105

106106
# Help
107-
mu --help # Show all commands
107+
muc --help # Show all commands
108108
```
109109

110110
### Quick Workflow
111111

112112
1. **First time setup:**
113113
```bash
114-
mu setup
114+
muc setup
115115
```
116116

117117
2. **Check your sounds:**
118118
```bash
119-
mu sounds
119+
muc sounds
120120
```
121121

122122
3. **Test a sound:**
123123
```bash
124-
mu play rickroll
124+
muc play rickroll
125125
```
126126

127127
4. **Start gaming with hotkeys:**
128128
```bash
129-
mu listen
129+
muc listen
130130
```
131131
- Press F1-F10 to play sounds
132132
- Press ESC to stop
@@ -141,14 +141,14 @@ The first 10 sounds (alphabetically) are automatically mapped to:
141141

142142
View bindings:
143143
```bash
144-
mu hotkeys
144+
muc hotkeys
145145
```
146146

147147
### Interactive Menu Mode
148148

149149
For a full-featured text menu:
150150
```bash
151-
mu interactive
151+
muc interactive
152152
```
153153

154154
Menu options:
@@ -208,25 +208,25 @@ yt-dlp -x --audio-format wav "https://youtube.com/watch?v=..."
208208

209209
## 🔧 Configuration
210210

211-
Configuration is automatically saved to `~/.mu/config.json`:
211+
Configuration is automatically saved to `~/.muc/config.json`:
212212

213213
```json
214214
{
215215
"output_device_id": 6,
216-
"sounds_dir": "C:/path/to/mu/sounds"
216+
"sounds_dir": "C:/path/to/muc/sounds"
217217
}
218218
```
219219

220220
You can manually edit this file or reconfigure using:
221221
```bash
222-
mu setup
222+
muc setup
223223
```
224224

225225
## 🎯 Gaming Tips
226226

227227
1. **Test First**: Always test sounds before joining a match
228228
```bash
229-
mu play test-sound
229+
muc play test-sound
230230
```
231231

232232
2. **Volume Control**:
@@ -235,7 +235,7 @@ mu setup
235235
- Set in-game voice volume appropriately
236236

237237
3. **Quick Access**:
238-
- Keep a terminal with `mu listen` running
238+
- Keep a terminal with `muc listen` running
239239
- Alt-tab is instant with hotkeys
240240
- Or use a second monitor
241241

@@ -253,28 +253,28 @@ mu setup
253253
### "No virtual audio cable detected"
254254
**Solution**: Install VB-Cable and **restart your computer**
255255
```bash
256-
mu setup # Run again after restart
256+
muc setup # Run again after restart
257257
```
258258

259259
### "Teammates can't hear the audio"
260260
**Check**:
261261
1. Game microphone set to `CABLE Output`
262262
2. Soundboard output set to `CABLE Input`
263-
3. Test with: `mu play test-sound`
263+
3. Test with: `muc play test-sound`
264264

265265
**Fix**:
266266
```bash
267-
mu devices # Verify device IDs
268-
mu setup # Reconfigure if needed
267+
muc devices # Verify device IDs
268+
muc setup # Reconfigure if needed
269269
```
270270

271271
### "Audio plays on my speakers, not through mic"
272272
**Problem**: Wrong output device selected
273273

274274
**Solution**:
275275
```bash
276-
mu devices # Find CABLE Input ID
277-
mu setup # Select correct device
276+
muc devices # Find CABLE Input ID
277+
muc setup # Select correct device
278278
```
279279

280280
Remember: **CABLE Input** (not Output) for soundboard output!
@@ -289,7 +289,7 @@ Remember: **CABLE Input** (not Output) for soundboard output!
289289
```bash
290290
# Run as administrator (Windows)
291291
# Or try interactive mode
292-
mu interactive # Then select option 4
292+
muc interactive # Then select option 4
293293
```
294294

295295
### "Audio quality is poor"
@@ -300,14 +300,14 @@ mu interactive # Then select option 4
300300
4. Check VB-Cable settings in Windows Sound Control Panel
301301

302302
### "Configuration not saving"
303-
**Check**: Permissions for `~/.mu/` directory
303+
**Check**: Permissions for `~/.muc/` directory
304304

305305
```powershell
306306
# Windows - check directory
307-
ls ~\.mu
307+
ls ~\.muc
308308
309309
# If missing, create manually
310-
mkdir ~\.mu
310+
mkdir ~\.muc
311311
```
312312

313313
## 🏗️ Architecture
@@ -349,7 +349,7 @@ This project implements a clean software architecture:
349349
## 📁 Project Structure
350350

351351
```
352-
mu/
352+
muc/
353353
├── src/
354354
│ ├── __init__.py # Package initialization
355355
│ ├── cli.py # Rich-click CLI commands
@@ -396,4 +396,4 @@ This is a personal project, but contributions are welcome!
396396

397397
## 📄 License
398398

399-
This project is provided as-is for personal and educational use only. See [LICENSE](https://github.com/Harshal6927/mu?tab=Apache-2.0-1-ov-file) for details.
399+
This project is provided as-is for personal and educational use only. See [LICENSE](https://github.com/Harshal6927/muc?tab=Apache-2.0-1-ov-file) for details.

pyproject.toml

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[project]
2-
name = "mu"
2+
name = "muc"
33
authors = [{ name = "Harshal Laheri", email = "harshal@harshallaheri.me" }]
44
version = "0.1.0"
55
description = "Play audio through your microphone in games using hotkeys"
@@ -17,10 +17,7 @@ dependencies = [
1717
yt-dlp = ["yt-dlp>=2025.11.12"]
1818

1919
[dependency-groups]
20-
dev = [
21-
"pre-commit>=4.4.0",
22-
"yt-dlp>=2025.11.12",
23-
]
20+
dev = ["pre-commit>=4.4.0", "yt-dlp>=2025.11.12"]
2421

2522
[tool.hatch.build.targets.wheel]
2623
packages = ["src"]
@@ -30,11 +27,11 @@ build-backend = "hatchling.build"
3027
requires = ["hatchling"]
3128

3229
[project.scripts]
33-
mu = "src.cli:main"
30+
muc = "src.cli:main"
3431

3532
[tool.ruff]
3633
line-length = 120
3734

3835
[project.urls]
39-
Homepage = "https://github.com/harshal6927/mu"
36+
Homepage = "https://github.com/harshal6927/muc"
4037
Website = "https://harshallaheri.me/"

src/cli.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,19 +42,19 @@ def get_soundboard() -> tuple[Soundboard, AudioManager]:
4242

4343
@click.group(invoke_without_command=True)
4444
@click.pass_context
45-
@click.version_option(version="0.1.0", prog_name="mu")
45+
@click.version_option(version="0.1.0", prog_name="muc")
4646
def cli(ctx: click.Context) -> None:
47-
"""[bold cyan]MU Soundboard[/bold cyan].
47+
"""[bold cyan]MUC Soundboard[/bold cyan].
4848
4949
Play audio files through your microphone in games using hotkeys.
5050
Perfect for CS, Battlefield, COD, and more! 🎮🎵
5151
"""
5252
if ctx.invoked_subcommand is None:
5353
console.print(
5454
Panel.fit(
55-
"[bold cyan]MU Soundboard[/bold cyan]\n"
55+
"[bold cyan]MUC Soundboard[/bold cyan]\n"
5656
"Play audio through your microphone in games!\n\n"
57-
"Run [bold]mu --help[/bold] to see all commands.",
57+
"Run [bold]muc --help[/bold] to see all commands.",
5858
border_style="cyan",
5959
),
6060
)

src/config.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Copyright (c) 2025. All rights reserved.
2-
"""Configuration management for mu soundboard."""
2+
"""Configuration management for muc soundboard."""
33

44
import json
55
from pathlib import Path
@@ -10,7 +10,7 @@ class Config:
1010

1111
def __init__(self) -> None:
1212
"""Initialize the Config with default values and load existing config."""
13-
self.config_file = Path.home() / ".mu" / "config.json"
13+
self.config_file = Path.home() / ".muc" / "config.json"
1414
self.sounds_dir = Path.cwd() / "sounds"
1515
self.output_device_id: int | None = None
1616

uv.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)