CPSC 231: Assignment 2

Due Monday Oct 24 at 4 PM

New Concepts to be applied for the assignment

• Problem solving using branches and loops in Python

Description:

Write a text-based adventure game. There will be three 'rooms' in the game world, within each room the player will see a number of choices and the program will react to the player's selection. The game will repeatedly run the game via a main loop (contains most of the instructions of the program) until the game has been won. The goal of this mini-game is to open the locked door to access the rest of the house. The door will only be unlocked if the player turns the dial in the pantry to the 'red' setting and pulls the lever in the kitchen to the 'back' position. When the door has been unlocked the player can return to the entrance room and open the door to the rest of the house satisfying the goal of this mini-game, the main loop ends and a suitable congratulatory message should be displayed.

Sample program output:

A text file "output_normal_play.txt" shows sample execution of my solution with a normal play through (no erroneous selections). Another text file "output_invalid_selections.txt" illustrates what should happen when the player selects an option that isn't listed. These files can be found in UNIX under /home/231/assignments/assignment2. Alternatively you can see the contents of the A2 directory via a [shortcut link].

Entrance room description

The player begins the game in the entrance. The door that brought the person into the house is gone (it's a "one way portal"). When the player is in this room the game will describe the list of possible actions:

1. Try to open the door
2. Go through the left entryway
3. Go through the right entryway

As mentioned the player cannot open the door until it as been unlocked. The player can freely pass through either entryway with no conditions. Entering a non-existent selection will result in a suitable helpful error message (refer to the last section of the 'repetition' notes, rules of thumb for how to write good error messages) and the above options are displayed again. The program does not have to handle cases where an invalid type of information (e.g. string instead of number) has been entered. As long as the player remains in the room the program will repeatedly display the above menu options (using a loop) after each time that the user enters his/her selection.

Pantry description

As shown in the above map the player can freely pass between the entrance and the pantry. When the player is in this room the game will display the list of possible actions:

1. Turn the dial to blue
2. Turn the dial to red
3. Turn the dial to green
4. Don't touch that dial! Return to entranceway

The program should show the current state of the dial e.g. "The dial is currently set to green". Similar to the entrance if the player enters an invalid selection in the pantry, a suitable and helpful error message should be displayed and the list of options for the pantry will be shown again.  As long as the player remains in the room the program will repeatedly display the above menu options (using a loop) after each time that the user enters his/her selection.

Kitchen description

As shown in the above map the player can freely pass between the entrance and the kitchen. When the player is in this room the game will display the list of possible actions:

1. Pull lever to the 'back' position
2. Push the lever to the 'forward' position
3. Don't touch the lever and return to entranceway

The program should show the current lever position e.g. "The lever is currently set to forward". Similar to the entrance if the player enters an invalid selection in the kitchen, a suitable and helpful error message should be displayed and then the list of options for the kitchen will be shown again.  As long as the player remains in the room the program will repeatedly display the above menu options (using a loop) after each time that the user enters his/her selection.

In addition to grading on whether the above functionality was correctly implemented TAs will also look at style and documentation.

Documentation (synopsis from the intro to programming notes)

• Contact information (name and student ID)
• Header documentation: summarize functionality of program
• Inline documentation: for each room describe the specific features from the assignment description that were implemented for the room
• Program limitations (if applicable)

Style  (synopsis from the intro to programming notes)

• Good naming conventions
• The use of named constants as appropriate
• Clear expressions (mathematical, Boolean)
• Appropriate use of whitespace (not too much or too little)

[TA Marking spreadsheet]

Points to keep in mind:

1. Due time: All assignments are due at 4 PM on the due dates listed on the course web page.  Late assignments or components of assignments will not be accepted for marking without approval for an extension beforehand. What you have submitted in D2L as of the due date is what will be marked.
2. Extensions may be granted for reasonable cases by the course instructor with the receipt of the appropriate documentation (e.g., a doctor's note). Typical examples of reasonable cases for an extension include: illness or a death in the family. Cases where extensions will not be granted include situations that are typical of student life: having multiple due dates, work commitments etc. Tutorial instructors (TA's) will not be able to provide extension on their own and must receive permission from the course instructor first. (Note: Forgetting to hand your assignment or a component of your assignment in does not constitute a sufficient reason for handing your assignment late).
3. Method of submission: You are to submit your assignment using D2L [help link]. Make sure that you [check the contents of your submitted files] (e.g., is the file okay or was it corrupted, is it the correct version etc.). It's your responsibility to do this! (Make sure that your submit your assignment with enough time before it comes due for you to do a check).
4. Identifying information: All assignments should include contact information (full name and student ID number) at the very top of your program in the class where the 'main()' function/method resides.
5. Collaboration: Assignments must reflect individual work, group work is not allowed in this class nor can you copy the work of others.  For more detailed information as to what constitutes academic misconduct (i.e., cheating) for this course please read the following [link].
6. Execution: programs must run on the computer science network running Python 3.x. If you write you code in the lab and work remotely using a remote login program such as Putty or SSH. If you choose to install Python on your own computer then it is your responsibility to ensure that your program will run properly here. It's not recommended that you use an IDE for writing your programs but if you use one then make sure that you submit your program in the form of text ".py" file or files
7. Use of pre-created Python libraries: unless otherwise told you are to write the code yourself and not use any pre-created functions from the Python libraries. For this assignment acceptable functions include: print(), input() and likely str().