Metadata-Version: 2.5
Name: tui-rhythm-game
Version: 0.1.0
Summary: A 4-lane rhythm game for your terminal
Project-URL: Homepage, https://github.com/purestellenium/tui-rhythm-game
Project-URL: Repository, https://github.com/purestellenium/tui-rhythm-game
Project-URL: Issues, https://github.com/purestellenium/tui-rhythm-game/issues
Author: purestellenium
License-Expression: MIT AND CC-BY-SA-3.0
License-File: CREDITS.md
License-File: LICENSE
Keywords: game,rhythm game,terminal,textual,tui
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Games/Entertainment
Requires-Python: >=3.10
Requires-Dist: just-playback>=1.0.0
Requires-Dist: pillow>=12.1.0
Requires-Dist: platformdirs>=4.0
Requires-Dist: pyfiglet>=1.0.4
Requires-Dist: rich-pixels>=3.0.1
Requires-Dist: textual<9,>=8.2.8
Description-Content-Type: text/markdown

# tui-rhythm-game

a 4-key rhythm game for your terminal, made with textual

## features

- support for custom songs & beatmaps
- themes based off of default textual themes
- configurable hotkeys
- simple scoring and grading system

## install

you'll need python 3.10+ and something to play audio through.

the easiest way is with [pipx](https://pipx.pypa.io/stable/installation/):

```sh
pipx install tui-rhythm-game
```

or pip:

```sh
pip install tui-rhythm-game
```

then run it with:

```sh
tui-rhythm-game
```

to update later, run `pipx upgrade tui-rhythm-game` (or `pip install -U tui-rhythm-game`).

## how to play

pretty self-explanatory! notes will fall in 4 different lanes, left to right, with each lane corresponding to one key. by default, the keybinds are DFJK (left to right). hit the notes when they're on the hit line (or a bit before) by pressing the key that corresponds to that lane.

your score increases by 100 for every note you hit, and there's also a combo that can increase the amount of score per note hit.

you also receive a grade, based off of your accuracy - not your score.

## custom songs

custom songs live in a `.json` file, and they reference assets which you need to add as well. beatmaps (the `.json` file) go in the `beatmaps` folder, and assets (like the music files + cover images) go into the `assets` folder.
the location of the game files is listed in settings, and can vary by OS.

## License

the code is MIT licensed.

okay thanks have fun bye
