The live website can be found here.

This game is mostly targetted to fans of Tolkien's The Hobbit, however it can be enjoyed by anyone who wants to play a text-based make-your-own-adventure game.

• Purpose
• How to Play
• UX & Stories
  • User Goals
  • Flowchart
  • Design
    • Colors
    • Font
• Features
  • Header
  • Game Button
  • Terminal
  • Instructions
  • Start Game Query
  • Name Selection
  • Weapon Selection
  • First Battle
  • Post First Battle
  • Second Battle
  • Post Second Battle
  • Pre Third Battle
  • Third Battle
  • Post Third Battle
  • Pre Fourth Battle
  • Fourth Battle
  • Game End
  • Incorrect Responses
• Technologies Used
• Testing & Validation
  • Manual Testing
  • User Stories
• Future Implementations
• Deployment
• Credits

This Hobbit adventure game was created for anyone interested in Tolkien's world of Middle Earth and/or text-based old school games.

Throughout this text-based game, the User will be presented with a number of choices. Other than the name input, these will either be y/n or a/b/c/d choices. These are always validated by the terminal, and the User cannot continue until an accepted response is given. The User will be prompted to enter an accepted response if one is not entered. The User is offered instructions before starting the game proper.

Dependent on the User's chosen weapon and subsequent choices in battles, a number of traits can be collected. There are three negative and one positive trait. The negative traits will impact the outcome of various battles in a potentially detrimental way, whereas the positive traits (or absence of any traits) serve as a dialogue reward and make subsequent battles less likely to result in game over.

• As a first time user, I want to easily understand what the site is for
• As a first time user, I want to enjoy playing a text-based adventure game
• As a first time user, I want to revisit the world of The Hobbit
• As a first time user, I want to understand how the game works

• As a returning user, I want to see if I can finish the game with fewer negative traits and game overs than before
• As a returning user, I want to explore the different routes available in the game

• As a frequent user, I want to see if I can finish the game with no negative traits or game overs
• As a frequent user, I want to see if any battle have been expanded, or new battles have been added

I created a flowchart to lay out the direction of the game and what various overall choices would result in.

I added two Hobbit-related messages while the game loads to help the User immerse in the story.

I centered the Play Game button and the terminal for a more appealing web design.

• Light purple #870fcc is used for the game title and the Play Game button background
• Dark purple #370753 is used for the Play Game button border
• Black #000000 was used in the background so it blends with the terminal
• White #ffffff was used for the Play Game button text

• The Reggae One font is used for the page title as I find this is a good standard fantasy-style font

The header is "The Hobbit Adventure Game" to inform the User of what the site is for.

The default Run Program button from the Code Institute template was renamed and restyled to fit the page styling.

The default terminal styling from the CI template was replaced with a centered terminal which sits below the Play Game button.

The User is presented with a y/n input request after the game blurb asking whether they would like instructions. If the User selects y, they will be given instructions. These inform the user on the sort of questions and required response inputs they can expect, as well as encouraging them to think carefully about their responses.

Following the instructions, the User is asked whether they would like to start the game or not. This allows for good UX as the User can choose whether to continue or not.

The name selection is the only open input in the game. I added the .capitalize() method so the User's name is capitalized, regardless of whether they added their own capital letter. Having a name selection allows for a more personalised experience for the User.

After choosing a name, the User is given the first proper game choice - choosing a weapon. This is also the first abcd choice. This will influence the dialogue trees presented to the User in the rest of the game. The User is given some information on their chosen weapon and informed that it has been added to their inventory.

The first battle contains prerequisite dialogue before the User is presented with another abcd option. The success of this battle is based on which weapon was chosen - each option corresponds with only one weapon. If the User chooses incorrectly, they will sustain an injury, which is added to their inventory.

Following this, the User is presented with another y/n option. Choosing correctly will progress the game, choosing incorrectly will result in a game over.

The second battle begins with dialogue dependent on whether an injury was sustained in the previous battle or not. After, the User is presented with a y/n option. The success of this battle is based on the weapon and injury-status of the User's character. Choosing incorrectly will result in a game over.

This post-battle does not contain any input requirements for the User. If they chose incorrectly in the past two battles, the User will be reminded of their weapon and character's accumulated traits. If the User chose correctly in the past two battles, they will be informed of their current success.

This runs dialogue about the battle that is about to happen, and allocates the User to one of three Third Battle trees dependent on their chosen weapon.

The third battle presents the User with another y/n response. There are two potential game over paths here, dependent on the User's choice of weapon and responses in this battle and the previous ones.
The User can acquire up to two negative traits and one positive trait.

Before entering the final battle, the User is reminded of their characters weapon and any traits they have acquired along the way.

This runs dialogue about the final battle, congratulates the player on making it this far, and allocates them to a Fourth Battle path dependent on which traits (if any) have been acquired so far.

The fourth, and final, battle has a number of paths dependent on how the User has faired so far. Regardless of path, the User will be presented with an abc response. The choice will either lead to victory, or a game over.

If the User survives the final battle, they will be congratulated, with the final line of dialogue hinting at more battles to come.

Following the final battle, the program will game over. The User has the option to try again, or to quit the game.
If the User chooses to play again, their inventory will be emptied. The clear_terminal function empties the terminal so it is tidy for the User to play again.

If the User gives a response other than what is expected, they will receive a message based on the style of input and be asked to respond again.

• Python

• HTML5

• CSS

• Git

  • Used for version control through GitPod terminal with commits to GitHub and pushes to GitHub & Heroku

• Heroku

  • Used for deployed application

• Chrome DevTools

  • Used to work on HTML & CSS styling

• LucidChart

  • Used to create flowchart of game path

• Stack Overflow

  • Used for troubleshooting Python issues

• Sys

  • Used on slowprint function
  • Used on game_over function to exit game

• Time

  • Used for delay in slowprint function

• Random

  • Used on slowprint function

• os

  • Used to clear terminal

• Game tested on both Mac and Windows to ensure everything ran smoothly.

• Game tested on Chrome, Safari & Firefox.

• Encountered various instances early on where if statements were not working correctly

  • For the most part, this was due to trailing white spaces at the beginning of lines. Once removed, if statements worked correctly.

• Early on, passing the Python code through PEP8 returned issues with line length - these were caused by nested if statements leading to longer lines due to indentation.

  • This was fixed by changing the position of line breaks in print statements.

• Two linting errors present in code - both for the two global variables
  NAME_INPUT and
  WEAPONS
  No fix found at this stage, but will research further.

• Presented issues when using constants over "x in y":

  • Will look more into this so constants can be used to reduce repetition.
  • Was fixed by researching multi-line if conditions and implementing those.

PEP8 online test returned no issues.

The WRC Validator returned no issues for HTML or CSS:

• Game tested continuously by running through various options and responses (both correct and incorrect) to ensure User receives correct pathways and dialogue responses.
• Ensured game over functioned correctly.
• print(inventory) used before final deployment to check inventory was updating accurately.

As a first time user, I want to easily understand what the site is for
- Upon entering the game, the purpose of the site is immediately presented to the User with the Game Title and welcome message

As a first time user, I want to understand how the game works
- The instructions option will inform the User of how the game works and what is expected of them

As a first time user, I want to revisit the world of The Hobbit
- The game uses familiar names and monsters from The Hobbit to immerse the User

As a first time user, I want to enjoy playing a text-based adventure game
- The game follows a steady pace so the User can easily follow along and enjoy the game

As a returning user, I want to explore the different routes available in the game
- With previous knowledge, the User can follow different paths to see their outcomes

As a returning user, I want to see if I can finish the game with fewer negative traits and game overs than before
- With previous knowledge, the User can avoid certain negative outcomes and see if they can improve upon their last play - The game is not too long, and the different paths avoid repetition, so the game remains interesting

As a frequent user, I want to see if I can finish the game with no negative traits or game overs
- With solid knowledge on the game, the User can be confident in their ability to aim for a perfect run

• os.system('clear') doesn't always clear the terminal - will research further

• Imagery and further styling to be added to enhance UX

• Option to end game at any stage, improving UX

This project was deployed using Heroku.

Steps to deploy:

• Fork or clone this repository
  • In GitHub, locate the repository and click 'Fork' in the top right
  • This will create a copy of the repo in your account
• Create or login to Heroku account
• Click 'new' in the top right and select 'new app' from the dropdown
• Give your app a name and click 'Create'
• Navigate to settings and select 'buildpacks'
• Add python and node.js, ensuring they are displayed in that order (python above)
• Navigate to 'Deploy'
• Navigate to 'Deployment Method' and connect to GitHub account
• Search for your GitHub repository and connect it
• Choose either Automatic or Manual deployment (Automatic will work inline with pushes from GitHub)
• Ensure 'branch to deploy' is master/main
• Hit deploy

• The code for slowprint() was taken from stack overflow here with the time altered to be slightly slower

• My tutor, Brian Macchiara, for continued support and good chats