modified: README.md

This commit is contained in:
SimolZimol
2025-05-19 20:05:31 +02:00
parent f347515081
commit a8ceb02d9a

View File

@@ -1,40 +1,41 @@
# Quizify Musik Quiz mit Spotify
# Quizify Music Quiz with Spotify
Quizify ist ein Musik-Quiz, das deine Spotify-Playlists nutzt. Errate Künstler, Titel oder Erscheinungsjahr von Songs aus deinen eigenen Playlists direkt im Browser!
Quizify is a music quiz that uses your Spotify playlists. Guess the artist, title, or release year of songs from your own playlists directly in your browser!
## Features
- Login mit Spotify
- Auswahl deiner eigenen Playlists
- Verschiedene Spielmodi: Künstler, Titel oder Jahr erraten
- Spotify Web Playback (direktes Abspielen im Browser)
- Keine Songwiederholungen bis alle gespielt wurden
- Intelligente Suche und Antwortauswertung (ignoriert Klammerzusätze etc.)
- Login with Spotify
- Select your own playlists
- Multiple game modes: Guess artist, title, or year
- Spotify Web Playback (play songs directly in the browser)
- No song repeats until all have been played
- Smart search and answer evaluation (ignores bracket additions, apostrophes, etc.)
- Multilingual: All texts are loaded from language files, language is set via `.env`
## Voraussetzungen
## Requirements
- Python 3.10 oder neuer
- Python 3.10 or newer
- Spotify Developer Account ([developer.spotify.com](https://developer.spotify.com/))
- Spotify Premium Account (für Web Playback)
- Die Umgebungsvariablen müssen gesetzt sein (siehe `.env.example`)
- Spotify Premium Account (for Web Playback)
- Environment variables must be set (see `.env.example`)
## Installation
1. **Repository klonen**
1. **Clone the repository**
```sh
git clone https://github.com/dein-benutzername/quizify.git
git clone https://github.com/your-username/quizify.git
cd quizify
```
2. **.env Datei anlegen**
Kopiere `.env.example` zu `.env` und trage deine Spotify-API-Daten ein.
2. **Create the .env file**
Copy `.env.example` to `.env` and enter your Spotify API credentials.
3. **Starten unter Windows**
3. **Start on Windows**
```sh
start.bat
```
Alternativ manuell:
Or manually:
```sh
python -m venv ven
ven\Scripts\activate
@@ -42,18 +43,19 @@ Quizify ist ein Musik-Quiz, das deine Spotify-Playlists nutzt. Errate Künstler,
python app.py
```
4. **Im Browser öffnen**
4. **Open in your browser**
- [http://localhost:5000](http://localhost:5000)
## .env Beispiel
## .env Example
Siehe `.env.example` für die nötigen Variablen.
See `.env.example` for the required variables.
## Hinweise
## Notes
- Die App benötigt einen Spotify Premium Account für die Web Playback-Funktion.
- Die Spotify Redirect URI muss in der Spotify Developer Console exakt mit `SPOTIPY_REDIRECT_URI` übereinstimmen.
- The app requires a Spotify Premium account for the Web Playback feature.
- The Spotify Redirect URI must exactly match `SPOTIPY_REDIRECT_URI` in the Spotify Developer Console.
- All texts are loaded from language files in the `locales` folder. Set the language via the `LANG` variable in your `.env` (e.g., `LANG=en-EN` or `LANG=de-DE`).
## Lizenz
## License
MIT License