Docs: Rewrote README in English v1.1.0 features, quick start, admin guide, Partymode, Docker
This commit is contained in:
parent
124b7bf3e3
commit
47dc9c212f
1 changed files with 25 additions and 59 deletions
84
README.md
84
README.md
|
|
@ -1,93 +1,59 @@
|
||||||
# 🎵 Jukebox 420 - Discord Soundboard v1.0.0
|
# Jukebox 420 – Discord Soundboard (v1.1.0)
|
||||||
|
|
||||||
Ein modernes, feature-reiches Discord Soundboard mit Web-Frontend, Discord-Bot und Docker-Deployment. Perfekt für Gaming-Communities, Streamer und Discord-Server.
|
A modern, self‑hosted 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.
|
||||||
|
|
||||||

|

|
||||||

|

|
||||||

|

|
||||||
|
|
||||||
## ✨ Features
|
## ✨ Features
|
||||||
|
|
||||||
### 🎮 **Kern-Funktionen**
|
- Web UI (Vite + React + TypeScript), 3 themes (Dark, Rainbow, 420)
|
||||||
- **Web-Frontend** mit modernem UI und 3 Themes (Dark, Rainbow, 420)
|
- Discord bot (discord.js + @discordjs/voice)
|
||||||
- **Discord-Bot** für Voice-Channel Integration
|
- MP3 & WAV playback, ffmpeg normalization
|
||||||
- **Sound-Management** mit Ordner-Unterstützung
|
- Favorites, search, folders view (auto counters)
|
||||||
- **Live-Uhrzeit** (Berlin Timezone)
|
- Live counters and a clean header/footer
|
||||||
- **Volume Control** pro Server
|
- Admin area: bulk delete, inline rename, categories (CRUD) + bulk assign, remove custom badges
|
||||||
- **Favoriten-System** mit Cookie-Persistenz
|
- Partymode: server‑side random playback every 30–90 seconds, globally synced via SSE; Panic stops for everyone
|
||||||
|
- Persistent state: volumes, plays, totalPlays, categories, badges in `/data/sounds/state.json`
|
||||||
|
|
||||||
### 🎨 **UI/UX Features**
|
## 🚀 Quick start
|
||||||
- **3 Themes**: Dark, Rainbow, 420 (Cannabis/Trippy)
|
|
||||||
- **Responsive Design** für Desktop & Mobile
|
|
||||||
- **Glassmorphism-Effekte** mit Backdrop-Blur
|
|
||||||
- **Animierte Hintergründe** (Rainbow & 420 Theme)
|
|
||||||
- **Live-Zähler** für Sounds und Abspielungen
|
|
||||||
|
|
||||||
### 🔧 **Admin-Funktionen**
|
### 1. Requirements
|
||||||
- **Admin-Login** (Passwort-basiert)
|
- Docker & Docker Compose
|
||||||
- **Bulk-Delete** für mehrere Sounds
|
- Discord bot token with intents: `Guilds`, `GuildVoiceStates`, `DirectMessages`
|
||||||
- **Sound-Umbenennen** mit Inline-Editor
|
|
||||||
- **Checkbox-Auswahl** für Massenoperationen
|
|
||||||
|
|
||||||
### 🎵 **Audio-Features**
|
|
||||||
- **MP3 & WAV Support** für Uploads und Playback
|
|
||||||
- **Audio-Normalisierung** (Loudnorm)
|
|
||||||
- **URL-Download** für MP3/WAV Links
|
|
||||||
- **Random-Play** für zufällige Sounds
|
|
||||||
- **Panic-Button** zum sofortigen Stoppen
|
|
||||||
|
|
||||||
### 📁 **Organisation**
|
|
||||||
- **Ordner-Unterstützung** mit Tab-Navigation
|
|
||||||
- **Favoriten-Tab** für gespeicherte Sounds
|
|
||||||
- **Neu-Tab** für die letzten 10 Uploads
|
|
||||||
- **Most Played** für Top 3 Sounds
|
|
||||||
- **Suchfunktion** für alle Sounds
|
|
||||||
|
|
||||||
## 🚀 Quick Start
|
|
||||||
|
|
||||||
### 1. Voraussetzungen
|
|
||||||
- **Docker & Docker Compose**
|
|
||||||
- **Discord Bot Token** mit folgenden Intents:
|
|
||||||
- `Guilds`
|
|
||||||
- `GuildVoiceStates`
|
|
||||||
- `DirectMessages`
|
|
||||||
- `MessageContent`
|
|
||||||
|
|
||||||
### 2. Setup
|
### 2. Setup
|
||||||
```bash
|
```bash
|
||||||
# Repository klonen
|
# Clone repository
|
||||||
git clone https://github.com/flex420/jukebox-vibe.git
|
git clone https://github.com/flex420/jukebox-vibe.git
|
||||||
cd jukebox-vibe
|
cd jukebox-vibe
|
||||||
|
|
||||||
# .env Datei erstellen
|
# Create .env
|
||||||
cp .env.example .env
|
cp .env.example .env
|
||||||
```
|
```
|
||||||
|
|
||||||
### 3. Konfiguration
|
### 3. Configuration
|
||||||
```env
|
```env
|
||||||
# .env Datei bearbeiten
|
# Edit the .env file
|
||||||
DISCORD_TOKEN=dein_discord_bot_token_hier
|
DISCORD_TOKEN=your_discord_bot_token_here
|
||||||
|
ADMIN_PWD=choose-a-strong-password
|
||||||
PORT=8080
|
PORT=8080
|
||||||
SOUNDS_DIR=/data/sounds
|
SOUNDS_DIR=/data/sounds
|
||||||
|
|
||||||
# Optional: Bestimmte Server erlauben
|
# Optionally restrict allowed guilds
|
||||||
ALLOWED_GUILD_IDS=GUILD_ID_1,GUILD_ID_2
|
ALLOWED_GUILD_IDS=GUILD_ID_1,GUILD_ID_2
|
||||||
|
|
||||||
# Optional: Audio-Normalisierung
|
|
||||||
NORMALIZE_AUDIO=true
|
|
||||||
NORMALIZE_TARGET=-14
|
|
||||||
NORMALIZE_THRESHOLD=-70
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### 4. Deployment
|
### 4. Deployment
|
||||||
```bash
|
```bash
|
||||||
# Container starten
|
# Start container
|
||||||
docker compose up --build -d
|
docker compose up --build -d
|
||||||
|
|
||||||
# Logs anzeigen
|
# Logs
|
||||||
docker compose logs -f
|
docker compose logs -f
|
||||||
|
|
||||||
# Status prüfen
|
# Status
|
||||||
docker compose ps
|
docker compose ps
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue