Update README.md

This commit is contained in:
Yonokid
2024-08-20 03:40:26 -04:00
parent 6ef833e0fe
commit 306f051ddc

View File

@@ -1,2 +1,75 @@
# PyTaiko # PyTaiko
plz don't sue
This is a TJA player / Taiko simulator written in python and uses the [raylib](https://www.raylib.com/) library.
## Installation
Idk. We'll see what happens when I get there
```bash
This is where the build will be
```
## Roadmap
- Add Kusudama notes
- Draw drumrolls to the correct size
- Add gogotime effect
- Add gauge
- Add background
## Known Issues
- Songs with Kusudama notes will not work as it has not been implemented
- Songs with very short drumrolls will not appear properly
- Don-chan will be missing until someone else figures that out
## Run Locally
Clone the project
```bash
git clone https://github.com/Yonokid/PyTaiko
```
Go to the project directory
```bash
cd PyTaiko
```
Install dependencies
```bash
pip install -r requirements.txt
```
Start the game
```bash
python main.py
```
## FAQ
#### Keybinds?
EFJI
#### Why does it look like Gen 3?
I like it
## Contributing
I would highly suggest not contributing to this until sizeable progress has been made. The fabric of this code is ever changing and anything you write could disappear at any time