[python-project] Aris Goulas

README.md

@@ -1,135 +1,54 @@
 <img src="https://bit.ly/2VnXWr2" alt="Ironhack Logo" width="100"/>
 
-# Project: Escape Room Python Game
+# Project: Surreal EscaPY
 
 ## Overview
 
-The goal of this project is for you to apply the Python programming skills you have learned this week in solving a real problem. We present you the design of a classic game that can be played via text - Escape Room. Your goal is to develop the game using Python based on the game design.
+If you happen to know [Zork I: The Great Underground Empire](https://en.wikipedia.org/wiki/Zork) ...congrats! (wow, you must be older than time :wink:). 
 
-Read the game narratives and technical requirements carefully. Plan how you will achieve your goal with pseudo codes and/or flowchart. Review the logic and process in order to avoid potential errors. Then implement with Python code. After that, test your code several times with different inputs and make sure it's rock solid. The instructional team is standing by to help you in case you run into any problems.
+Text-based adventure games have inspired gaming development since 1977. Our goal for the first team project ([Aris Goulas](https://github.com/ArisGoulas), [Letícia De Marchi](https://github.com/leticiademarchiferreira), [Matheus Freire](https://github.com/MatheusFreir)) was to use our newly-acquired Python programming skills, in order to develop further the design of a classic game - _Escape Room_ that was provided to us. We therefore present you the **Surreal EscaPY**!
 
 ---
 
 ## Game Design
 
-### Game Map
-
-![Game Map](escape-room-plan.jpg)
-
-### Game Narratives
-
-#### Game Room
-
-You wake up on a couch and find yourself in a strange house with no windows which you have never been to before. You don't remember why you are here and what had happened before. You feel some unknown danger is approaching and you must get out of the house, NOW!
-
-You are now in game room.
-
-What would you like to do?
-
-You explore the room. This is Game Room. You find couch, piano, and Door A.
-
-You examine couch. There isn't anything interesting about it.
-
-You examine Door A. It is locked but you don't have the key.
-
-You examine piano. You find key for Door A.
-
-You examine Door A. Your unlock it with a key you have.
-
-Do you want to go to the next room?
-
-#### Bedroom 1
-
-You are now in Bedroom 1.
-
-What would you like to do?
-
-You explore the room. This is Bedroom 1. You find queen bed, Door A, Door B, and Door C.
-
-You examine queen bed. You find key for Door B.
-
-You examine Door C. It is locked but you don't have the key.
-
-You examine Door B. Your unlock it with a key you have.
-
-Do you want to go to the next room?
-
-#### Bedroom 2
-
-You are now in Bedroom 2.
-
-What would you like to do?
-
-You explore the room. This is Bedroom 2. You find double bed, dresser, and Door B.
+Our development consists of 3 (and a half) features:
+- :fearful: Environment thematic customization: _surreal nightmare_ - personalization of the experience (MVP)
+- :mag: _"check"_ action addition - gameplay (towards a future "inventory" feature)
+- :repeat: Map layout _differentiation_ - replayability (towards a future map layout "randomization" feature and a "random spawn location" feature)
+- :hourglass: Player name & _Timer_ introduction - gameplay (towards a future "scoreboard" feature and a "lose condition" feature)
 
-You examine double bed. You find key for Door C.
+The Python modules `time` and `random` were used, together with an implementation of an additional function (explore_self).
 
-You examine dresser. You find key for Door D.
-
-You examine Door B. Your unlock it with a key you have.
-
-Do you want to go to the next room?
-
-#### Bedroom 1
-
-You are now in Bedroom 1.
-
-What would you like to do?
-
-You examine Door C. Your unlock it with a key you have.
-
-Do you want to go to the next room?
-
-#### Living Room
-
-You are now in Living Room.
-
-What would you like to do?
-
-You explore the room. This is Living Room. You find dining table, Door C, and Door D.
+### Game Map
 
-You examine Door D. Your unlock it with a key you have.
+![Game Map adapted](surreal-escapy-plan.jpg)
 
-Do you want to go to the next room?
+### Game Narratives
 
-#### Outside
+The player is asked to provide a name, and then the game starts in a specific room. They can utilize a menu of three **actions** ("explore", "check", or "examine") in order to advancer in the game:
+- Explore: indicates the room they currently are, the furniture and the doors present
+- Check: lists the keys that they have collected
+- Examine: allows them to inspect furniture in order to find keys, and, if applied to doors while in presence of the respective key, grants access through the door (yes/no option)
 
-Congrats! You escaped the room!
+The customized rooms, furnitures, doors and keys that the player can encounter in the game are:
+- 4+1 rooms: the room of insomnia, diamond room, the room of Alice, the room of reasoning, outside **(victory condition)**
+- 6 furnitures: bed of nails, escritoire desk, steel chest, Red Queen bed, White Knight dresser, bag of problems
+- 4 doors: veil of darkness, black hole, open mouth, arch of life
+- 4 keys: candle-light, diamond, small pill , large pill **(random assignment)**
 
 ---
 
-## Getting Started
-
-Overwhelmed and don't know where to start? This is a tough challenge we know. But don't worry. We have included a working example for you to reference in which only 1 room (game room) is included. Read the example and make sure you understand it. Then you can expand on top of the example to code the rest of the rooms.
-
-The provided example is just a Minimal Viable Product (MVP). It is fully functional but not bullet proof. You should be aware of its limitations while you are working and try to make your final product as robust as possible.
-
-## Technical Requirements
-
-* Use Python lists and dictionaries to define the rooms, items, and relations of them.
-
-* Use a Python dictionary to store the game state. Update the state dictionary when progresses are made such as a key is collected.
-
-* Use Python functions to play the game. Don't use procedural code.
-
-* After completing each game action, call the next function to continue playing until the winning condition is reached.
-
-* The winning condition is for the player to successfully make to the "Outside" room. When this happens, congrat the player and end the game.
-
-## Necessary Deliverables
-
-The following deliverables should be pushed to your Github repo.
-
-* `main.ipynb` that contains your solution.
-
-## Suggested Ways to Get Started
-
-1. Start Jupyter Notebook from this lab directory.
+## How to play the Game
 
-1. Launch `sample-code.ipynb` and read through the file. Also execute the code and play the game. Make sure you understand what each line of the codes does.
+1. Clone this repo in your GitHub
 
-1. Create `main.ipynb` and copy the codes from `sample-code.ipynb`. Expand the code following the example to create Bedroom 1.
+2. Launch `surreal_escapy.py` (in command prompt, type `python surreal_escape.py`)
 
-1. Test the game with Game Room and Bedroom 1. Make sure everything works then work on Bedroom 2 then Living Room.
+3. If you enjoyed, you might want to ~~take a break~~ :sparkles: spur your nostalgia further :sparkles: by checking some of the (successors of text-based) classic point-and-click adventure PC games I grew up with:
+   - [Zak McKracken and the Alien Mindbenders](https://en.wikipedia.org/wiki/Zak_McKracken_and_the_Alien_Mindbenders) 1988
+   - [KGB](https://en.wikipedia.org/wiki/KGB_(video_game)) 1992
+   - [Gabriel Knight: Sins of the Fathers](https://en.wikipedia.org/wiki/Gabriel_Knight) 1993
+   - [Simon the Sorcerer](https://en.wikipedia.org/wiki/Simon_the_Sorcerer) 1993  
+   - [Prisoner of Ice](https://en.wikipedia.org/wiki/Prisoner_of_Ice) 1995
 
-1. Test the whole game. Try to make all kinds of inputs to make sure your game is rock solid and will not break.