docs(readme): Added info about loading levels and controls

This commit is contained in:
n3tael 2024-04-06 22:38:12 +03:00
parent 9e90b02f79
commit b05a139cbf
Signed by: n3tael
GPG Key ID: F305925762F035A8

View File

@ -1,3 +1,26 @@
# Pseudo-3D hyperbolic engine
My school project
## Load levels
You can load a level by pass the path to the level as an argument, see example:
```sh
python3 main.py maps/triangle.json
```
## Controls
| Descripton | Key |
|------------------------------------|:---:|
| Move forwards | W |
| Move backwards | D |
| Strafe left | Q |
| Strafe right | E |
| Turn exactly 180 degrees | R |
| Toggle FPS cap | F1 |
| Create a wall | F2 |
| Toggle debug info | F3 |
| Print to terminal current position | F4 |
| Save level to `./levels` folder | F5 |