Files
PyTaiko/README.md
2025-07-09 12:51:45 -04:00

70 lines
1.1 KiB
Markdown

# PyTaiko
This is a TJA player / Taiko simulator written in python and uses the [raylib](https://www.raylib.com/) library.
## Installation
Windows 10, Mac OS X 10.14 and Ubuntu 20.04 and higher are supported.
Any operating system below these requirements will not work.
Any Linux distro not listed is up to your own discretion
Download for OS of choice on releases page
How to run:
Windows:
```
Run PyTaiko.exe
```
MacOS/Linux:
```
Good luck, would suggest running with python directly
```
## Roadmap
https://linear.app/pytaiko
## Known Issues
- Everything
- See linear page.
## Run Locally
Clone the project
```bash
git clone https://github.com/Yonokid/PyTaiko
```
Go to the project directory
```bash
cd PyTaiko
````
Start the game
```bash
uv run PyTaiko.py
```
## FAQ
#### Keybinds?
Hit F1 in entry screen to access settings menu
Hit F1 in game to quick restart
#### Why does it look like Gen 3 instead of Nijiiro?
I like it
## Contributing
Contributions are now open. I don't have any particular contribution guidelines other than be mindful of what builtin functions already exist in this project (ie, for animations, videos, etc)