diff --git a/README.md b/README.md index a2d48b9..7929252 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,30 @@ - # Pseudo-3D hyperbolic engine + My school project + +## Loading games + +You can load a game by passing the name of the game as an argument: + +```sh +python3 main.py triangle +``` + +Game can be loaded only if it is located in the games/ directory. +If no game is specified then "squareroom" will be loaded. + + +## Controls + +| Descripton | Key | +|----------------------------------------|:---:| +| Move forward | W | +| Move backwards | D | +| Strafe left | Q | +| Strafe right | E | +| Turn 180 degrees | R | +| Toggle FPS cap | F1 | +| Create a wall | F2 | +| Toggle debug info | F3 | +| Print current position to the terminal | F4 | +| Save level to `./levels` folder | F5 |