Ameen Noor

"Worldscape Adventure" is an interactive word-guessing game that offers players an engaging and educational experience. In this game, players will have the opportunity to explore and guess names of countries, cities, and landmarks from around the world. The objective is to unveil the hidden name by guessing one letter at a time while managing a limited number of lives. The game is designed to test players' knowledge of geography and improve their letter-guessing skills.

Click here to visit the website.

• ActiveBeat Center
  • Author
  • Introduction
  • Table of Contents
  • User Experience (UX)
    • User storis
    • Design
  • How To Play
  • Features
    • Implemented Features
    • Future Features
  • Data Model/ Classes
    • Worldscape
    • Main Program
    • Data Flow
  • Technologies Used
    • Languages Used
    • Frameworks, Libraries and Programs Used
  • Testing
    • Validation Testing
    • Manual Testing
    • Fixing Bugs
  • Deployment
    • Heroku
    • Gitpod
  • Credits
    • Code
    • Content
    • Media
    • Mentor

1. As a player, I want to find a clear and understandable main menu with options like "How to Play," "Play Game," "Game Statistics," and "Exit" for easy navigation.

2. As a player, I want to access straightforward instructions when choosing "How to Play" from the main menu.

3. As a player, I want access "Play Game" menu where I can select whether to guess a country, city, or landmark name, and return back to the main menu.

4. As a player, I want start gameplay, with clear feedback on guessed letters and an enjoyable way to reveal the hidden name.

5. As a player, I want access "Game Statistics" section that displays the number of games played, games won, and games lost, allowing me to track my progress.

1. Main Menu:

   • When you start the game, you'll see the main menu with four options: "HOW TO PLAY," "PLAY GAME," "GAME STATISTICS," and "EXIT."
   • Use the keyboard to select the option you want by entering the corresponding letter (e.g., 'A' for "HOW TO PLAY").

2. How to Play:

   • If you're new to the game or need a refresher, choose "HOW TO PLAY" from the main menu ('A').
   • Read the provided instructions to understand the game rules and how to navigate the game.

3. Play Game:

   • To start playing, select "PLAY GAME" from the main menu ('B').
   • You will then have the option to choose a game category: "COUNTRY," "CITY," or "LANDMARKS." Enter the corresponding letter to make your choice ('A' for "COUNTRY," 'B' for "CITY," or 'C' for "LANDMARKS").

4. Gameplay:

   • You'll be presented with a hidden name from your chosen category, with the letters initially replaced by dashes.
   • You have 8 lives to guess the name correctly.
   • Guess one letter at a time by entering a single alphabetical character.
   • If the letter you guess is in the name, it will be revealed. If not, you'll lose a life.
   • Continue guessing letters until you either guess the entire name correctly or run out of lives.

5. Winning the Game:

   • If you correctly guess the name, congratulations, you win the game!
   • The game will display a winning message.

6. Losing the Game:

   • If you run out of lives without guessing the name correctly, you lose the game.
   • The game will display a losing message and reveal the correct answer.

7. Play Again:

   • After a game, you have the option to play another round within the same category.
   • If you choose to play again, you can keep guessing new names to improve your skills.

8. Game Statistics:

   • You can view your game statistics at any time by selecting "GAME STATISTICS" from the main menu ('C').
   • This option shows you the number of games played, games won, and games lost.

9. Exiting the Game:

   • To exit the game, select "EXIT" from the main menu ('E').

1. Main Menu Navigation: The main menu provides clear options for the user, including "How to Play," "Play Game," "Game Statistics," and "Exit," ensuring easy navigation and interaction.

2. Game Instructions ("How to Play"): Users can access game instructions, allowing them to quickly understand the game's rules.

3. Game Category Selection: Players can choose from three categories - countries, cities, or landmarks

4. Interactive Gameplay: During the game, users interact by guessing letters one at a time, with feedback. Correct guesses reveal hidden letters, while incorrect ones deduct lives.

5. Progress Tracking ("Game Statistics"): The "Game Statistics" option allows users to track their progress effortlessly, displaying the number of games played, games won, and games lost.

6. Exit Option: Users can exit the game by selecting "Exit" from the main menu.

8. Colorful Notifications: The game provides interactive feedback and colorful notifications.

1. High Score Tracking: Implement a feature to ask the user for their name and record all game statistics in an Excel file, allowing players to view high scores and compete for the top spot.

2. Difficulty Levels: Add the option for players to choose between different difficulty levels, such as easy and difficult.

3. Dynamic Word Generation: Instead of using a constant list of words, connect to an API for word generation, to ensure every game is an exciting adventure.

The Worldscape class represents a word-guessing game environment, allowing players to guess letters to unveil a secret word, track their progress, and manage their remaining lives.

Attributes:

1. name_list: A list of names (countries, cities, landmarks) from which the secret name will be randomly selected.

2. secret_name: The current secret name that the player needs to guess.

3. encoded_name: The secret name encoded with dashes, where each letter is initially hidden.

4. letters_used: A list of letters that the player has already guessed.

5. lives: The number of remaining lives the player has.

Functions:

1. init(self, name_list): Constructor method to initialize class attributes.

   • name_list: The list of names provided as an argument.
   • Initializes secret_name and encoded_named as empty strings.
   • Initializes letters_used as an empty list.
   • Initializes lives to 8.

2. generate_secret_name(self): Randomly selects a secret name from the provided name_list.

   • Returns the generated secret name.

3. encode_name(self): Encodes the secret name by replacing its characters with dashes.

   • If the country name contains spaces, spaces are displayed as spaces, and other letters are displayed as dashes.
   • Returns the encoded name.

4. is_letter_valid(self, input_letter): Validates whether the given input letter is a single alphabetical character.

   • Returns True if the input is valid, False otherwise.

5. is_letter_in_name(self, letter): Determines whether a given letter is present in the secret name.

   • Returns True if the letter is in the name, False otherwise.

6. add_used_letter(self, letter): Takes a letter entered by the user and adds it to the letters_used list.

   • Returns the updated list of used letters.

7. is_letter_used_before(self, letter): Checks whether a letter has been previously entered by the user.

   • Returns True if the letter has been used before, False otherwise.

8. replace_encoded_name_with_guessed_letter(self, letter): Replaces dashes in the encoded name with the correct guessed letter.

   • Returns the updated encoded name.

9. display_output(self, name): Displays game information to the user, including the number of remaining lives, the guessed letters and dashes in the secret name, and the list of letters that have been used before.

The main program consists of different functions.

Functions:

1. clear_terminal(): Clears the terminal screen based on the operating system (Windows or Mac/Linux).

2. display_statistics(): Displays statistics related to the user's gameplay, including the number of games played, games won, and games lost.

3. update_game_statistics(is_won): Increments the total games played and either the total games won or the total games lost based on the outcome of the game.

4. display_how_to_play(): Provides instructions on how to play the game.

5. play_game(name_list, name): Allowing the player to guess letters and attempt to uncover the secret name.

6. main(): Allowing users to navigate through the game menu, select game options, and play the game.

• The Worldscape class handles game-specific data, such as the secret name, lives, and encoded name.

• The main program manages user interaction, displays menus, and calls the appropriate functions of the Worldscape class based on user input.

1. Python

1. Heroku: Heroku was employed for project deployment.

2. GitHub: GitHub was utilized to store the project file and folder remotely.

3. Git: Git was used in the Gitpod terminal to add, commit, and then push the changes to GitHub.

4. CI's pep8 tool: CI's pep8 tool was used to ensure the code is valid and follows proper indentation

5. pyfiglet: Pyfiglet was used to stylized ASCII art text for titles and banners.

6. simple-colors: Simple-colors was used to colored text.

7. draw.io: draw.io was used to craft the flowchart

Validation testing was performed using CI's PEP8 tool to ensure code quality. Here are the validation testing results for each file:

1. worldscape.py

2. names.py

3. run.py

View manual testing results here!

• Validation Bug

  1. worldscape.py: Indentation issues in the 'worldscape.py' file have been fixed.

  

  2. names.py: Indentation issues in the 'names.py' file have been fixed.

  

  3. run.py: Indentation issues in the 'run.py' file have been fixed.

  

To deploy the site on Heroku, follow these steps:

1. Begin by forking the repository: https://github.com/AmeenNoor/worldscape-adventure.

2. Log in to Heroku and click "New." Select "Create new app."(see screenshots below):

3. Choose a unique name for your app, select your desired region, and then click "Create app." (see screenshot below):

4. In the app settings, navigate to the "Config Vars" section. Add a key-value pair where the key is "PORT" and the value is "8000." (see screenshots below):

5. Under the "Buildpacks" section, click "Add buildpacks." Add "python" and "nodejs" as buildpacks. Ensure that Python is selected first, followed by Node.js. Save your selections. (see screenshots below):

6. In the "Deploy" section, choose "GitHub/Connect to GitHub" as your deployment method. Search for the project on GitHub and connect it. (see screenshots below):

7. Finally, click "Deploy Branch" to deploy your project. (see screenshot below):

To work with the project using Gitpod, follow these steps:

1. Fork the repository to create your own copy for personal use.

2. Install the Gitpod extension from the Visual Studio Code marketplace or your preferred extension source.

3. Inside the Gitpod workspace, install the project's requirements by running the command pip3 install -r requirements.txt in the terminal.

4. Start the program by running python3 run.py in the terminal.

1. The GitHub repository was created using the "Code Institute template." You can find the template at: Code Institute Template.

2. The logic for clear_terminal() function was adopted from How to clear screen in python?.

1. List of Countries: obtained from Worldometers.

2. List of Cities: obtained from World Maps.

3. List of Landmarks: obtained from Destguides.

3. The responsive image is generated using the Am I Responsive tool.

Huge thanks to my mentor "Malia Havlicek" for her support and guidance.