Hangman Animal edition

• Live Website
• Github Repository

About

Classic Hangman game, running in the Code Institute mock terminal on Heroku.

Players need to guess the correct word before the hangman picture is complete.

Table of Contents

• How To Play

• User Experience UX

• Features

• Technologies Used

• Data Model

• Testing

• Deployment

• Bugs

• Credits

How To Play

Players can select between three difficulties, easy, medium, and hard. Players will then have nine attempts to guess a letter in the animal word before the hangman picture is complete and the game is over.

User Experience UX

User Stories

i. As a user, I am looking to play a classic version of Hangman.

1. I want the layout of the game to be simple to navigate through.
2. I want the game to have a retro design.
3. I want to be able to see the results as I play.
4. I want to be able to see what stage of the Hangman I ‘am at.

ii. As a user who has never played this game before.

1. I do not want it to be too difficult.
2. I want the game to tell me what the word was if I lose.
3. I want to be able to see what correct letters I have guessed.
4. I want to be informed if I have already guessed a letter before.

iii. As a user who is well versed in the game.

1. I want to be able to play on a higher difficulty.
2. I want the game to tell me if I have guessed correctly or not.
3. I want the game to have a retro/arcade feel.

Features

• Users are welcomed to the game with the title screen displaying the game title and prompting them to initiate the game.
• Players will then need to select between three difficulties, easy, medium, and hard. As difficulty increases animal words that are more obscure and or longer words are selected from the word dictionary.
• Players are then asked to provide their letter guess.
• When guess is submitted the program will give feedback on whether the input was valid then whether the letter guessed was in the word.
• If players guess was correct the word is displayed with the correct letter visible, and the letters still not guessed hidden with an underscore.

• If input is not in the word the hangman picture is displayed along with a wrong answer counter.
• The hangman picture is iterated through as users get wrong answers until the last stage of the picture is displayed.
• Game over is displayed when the player reaches nine wrong answers without completing the word, the word they were attempting to guess is also displayed.
• If the player guesses all the letters in the word, then WINNER is displayed.
• Win or lose when the game is complete the player is asked whether they want to play again, yes or no.
• If yes is selected the player is brought back to the difficulty menu.
• If no is selected the player is returned to the title screen.

Future Features

• An expansion of the word dictionary.
• Additional difficulty levels.
• Addition text graphics.

Technologies Used

Languages Used

• Python

Frameworks, libraries, and programs used

-Heroku Heroku was used to host the files and to publish the finished program.

-Gitpod Gitpod was used to code the website and commit changes throughout the development to Github.

Data Model

• The program begins from the main() function which triggers the title_text() function in which the player must type "play" to enter the next phase.
• The difficulty_selection() function is then initiated where the player is required to select a difficulty option from easy/med/hard.
• Once a difficulty is selected the clear_lists() function is run to ensure the dictionary lists are empty ready for the new game.
• Then the input_checker() is run which is the main body of the game, this will check if the users guess input is valid and whether it is in either the wrong or correct lists in the dictionary.
• If the users guess hasn't been guessed before then the lists will be appended, and the user will be informed if whether their guess was right or wrong.
• The print_result() function will then commence which will run a for loop to append the letters in the word_to_guess that are in the correct list. Then remaining letters that are not in the list will be replaced with and underscore in a results list and printed to the terminal then cleared.
• When a new wrong letter is submitted the same series of events begins with the addition of the printing of the Hangman picture, the i is increased by one so that the next time the Hangman image is iterated in the list where it is stored.
• If the length of the unique letters in the correct list is equal to the ones in the word the user is guessing "Winner" is displayed and the game runs the restart() function.
• If the wrong answers count reaches nine "Game Over" is displayed and the game runs the restart() function.
• The restart() function will ask the user if they would like to play again, if the player selects “yes” the will be taken back to the difficulty selection and the process begins again.
• If the user selects “no” then they will be returned to the title screen where again the series of events start over.
• The cprint_font() is used to print text art to the terminal to enhance the user experience.

Testing

Functionality Testing

Invalid inputs have been entered into all options and navigational inputs throughout the game such as:

• Strings too long.
• Strings too short.
• Integers.
• Valid word plus space. Game inputs for letter guesses have also been tested such as:
• integers.
• Strings too long.
• Strings too short.
• Valid word plus space.
• Already guessed letters.
• All input testing returns correct and expected responses.

Validator Testing

• PEP8. No errors were returned from PEP8online.com

Testing User Stories

i. As a user, I am looking to play a classic version of Hangman.

1. I want the layout of the game to be simple to navigate through.

• The game has clear prompts to navigate through with ease.

2. I want to be able to see the results as I play.

• The player is provided with feedback on wrong guesses / correct guesses.

3. I want to be able to see what stage of the Hangman I ‘am at.

• The Hangman picture is displayed in corresponds with how many wrong guesses the player has submitted.

ii. As a user who has never played this game before.

1. I do not want it to be too difficult.

• The player is provided with an easy difficulty.

2. I want the game to tell me what the word was if I lose.

• Win or lose the game will display what the word was at the end of play.

3. I want to be able to see what correct letters I have guessed.

• The game displays each letter of the word as underscores unless correct letter has been submitted. e.g., "","o","".

4. I want to be informed if I have already guessed a letter before.

• Right or wrong the player will be informed if they have already guessed the letter.

iii. As a user who is well versed in the game.

1. I want to be able to play on a higher difficulty.

• The player has the choice of three levels of difficulty: easy/med/hard.

2. I want the game to tell me if I have guessed correctly or not.

• The player is always informed whether the letter they have guessed is right or wrong.

3. I want the game to have a retro/arcade feel.

• As the game is run in the Code Institute mock terminal it lends to an arcade/retro design.

Deployment

Heroku

The program has been deployed using Code Institute mock terminal for Heroku.

Steps for deployment:

• Fork or clone the repository.
• Create a new Heroku app.
• Set the build backs to Python and Nodejs in this order.
• Link the Heroku app to the repository.
• Click Deploy.

Forking the GitHub Repository

To contribute you can Fork without affecting the main branch. Follow the instructions outlined below.

1. Go to GitHub and log in.
2. Find the Repository that was used for this project.
3. To the right of the Repository name you will see the 'Fork' button. This is located next to the 'Start' and 'Watch' buttons.
4. Doing this will place a copy in your own repository.
5. When you are finished locating the 'New Pull Request' button above the file list on the original repository.

Cloning

• To clone or download the repository to your own device follow the instructions listed below.

1. Head to Github and log in.
2. Find the Repository for this site.
3. Below the name of the repository find the 'Clone or Download' green button.
4. To clone the repo using HTTPS click the link below "Clone with HTTPS".
5. Open your Terminal and go to the directory you want the cloned directory to be copied to.
6. Enter "Git Clone" and paste the URL copied from GitHub.
7. Create your local clone by pressing "Enter".

Bugs

Solved Bugs

• Each time correct letter was submitted to correct list it would print for example "","i","","p","i","_","p","i","g".
• This was resolved by clearing the list at the end for the for loop which was latter made into a function to reduce length of program code.

Remaining Bugs

• No known bugs remaining at time of writing.

Credits

Code

• Code institute walkthrough “love Sandwiches” for Python structure layout
• Code institute Python essentials.
• Stackoverflow for tips, examples concepts for further understanding of language definitions.
• w3schools for tips, examples concepts for further understanding of language definitions.
• GeeksforGeeks for examples for understanding language better.

Content

• All code written by the author - Jack Jenns

• To create the README file inspiration was taken from:

• Code Institute SampleREADME

• Code Institute README Template

• Markdown cheat sheet

Acknowledgements

• Stackoverflow.
• Fellow students on slack.
• My mentor for his guidance.
• W3schools.
• GeeksforGeeks