docs(readme): bump to v1.1.2; unify English; add Entrance/Exit sounds and updated DM commands

This commit is contained in:
vibe-bot 2025-08-11 00:34:15 +02:00
parent efda74fb60
commit 584bb5ca4f

106
README.md
View file

@ -1,8 +1,8 @@
# Jukebox 420 Discord Soundboard (v1.1.1) # Jukebox 420 Discord Soundboard (v1.1.2)
A modern, selfhosted Discord soundboard with a slick web UI and a Discord bot that plays sounds into your voice channels. Easy to run via Docker, fun to use with friends. A modern, selfhosted Discord soundboard with a slick web UI and a Discord bot that plays sounds into your voice channels. Easy to run via Docker, fun to use with friends.
![Version](https://img.shields.io/badge/version-1.1.1-blue) ![Version](https://img.shields.io/badge/version-1.1.2-blue)
![Docker](https://img.shields.io/badge/docker-ready-green) ![Docker](https://img.shields.io/badge/docker-ready-green)
![Discord](https://img.shields.io/badge/discord-bot-purple) ![Discord](https://img.shields.io/badge/discord-bot-purple)
@ -16,6 +16,7 @@ A modern, selfhosted Discord soundboard with a slick web UI and a Discord bot
- Admin area: bulk delete, inline rename, categories (CRUD) + bulk assign, remove custom badges - Admin area: bulk delete, inline rename, categories (CRUD) + bulk assign, remove custom badges
- Partymode: serverside random playback every 3090 seconds, globally synced via SSE; Panic stops for everyone - Partymode: serverside random playback every 3090 seconds, globally synced via SSE; Panic stops for everyone
- Persistent state: volumes, plays, totalPlays, categories, badges in `/data/sounds/state.json` - Persistent state: volumes, plays, totalPlays, categories, badges in `/data/sounds/state.json`
- Entrance/Exit sounds: peruser sounds played when joining/leaving voice; users set them via DM (`?entrance`, `?exit`); Exit plays only on disconnect (not on channel switch)
## 🚀 Quick start ## 🚀 Quick start
@ -57,28 +58,28 @@ docker compose logs -f
docker compose ps docker compose ps
``` ```
### 5. Zugriff ### 5. Access
- **Web-Interface**: `http://localhost:8199` - **Web-Interface**: `http://localhost:8199`
- **Health Check**: `http://localhost:8199/api/health` - **Health Check**: `http://localhost:8199/api/health`
## 🎯 Verwendung ## 🎯 Usage
### **Erste Schritte** ### **Getting started**
1. **Discord Bot einladen** mit Voice-Permissions 1. Invite the Discord bot with voice permissions
2. **Sounds hochladen** via DM an den Bot (MP3/WAV) 2. Upload sounds via DM to the bot (MP3/WAV)
3. **Web-Interface öffnen** und Theme wählen 3. Open the web UI and choose a theme
4. **Voice-Channel auswählen** und Sounds abspielen 4. Select a voice channel and play sounds
### **Admin-Panel** ### **Admin panel**
1. **Admin-Login** mit Passwort 1. Log in with the admin password
2. **Sounds auswählen** via Checkboxen 2. Select sounds via checkboxes
3. **Bulk-Delete** oder **Umbenennen** durchführen 3. Perform bulk delete or rename
4. **Logout** zum Beenden 4. Logout to finish
### **URL-Downloads** ### **URL downloads**
- **MP3/WAV Links** in das URL-Feld eingeben - Enter MP3/WAV links into the URL field
- **Download-Button** klicken - Click Download
- **Automatische Integration** in Soundboard - The file will be added automatically to the soundboard
## 🎨 Themes ## 🎨 Themes
@ -98,7 +99,7 @@ docker compose ps
- 20s Animation-Loop - 20s Animation-Loop
- Grüne Glow-Effekte - Grüne Glow-Effekte
## 📊 API Endpunkte ## 📊 API endpoints
### **Public Endpoints** ### **Public Endpoints**
```http ```http
@ -112,7 +113,7 @@ GET /api/volume # Volume abrufen
POST /api/volume # Volume setzen POST /api/volume # Volume setzen
``` ```
### **Admin Endpoints** ### **Admin endpoints**
```http ```http
POST /api/admin/login # Admin-Login POST /api/admin/login # Admin-Login
POST /api/admin/logout # Admin-Logout POST /api/admin/logout # Admin-Logout
@ -121,19 +122,20 @@ POST /api/admin/sounds/delete # Sounds löschen
POST /api/admin/sounds/rename # Sound umbenennen POST /api/admin/sounds/rename # Sound umbenennen
``` ```
## 🔧 Discord Bot Commands ## 🔧 Discord bot commands
### **DM Commands** ### **DM commands**
- `?help` - Hilfe anzeigen - `?help` show help
- `?list` - Alle Sounds auflisten - `?list` list all sounds
- `?restart` - Bot neu starten (mit Bestätigung) - `?entrance <file.mp3|file.wav> | remove` set or remove your entrance sound
- `?exit <file.mp3|file.wav> | remove` set or remove your exit sound
### **Upload via DM** ### **Upload via DM**
- **MP3/WAV Dateien** direkt an Bot senden - Send MP3/WAV files directly to the bot
- **Automatische Speicherung** in `/data/sounds` - Files are stored under `/data/sounds`
- **Sofortige Verfügbarkeit** im Frontend - Immediately available in the frontend
## 🐳 Docker Deployment ## 🐳 Docker deployment
### **Docker Compose (Empfohlen)** ### **Docker Compose (Empfohlen)**
```yaml ```yaml
@ -176,7 +178,7 @@ docker run -d --name jukebox-420 -p 8199:8080 --env-file .env -v $(pwd)/data/sou
- Hintergrund: Ohne TLS kann es zu Verschlüsselungs-/EncryptFehlern kommen, und Audio wird in Discord nicht korrekt wiedergegeben. - Hintergrund: Ohne TLS kann es zu Verschlüsselungs-/EncryptFehlern kommen, und Audio wird in Discord nicht korrekt wiedergegeben.
- Praxis: Richte eine Domain wie `https://soundboard.deinedomain.tld` auf das Frontend ein und aktiviere SSL (Lets Encrypt). Danach sollten Uploads/Playback stabil funktionieren. - Praxis: Richte eine Domain wie `https://soundboard.deinedomain.tld` auf das Frontend ein und aktiviere SSL (Lets Encrypt). Danach sollten Uploads/Playback stabil funktionieren.
## 📁 Projekt-Struktur ## 📁 Project structure
``` ```
jukebox-vibe/ jukebox-vibe/
@ -200,7 +202,7 @@ jukebox-vibe/
└── README.md # Diese Datei └── README.md # Diese Datei
``` ```
## 🔧 Entwicklung ## 🔧 Development
### **Lokale Entwicklung** ### **Lokale Entwicklung**
```bash ```bash
@ -224,37 +226,37 @@ docker build -t jukebox-vibe .
docker build --target development -t jukebox-vibe:dev . docker build --target development -t jukebox-vibe:dev .
``` ```
## 📈 Statistiken ## 📈 Stats
### **Persistente Daten** ### **Persistent data**
- **Sounds**: `/data/sounds/` (Volume Mount) - Sounds: `/data/sounds/` (volume mount)
- **State**: `/data/sounds/state.json` (Volume, Channel, Plays) - State: `/data/sounds/state.json` (volume, channel, plays)
- **Favoriten**: Browser Cookies - Favorites: browser cookies
- **Theme**: Browser LocalStorage - Theme: browser localStorage
### **Monitoring** ### **Monitoring**
- **Health Check**: `/api/health` - Health check: `/api/health`
- **Docker Logs**: `docker compose logs -f` - Docker logs: `docker compose logs -f`
- **Container Status**: `docker compose ps` - Container status: `docker compose ps`
## 🛠️ Troubleshooting ## 🛠️ Troubleshooting
### **Häufige Probleme** ### **Häufige Probleme**
**Bot joint nicht Voice-Channel:** **Bot does not join the voice channel:**
- Prüfe Bot-Permissions (Voice) - Check bot permissions (Connect, Speak, Request to Speak for Stage)
- Prüfe Intents in Discord Developer Portal - Verify gateway intents in the Discord Developer Portal (GuildVoiceStates, DirectMessages, MessageContent)
- Prüfe Network/Firewall - Check network/firewall
**Sounds werden nicht angezeigt:** **Sounds do not show up:**
- Prüfe Volume Mount `/data/sounds` - Verify volume mount `/data/sounds`
- Prüfe Datei-Permissions - Check file permissions
- Prüfe Bot-Uploads via DM - Confirm uploads via DM
**Admin-Login funktioniert nicht:** **Admin login fails:**
- Prüfe Browser-Cookies - Check browser cookies
- Prüfe Admin-Passwort - Confirm admin password
- Prüfe Server-Logs - Inspect server logs
### **Logs anzeigen** ### **Logs anzeigen**
```bash ```bash