anag0307 / adventureland

Adventureland

View the App on Render here

Table of Contents

1. How to Play
2. Features
3. Data Model
4. Testing
5. Deployment
6. Credits

How to Play

Adventureland starts with the player been asked their name and then they get introduced to the story. They are the main character and do not remember what happened. The last memory is of them being in the street with some friends and then everything became blurry. The player wakes up in an empty room and straight away gets asked what actions s/he wants to take to get out of there. The player will go from room to room and will get to choose what items to pick, what items to use and what doors to go through in order to survive and get out of the place.

User stories

The game is designed for young gamers between the age of 8 and 10 years old that starts to show some interest on written adventure games. The main user of the game is a young gamer exploring different types of computer games and is open to new adventures and ways of entertainment. The game is designed to be simple enough for children from 8 years old to be able to interact with the different challenges.

Solutions to Riddles

• Firebird riddle: the solution is "name" or "your name";
• Sorcerer riddle: the solution is "rainbow";

Features

Existing Features

• The voice of the game guides the player throught the different rooms;

• The player plays against him/herself;
• If the player dies they can choose to restart the game or not;

• Answers validation:
  • Riddles: the player needs to provide the correct answers to keep playing;
  • When a specific answer is not provided the player is prompted again;

• Objects: the player needs to collect objects in order to get out of the house;

Future Features

• Introduce new levels to increment the level of difficulty;
• Add a map for the player to know where they are;
• Add a score tab;
• Be able to freely move back and forth inside the house;

Data Model

Before starting to code the game I did have a look to written adventure games like the classic The Dreamhold and decided what I wanted to inlcude in mine. The final decision for Adventureland was as per below:

The different rooms have been created using functions, to connect them they call each other depending on what the player's interaction is.

In regards of the objects collected in the different rooms, those are collected in a dictionary with boolean values. The value is set to 'False' by default and if the object is collected it changes to 'True', allowing the player to use it when necessary (if they have collected, of course).

After having worked on the flowchart planned and had all the code working as expected, I analysed the quality of the code. I noticed that if in the future I want to add more rooms and extra levels of difficulty I will need to change how the code is organised. At the moment the logic of the game and the room's specifications are mixed together within the functions, this makes very difficult to have a biggest amount of rooms because the code would become very complex pretty soon. After analysing and investigating further I believe the best option is, on one hand, to create a dictionary from one side specifying the rooms characteristics and, on the other hand, to create the functions with the games' logic (i.e. what happens if an incorrect answer is entered, what happens when the player goes into a particular room). This would allow to create a much complex set of rooms in each level as well as creating different levels of difficulty.

Testing

The game is been manually tested by doing the following:

• Tested the game in Gitpod by providing incorrect data (i.e. answering other than 'yes' or 'no' when those were the only accepted answers) to check the game flow could be followed;
• The game is also tested in Heroku to check all the expected behaviours described above were also true;

Bugs

While coding the game there was a few issues with the if loop to get the expected answer from the player, an infinite loop was created. This was corrected by using an 'input' statement rather than a 'print' so the player could modify their answer rather than repeting the whole function again.

When playing in Heroku or in the Gitpod terminal, the words get splitted in the Heroku app, a solution could not be found into this and it is been left untouched (see line 2 and 6 in the screenshot below).

Remaining Bugs

At the time of testing there were no bugs left.

Validator Testing

• Used PEP8online.com and no errors were returned.

Deployment

The project is been deployed to Heroku. Steps for deployment:

• Local deployment:

  • Fork the project to copy the repository:
    • On GitHub navigate to the Adventureland repository and in the top-right corner of the page click 'fork';
  • Clone the project to create a local copy of the repository in your computer:
    • Within the forked repository click on the green button 'Code';
    • To clone the repository using HTTPS, under "Clone with HTTPS", click the clipboard sign. Select if you want to use an SSH key or GitHub CLI, then click the clipboard sign;
    • Open the terminal and change the directory to the location you want;
    • Type 'git clone' and paste the URL copied in step 2 and press enter to create your clone;
  • Check the Procfile to ensure a correct deployment to Heroku;

• Deployment to Heroku:

  • Create an account in Heroku;
  • Create a new app in Heroku: choose a unique name and region;
  • No sensitive data needed to be kept secret so nothing was added in the config Var tab;
  • Add necessary buildpacks: Python and NodeJS in this order;
  • For deployment method, GitHub was selected and confirmed we want to connect to GitHub;
  • Connect Heroku to the repository for Advertureland;
  • Set "Enable Automatic Deploys" to allow automatic deployments every time the code is pushed;
  • Click on Deploy.

Credits

• Lucidchart to create the flowchart;
• Stackoverflow and GeeksforGeeks for debugging.

Back to Top ⇧