Skip to content

Commit cf0f699

Browse files
authored
Update README.md
1 parent 5db4d09 commit cf0f699

File tree

1 file changed

+42
-1
lines changed

1 file changed

+42
-1
lines changed

README.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,42 @@
1-
# 8ds
1+
# 8ds🎧
2+
3+
A simple and easy-to-use Windows GUI tool to control headset left/right balance and enjoy an “8D” auto-panning audio effect. Enjoy your favorite music sensationally with `8ds`!
4+
5+
![image](https://github.com/user-attachments/assets/846c84d0-cf16-405d-a1f7-003f795e3c00)
6+
7+
- **Manual Balance**: Two sliders to set left/right channel volume (0–100%).
8+
- **8D Auto-Panning**: A toggleable mode that sweeps audio balance in a smooth sine wave.
9+
- **8D Intensity Cap**: Slider to cap maximum 8D effect, preventing jarring 100% swings.
10+
- **Single-File Executable**: Packaged with PyInstaller into `8ds.exe`.
11+
12+
## Build
13+
14+
1. Clone the repo and enter directory:
15+
```powershell
16+
git clone https://github.com/KnightChaser/8ds.git
17+
cd 8ds
18+
```
19+
20+
2. Install dependencies (Suppose you create a Python virtual environment named `.venv`):
21+
```powershell
22+
.\.venv\Scripts\Activate.ps1
23+
pip install -r requirements.txt
24+
```
25+
3. Build the EXE:
26+
```powershell
27+
.\build.ps1
28+
```
29+
30+
4. Run:
31+
```powershell
32+
.\build\8ds.exe
33+
```
34+
(Or you can simply `python .\src\main_gui.py` for immediately execution without EXE packaging.)
35+
36+
## Usage
37+
38+
* `Interface` label shows your currently using audio endpoint.
39+
* `Left / Right` sliders adjust channel volumes when 8D is **`off`**.
40+
* `Enable 8D Audio` toggles auto-panning; sliders deactivate.
41+
* `8D Max (%)` slider sets the peak balance swing when 8D is **`on`**.
42+

0 commit comments

Comments
 (0)