User Manual - felix-elugbaju/Group_B_VirtualEscapeRoom GitHub Wiki
User Manual
Table of Contents
Build instructions
As specified in the README
In order to compile the program:
Open the command prompt
Navigate to the root directory of the project
Enter "make executable" or "make all" (without the quotes) into the command line
Navigate to the bin directory by entering "cd bin"
The application may now be run by entering "./VER.exe" into the command line
Introduction
You will play as a person locked in a room filled with interesting objects (tables, letters, clocks, graffiti, etc.) that you can freely interact with. Each object and its distinct features conceal puzzles, riddles, and hidden messages in the room. You will have to examine objects, gather hints, and piece clues together in order to gain access to a key or code that will open the lock on the door. The key objective of the game is to overcome diverse challenges in order to leave the room through an unlocked door.
Opening one door will lead to a different room with a distinctively different set of objects, interactions, and challenges. Challenges in each room are more difficult than the previously cleared rooms. The game will end when you solve all the mysteries in all rooms and leave through the grand door of the final room.
The game is text-based, and is played by entering commands, sometimes followed by arguments, in the Command-Line Interface (CLI). Some helpful commands will be shown at the beginning of the game. You can try to discover your own commands or ask for help with common commands anytime by typing "help".
Moving Stages & How to Escape
You will need to solve the room's puzzles in order to proceed to the next room, or finish the game in the case of the final room. When entering a room initially, you'll see a description of the room, as well as some items in that room. You can interact with the items in the room by typing commands. Typical commands can be found by typing "help" (without the quotes) in the Command-Line. Commands consist of either one or two words.
Type "look around" to see all interactable objects around you. An object with the description "a wooden table" can be interacted with using the last word "table" as the tag. So "examine table" is a valid command. In the case of descriptions with underscored words, e.g., "a silver_door", the entire underscored word "silver_door" must be used. So users trying to examine that door must now use "examine silver_door", for example.
To escape a room, you'll need to acquire a key, which will be hidden behind puzzles. Instructions for puzzles will appear when the puzzle is triggered. Rooms will require multiple puzzles to be solved in order to get a key. To move from stage to stage you must perform the actions (in this order): get
key, use
key, open
door, go
stageX, where "key" is the name of the particular key you receive in the stage, door is the type of door that you see in the stage, and stageX is the stage you wish to go to. All the stages are visible by the map
command.
Menu navigation
Object interaction
You can interact with the items with each of the following commands:
-
examine
: Show detailed info about the object. Note that an object may have a two word separated by an underscore i.e silver_key counts as a single object. -
go
: Moves to a room (if possible) -
get
: Moves an item into your bag -
use
: Try to make use of an object in your bag -
open
: Attempt to open a door -
look around
: Display list of items in the current room -
help
: Display a list of available commands and descriptions -
bag
: Display the current contents of your bag -
map
: Display a map of the virtual Escape Room world -
quit
: Quit playing the game
In addition, there are hidden commands that are revealed after you examine particular objects.
Solving Puzzles
Puzzles are sections of the game that are triggered by room and object-specific actions. Once a puzzle is triggered, an attempt can be made at a solution. Multiple attempts can be made if a previous attempt is unsuccessful. Each puzzle has its own set of commands necessary to interact with it. In addition, the user may ask for a hint if they get stuck, but be warned! Every hint used when solving the puzzle will reduce your reward upon completion of the stage. Solve all puzzles in all three stages to win!
Be prepared to start your own interactive journey!!