From b05a139cbffb7b54ac871b99cab18c18b33e07a5 Mon Sep 17 00:00:00 2001 From: n3tael Date: Sat, 6 Apr 2024 22:38:12 +0300 Subject: [PATCH 1/2] docs(readme): Added info about loading levels and controls --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) 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 | From 13aefdde9a8722cedaaf458054455cff9e58018f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?b=CA=B0edoh=E2=82=82=20sw=C3=A9?= Date: Sun, 7 Apr 2024 16:04:13 +0500 Subject: [PATCH 2/2] Changes to README.md. --- README.md | 34 +++++++++++++++++++--------------- 1 file changed, 19 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 3dff038..7929252 100644 --- a/README.md +++ b/README.md @@ -2,25 +2,29 @@ My school project -## Load levels +## Loading games -You can load a level by pass the path to the level as an argument, see example: +You can load a game by passing the name of the game as an argument: ```sh -python3 main.py maps/triangle.json +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 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 | +| 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 |