aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 61b3c6c6a54ed8bef0a6b98c083e96cf6f09ff61 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
# k-heardle
k-heardle is a Wordle-like game where you guess a song based on a given clip.

# Daily Mode
- Available once a day and resets every day at midnight UTC time. 
- A random segment of audio from a song is generated

The state of the daily game is kept locally and a signature is generated to prevent this from being blatantly modified. All guesses are verified server-side

> 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 play
- Uses a minimized YouTube miniplayer for audio
- Song segments always start at the beginning of the video
- Guesses are verified locally

> Its recommended to play in fullscrene to prevent any media modules from leaking the solutions


# Local Development
```bash
pnpm i
pnpm dev
```

This repo is a fork of [EpicWolverine/PersonalHeardle](https://github.com/EpicWolverine/PersonalHeardle), however much of the code has been modified to a client-server relationship and the CRA has been deprecated in favor of Vite.
send patches to the email below
yukais@pinapelz.com
include the subject [PATCH repo_name]
pinapelz.com
homepage