diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 11 |
1 files changed, 8 insertions, 3 deletions
@@ -1,7 +1,7 @@ # k-heardle k-heardle is a Wordle-like game where you guess a song based on a given clip. -# Daily Mode +# Daily Mode (Heardle) - Available once a day and resets every day at midnight UTC time. - A random segment of audio from a song is generated @@ -9,7 +9,7 @@ The state of the daily game is kept locally and a signature is generated to prev > This is for fun and therfore inherently insecure, it is trivial to forge the signature and change the state of a running game -# Unlimited Mode +# Unlimited Mode (Heardle) - Unlimited play - Uses a minimized YouTube miniplayer for audio - A random segment of audio from YouTube video @@ -17,6 +17,11 @@ The state of the daily game is kept locally and a signature is generated to prev > Its recommended to play in fullscreen to prevent any media modules from leaking the solutions. Extra audio sometimes plays due to the nature of YouTube's IFrame API. +# Daily MV +- Guess the music video from 3 randomly selected frames +- Uses a seperate file specifically for tracking MVs (`mvs.ts`) +- Needs to be explictly enabled (set `ENABLE_DAILY_MUSIC_VIDEO` environment variable to `true`) + - This is relayed in the `/info` endpoint, daily generation script checks this to see if it should generate content for this game mode # Local Development ```bash @@ -46,7 +51,7 @@ uv run playlist_generator.py <INPUT_FILE> <OUTPUT_FILE> - OUTPUT_FILE the `songs.ts` file to output to, defaults to `../server/data/songs.ts` ## `generate_daily.py` -Generates a daily song snippet for daily game mode. Intended to be run once a day +Generates a daily song snippet, and MV frames for daily game mode. Intended to be run once a day > Requires a environment variables to be configured see `playlist_generator/.env.template` |