diff --git a/README.md b/README.md index a2d48b9..3dff038 100644 --- a/README.md +++ b/README.md @@ -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 |