Escape Room Game Files

README.md

@@ -1,135 +1,32 @@
 <img src="https://bit.ly/2VnXWr2" alt="Ironhack Logo" width="100"/>
 
-# Project: Escape Room Python Game
+# Escape Room Python Game
 
 ## 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.
+Welcome to our Escape Room Python Game project! In this project, my team has developed an exciting text-based Escape Room game using Python. The objective is to challenge players' problem-solving skills and creativity as they navigate through a series of rooms to find clues and ultimately escape.
 
-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.
 
----
+## Challenges Faced
 
-## Game Design
+Our journey wasn't without its obstacles. In the initial stages, we encountered several challenges that demanded creative solutions:
+- In our first code iteration, the order of actions (examine or explore) didn't align logically. We revised the sequence to enhance player experience.
+- The game loop lacked a clear option for the player to exit, leading to frustration. We addressed this issue by refining the user interaction flow.
 
-### Game Map
+## Improvements Made
 
-![Game Map](escape-room-plan.jpg)
+We implemented several enhancements to elevate the player experience:
+- **Immersive Sound**: Added sound effects to enhance the atmosphere and engagement.
+- **Visual Keys**: Incorporated visual cues to guide players through the game.
+- **Timer**: Introduced a time limit feature to add urgency and excitement.
+- **Ranking**: Implemented a ranking system to encourage replayability and competition.
 
-### Game Narratives
+## Future Enhancements
 
-#### Game Room
+We have identified areas for further improvement:
+- **Language Translator**: Integrating a language selection feature to cater to a diverse audience.
+- **Game Data Saving**: Implementing a feature to save game progress and rankings for future reference.
+- **Level of Difficulty**: Adding multiple difficulty levels to accommodate players of varying skill levels.
 
-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!
+Feel free to contribute to the project and suggest additional enhancements to make the Escape Room Python Game even more captivating and enjoyable!
 
-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.
-
-You examine double bed. You find key for Door C.
-
-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.
-
-You examine Door D. Your unlock it with a key you have.
-
-Do you want to go to the next room?
-
-#### Outside
-
-Congrats! You escaped the room!
-
----
-
-## 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.
-
-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. Create `main.ipynb` and copy the codes from `sample-code.ipynb`. Expand the code following the example to create Bedroom 1.
-
-1. Test the game with Game Room and Bedroom 1. Make sure everything works then work on Bedroom 2 then Living Room.
-
-1. Test the whole game. Try to make all kinds of inputs to make sure your game is rock solid and will not break.

specifications.md

@@ -0,0 +1,135 @@
+<img src="https://bit.ly/2VnXWr2" alt="Ironhack Logo" width="100"/>
+
+# Project: Escape Room Python Game
+
+## 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.
+
+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.
+
+---
+
+## 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.
+
+You examine double bed. You find key for Door C.
+
+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.
+
+You examine Door D. Your unlock it with a key you have.
+
+Do you want to go to the next room?
+
+#### Outside
+
+Congrats! You escaped the room!
+
+---
+
+## 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.
+
+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. Create `main.ipynb` and copy the codes from `sample-code.ipynb`. Expand the code following the example to create Bedroom 1.
+
+1. Test the game with Game Room and Bedroom 1. Make sure everything works then work on Bedroom 2 then Living Room.
+
+1. Test the whole game. Try to make all kinds of inputs to make sure your game is rock solid and will not break.