From cd0e190a226af55187242101460c059b5a411c63 Mon Sep 17 00:00:00 2001 From: befeleme Date: Wed, 7 Aug 2019 14:08:17 +0200 Subject: [PATCH 1/5] Update readme - part about server client communication. --- README.md | 27 ++++++++++++++++++++++----- 1 file changed, 22 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5d65016..6a4985b 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ You can follow the progress on our [blog](https://roboprojekt.pyladies.cz/). ### Requirements -Python v.3.7 +Python v. 3.7 We recommend to use virtual environment. To succesfully run the project, run the script below. It will install all the requirements including [pyglet](https://bitbucket.org/pyglet/pyglet/wiki/Home) and [asyncio](https://docs.python.org/3/library/asyncio.html) libraries. @@ -28,11 +28,24 @@ python -m pip install pytest **How do you run the game?** -To run the game you need to open the `game.py` module in the command line: +The goal is to have a game that is playable through network. Therefore it is divided into server and client parts. In order to play the game you need to run the server first. ``` -python game.py +python server.py ``` +In order to see the game board with small player's avatars, use: +``` +python client_receiver.py +``` + +And if you want to play with your own robot, there is prepared interface. +``` +python client_interface.py +``` + +Note that currently it is not possible to actually run the game on your own unless you play for all the players. +In order to try the game, run as many interfaces as there are starting points on the map and at least one receiver. + **How do you win and how does the game round look like?** Each player has one robot which can be programmed by cards. The goal is to collect all flags on the board in the increasing order. The first robot who collects all flags wins. @@ -64,9 +77,13 @@ Current maps were created in [Tiled](https://www.mapeditor.org/) map editor, ver You can create your own map with the prepared tileset `development_tileset.json`. When creating multiple-layered tiles, keep the following order of layers: 1. earth -2. one of the following: hole, start, repair, belt, turn +2. one of the following: hole, start, repair, belt, gear 3. flag -4. laser, wall, pusher +4. laser (horizontal), wall (North) +5. laser (vertical), wall (West) +6. wall (South) +7. wall (East) +8. pusher Part of the test suite is a map validator which checks the order of tile layers. From 8c1adaa13e22b22af6ffdd00a23c7802dd18d128 Mon Sep 17 00:00:00 2001 From: Karolina <33810531+befeleme@users.noreply.github.com> Date: Wed, 7 Aug 2019 15:31:39 +0200 Subject: [PATCH 2/5] Update README.md Co-Authored-By: Anezka Muller --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6a4985b..41f40d5 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ The goal is to have a game that is playable through network. Therefore it is div python server.py ``` -In order to see the game board with small player's avatars, use: +In order to see the game board with small players' avatars, use: ``` python client_receiver.py ``` From 96ebcd61b2d3d33d88fec9ebe66f7764246d9d43 Mon Sep 17 00:00:00 2001 From: Karolina <33810531+befeleme@users.noreply.github.com> Date: Wed, 7 Aug 2019 15:31:47 +0200 Subject: [PATCH 3/5] Update README.md Co-Authored-By: Anezka Muller --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 41f40d5..ddf1212 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ In order to see the game board with small players' avatars, use: python client_receiver.py ``` -And if you want to play with your own robot, there is prepared interface. +And if you want to play with your own robot, there is a prepared interface. ``` python client_interface.py ``` From a4c9050e049c18ca85e41de497dd3bafd22f569b Mon Sep 17 00:00:00 2001 From: Karolina <33810531+befeleme@users.noreply.github.com> Date: Wed, 7 Aug 2019 15:32:02 +0200 Subject: [PATCH 4/5] Update README.md Co-Authored-By: Anezka Muller --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ddf1212..ce0c0d7 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ And if you want to play with your own robot, there is a prepared interface. python client_interface.py ``` -Note that currently it is not possible to actually run the game on your own unless you play for all the players. +Note that currently, it is not possible to actually run the game on your own unless you play for all the players. In order to try the game, run as many interfaces as there are starting points on the map and at least one receiver. **How do you win and how does the game round look like?** From b16592f3d544502c73604be83b98ff1bc953f5ef Mon Sep 17 00:00:00 2001 From: Karolina <33810531+befeleme@users.noreply.github.com> Date: Wed, 7 Aug 2019 15:32:15 +0200 Subject: [PATCH 5/5] Update README.md Co-Authored-By: Anezka Muller --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ce0c0d7..a05656b 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ python -m pip install pytest **How do you run the game?** -The goal is to have a game that is playable through network. Therefore it is divided into server and client parts. In order to play the game you need to run the server first. +The goal is to have a game that is playable through the network. Therefore it is divided into server and client parts. In order to play the game, you need to run the server first. ``` python server.py ```