initial push of skeleton code from tillie A8

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+    "java.project.referencedLibraries": [
+        "lib/**/*.jar",
+        "guava-31.1-jre.jar"
+    ]
+}

Item.java

@@ -0,0 +1,21 @@
+/**
+ * The item class creates items that have names, descriptions, and (if they can only be used a set number of times)
+ * sets their limited use and how many times they can be used. 
+ * @author tillie
+ */
+public class Item {
+    String name;
+    String shortDesc;
+
+
+    public Item(String name, String shortDesc) {
+        this.name = name;
+        this.shortDesc = shortDesc;
+    }
+    public Item(String desc) {
+        this.name = desc;
+        this.shortDesc = desc;
+    }
+
+
+}

Place.java

@@ -0,0 +1,79 @@
+import java.util.ArrayList;
+
+/**
+ * The place class creates the rooms that the player can exist in. These places will be added to the map. The places
+ * have a name, descriptions, and a boolean stating if it needs a key to be entered. Each place also has an 
+ * inventory that can be added to and taken away from. 
+ */
+public class Place {
+    public ArrayList<Item> inventory; // an arraylist of interactable objects within a given place
+    public String name;
+    public String shortDesc;
+    public String longDesc;
+    public String needsKey;
+    public boolean explored;
+
+
+    public Place() {
+        this.inventory = new ArrayList<Item>(); 
+        this.name = "name";
+        this.shortDesc = "shortDesc";
+        this.longDesc = "longDesc";
+        this.needsKey = "none";
+        this.explored = false;
+    }
+
+
+    public Place(String name, String shortDesc, String longDesc, String needsKey) {
+        this.inventory = new ArrayList<Item>(); 
+        this.name = name;
+        this.shortDesc = shortDesc;
+        this.longDesc = longDesc;
+        this.needsKey = needsKey;
+        this.explored = false;
+    }
+
+    public Place(String name, String shortDesc, String longDesc, String needsKey, boolean explored) {
+        this.inventory = new ArrayList<Item>(); 
+        this.name = name;
+        this.shortDesc = shortDesc;
+        this.longDesc = longDesc;
+        this.needsKey = needsKey;
+        this.explored = explored;
+    }
+
+    /**
+     * a getter method that returns the name of the place
+     * @return a String containing the name of the place
+     */
+    public String getName() {
+        return(this.name);
+    }
+
+    /**
+     * a getter method that returns the color of the key needed to enter a room.
+     * @return a string containing the color of the key needed to enter a place. 
+     */
+    public String getKeyColor() {
+        return(this.needsKey);
+    }
+
+   /**
+    * a method that allows an item to be added to the place's inventory
+    * @param item an item that will be added to the place's inventory
+    *note: there is a check that makes sure an item won't be added to a place's inventory twice.
+    */
+    public void addItem(Item item) {
+        this.inventory.add(item);
+    }
+
+    /**
+     * a method that removes an item from the place's inventory.
+     * @param item an item that will be added to the place's inventory. 
+     */
+    public void removeItem(Item item) {
+        this.inventory.remove(item);
+    }
+
+
+}

README.md

@@ -10,9 +10,16 @@
 
 ## Additional Reflection Questions
  - What was your **overall approach** to tackling this project?
+
  - What **new thing(s)** did you learn / figure out in completing this project?
+
  - Is there anything that you wish you had **implemented differently**?
+
  - If you had **unlimited time**, what additional features would you implement?
+
  - What was the most helpful **piece of feedback** you received while working on your project? Who gave it to you?
+
  - If you could go back in time and give your past self some **advice** about this project, what hints would you give?
+
  - _If you worked with a team:_ please comment on how your **team dynamics** influenced your experience working on this project.
+

rubric.md

@@ -1,48 +1,50 @@
 ## Front-End Design (10 pts)
 
-_____ 2 pts: Game has a **robust, understandable text-based interface** that allows the player to control their movement through the game.  Player should be able to enter any command at any time, and if it makes sense in the current context it will be carried out.
+**YES** 2 pts: Game has a **robust, understandable text-based interface** that allows the player to control their movement through the game.  Player should be able to enter any command at any time, and if it makes sense in the current context it will be carried out.
 
 _____ 2 pts: Submission includes a **cheat sheet** (`cheatsheet.md`) documenting all of the available commands, as well as a **description of the layout** of your game world's underlying physical layout; this can be described in words, or included as a separate image file if you prefer to sketch a map by hand.  If your game includes **challenges** that must be overcome to win, also describe them here.
 
-_____ 2 pts: Storyline driving the game is **engaging**, and individual elements of play make sense within the context of the story.
+**YES** 2 pts: Storyline driving the game is **engaging**, and individual elements of play make sense within the context of the story.
 
-_____ 2 pts: Game has **multiple possible paths / outcomes** (i.e. gameplay depends on player's choices and is not the same every time).
+**YES\*** 2 pts: Game has **multiple possible paths / outcomes** (i.e. gameplay depends on player's choices and is not the same every time).
 
-_____ 1 pt: Gameplay supports **reversible moves** where reasonable (e.g., if you pick up an object, you should be able to put it back down again later, possibly in a different place; if you go north then you should be able to return to the previous location by going south unless something has blocked your return path).
+\* The game has one "win path" but it is possible to wander around lost/confused for a while without conequence before finding the win conditions. Also, there's the basement which is just there for fun and has absolutely 0 effect on the game's final outcome. 
 
-_____ 1 pt: Some paths through the game have **restricted access** until the player has completed a task or acquired a specific item (i.e. a key to open a door, etc.).
+**YES** 1 pt: Gameplay supports **reversible moves** where reasonable (e.g., if you pick up an object, you should be able to put it back down again later, possibly in a different place; if you go north then you should be able to return to the previous location by going south unless something has blocked your return path).
+
+**YES** 1 pt: Some paths through the game have **restricted access** until the player has completed a task or acquired a specific item (i.e. a key to open a door, etc.).
 
 
 ## Back-End Design (10 pts)
 
-_____ 2 pts: Selected classes(s) are **effective, efficient** at supporting the desired operations and program behavior.
+**YES** 2 pts: Selected classes(s) are **effective, efficient** at supporting the desired operations and program behavior.
 
 _____ 2 pts: Design justification includes a discussion of at least one (reasonable) **alternative design** that could have been used, and the reasons why you decided against this alternative.
 
-_____ 2 pts: The project makes effective use of **Java built-in classes** whenever they are appropriate.
+**YES** 2 pts: The project makes effective use of **Java built-in classes** whenever they are appropriate.
 
-_____ 2 pts: The project's design is **extensible** (i.e. someone else could pick up where you left off, adding on or modifying the game without requiring a total rewrite).
+**YES** 2 pts: The project's design is **extensible** (i.e. someone else could pick up where you left off, adding on or modifying the game without requiring a total rewrite).
 
-_____ 2 pts: Submission includes an **architecture diagram** describing the relationships between all classes.
+**YES** 2 pts: Submission includes an **architecture diagram** describing the relationships between all classes.
 
 
 ## General Items (10 pts):
-_____ 4 pts: Program compiles without errors or warnings.
+**YES** 4 pts: Program compiles without errors or warnings.
 
-_____ 2 pts: Executes fully & consistently without crashing (exception/freeze).
+**YES** 2 pts: Executes fully & consistently without crashing (exception/freeze).
 
-_____ 2 pt: Complies with style guidelines (missing items 1 pt each):
+**YES** 2 pt: Complies with style guidelines (missing items 1 pt each):
 
-      _____ Classes & class members all have Javadoc header comments.
+      **YES** Classes & class members all have Javadoc header comments.
 
-      _____ Clear and consistent indentation of bracketed sections.
+      **YES** Clear and consistent indentation of bracketed sections.
 
-      _____ Adheres to Java conventions on naming & capitalization.
+      **YES** Adheres to Java conventions on naming & capitalization.
 
-      _____ Methods & variables all have clear and accurate names.
+      **YES** Methods & variables all have clear and accurate names.
 
-      _____ Methods avoid confusing side effects.
+      **YES** Methods avoid confusing side effects.
 
 _____ 1 pt: All required files included with submission (including completed checklist file).
 
-_____ 1 pt: `readme.md` contains your reflection on the project and responses to all prompts .
+**YES** 1 pt: `readme.md` contains your reflection on the project and responses to all prompts .