Organizing Repository

README.md

@@ -1,13 +1,16 @@
 # SER-225 Fall 2021 Team A2
+
 #### [Original GitHub Link](https://github.com/LittleTealeaf/SER-225-Team-A2)
 
 [//]: # (Welcome to the FAll 2021 Team A2's SER-225's repository! If you are reading this from the text file, it is advised to either enable markdown rendering, view on your own repository or fork, or click the link above to view the published repository.)
 
 ## What is this project?
+
 *Taken from the original archive provided*
->This is a game created for Quinnipiac's SER225 Agile Development class. Students will be paired up in teams for an entire semester, and will use agile development sprints to work further on this game. This usually involves adding features and fixing bugs (I'm sure there are bugs...)
+> This is a game created for Quinnipiac's SER225 Agile Development class. Students will be paired up in teams for an entire semester, and will use agile development sprints to work further on this game. This usually involves adding features and fixing bugs (I'm sure there are bugs...)
 
 ## How do I use this project?
+
 This is a standalone project, so running this program in either Eclipse or Intellij will work. However, much of this project has been created in IntelliJ, and setting up the project's java will be much easier in IntelliJ. You can download the Community Version of IntelliJ [here](https://www.jetbrains.com/idea/).
 
 ### Java 17
@@ -18,14 +21,17 @@ If you haven't gotten java recently, you probably are running an out-dated java
 The image above is showing the java version selector under the "project settings" (Look under `File`). Additionally, make sure that `Language Level` is also set to the most recent language level.
 
 ### Running the Project
+
 There are two main classes used to run the project. First, and the most important, is the `Game.java` class. This can be found at [`src/Game/Game.java`](src/Game/Game.java). Running the main class will launch the full game.
 
 Additionally, there is a level editor that allows you to easily edit each level individually. To run this, you can run the main method in [`src/MapEditor/MapEditor.java`](src/MapEditor/MapEditor.java)
 
 ## Documentation
-Ok, so you've probably been shown the original documentation link. Additionally, we have the original documentation located at [/docs](docs). Be warned, be very warned. We changed A LOT during our work here, so the documentation can and will be wrong. Specifically, when it comes to the following aspects of the game, assume that the documentation is of very little specific use. However, feel free to read it to understand the general basis of the project.
- - Menu Screen, Level Loading, Screen Manager
- - Player class
- - Game Loop
+
+Ok, so you've probably been shown the original documentation link. Additionally, we have the original documentation located at [/docs_archive](docs_archive). Be warned, be very warned. We changed A LOT during our work here, so the documentation can and will be wrong. Specifically, when it comes to the following aspects of the game, assume that the documentation is of very little specific use. However, feel free to read it to understand the general basis of the project.
+
+- Menu Screen, Level Loading, Screen Manager
+- Player class
+- Game Loop
 
 That being said, many of the changes done have been documented in hopes to explain the madness. These comments are done in a way where in IntelliJ, hovering over any call should display a tooltip that describes that method, or at least if that method was documented.

Team A2/README.md

@@ -1,4 +1,5 @@
 # Team A2
+
 For our project, one of the tasks that we were required to do was to create and run test cases for each of our bug fixes or enhancements. We first used a `.docx` format, as seen in the [User Stories](User%20Stories) folder.
 
 However, in order to allow both the ease of viewing on any device, and a nice display on our github repository, we later switched to a `.md` format. We converted all previous test cases to the new format, and placed everything in [Test Cases](Test%20Cases)

Team A2/Test Cases/Test Case SCP-01.md

@@ -1,4 +1,5 @@
 ### Test Case Information
+
 | TEST CASE ID | SCP-1 |
 | :--- | :--- |
 | Owner of Test | Nicholas Tourony |
@@ -21,6 +22,7 @@
 |9|Hold shift while holding the right arrow key|The character moves right at a fast speed|P|
 
 ### Test Completion
+
 - **Tester**: Thomas Kwashnak
 - **Date of Test**: 11/7/2021 (Late, marked passed as task was submitted)
 - **Test Result**: Passed

Team A2/Test Cases/Test Case SCP-03.md

@@ -1,4 +1,5 @@
 ### Test Case Information
+
 | TEST CASE ID | SCP-3 |
 | :--- | :--- |
 | Owner of Test | Jacob Conrad |
@@ -18,6 +19,7 @@
 |3c|Receive Enemy Attack (if it has one)|The player should die|Pass|
 
 ### Test Completion
+
 - **Tester**: Thomas Kwashnak
 - **Date of Test**: 10/12/2021 (Scrum Sprint 1 enemy)
 - **Test Result**: Passed

Team A2/Test Cases/Test Case SCP-04.md

@@ -1,4 +1,5 @@
 ### Test Case Information
+
 | TEST CASE ID | SCP-4 |
 | :--- | :--- |
 | Owner of Test | Ty Hutchison |
@@ -15,8 +16,8 @@
 |3|Go through the tutorial and learn how to play the game|User completes tutorial and properly knows how to play the game||
 |4|Return ot the main menu after the level is complete|After the gold block is hit return to the main menu|F (Functionality Changed)|
 
-
 ### Test Completion
+
 - **Tester**: Thomas Kwashnak;
 - **Date of Test**: (Late Copy/Test 11/7/2021)
 - **Test Result**: F (Specific test failed because implementation and design has changed since creation of test case)

Team A2/Test Cases/Test Case SCP-05.md

@@ -1,4 +1,5 @@
 ### Test Case Information
+
 | TEST CASE ID | SCP-5 |
 | :--- | :--- |
 | Owner of Test | Ty Hutchison |
@@ -16,6 +17,7 @@
 |4|Return to the main menu after level is completed|After the gold block is hit, returns to the main menu|F (Change in Design)|
 
 ### Test Completion
+
 - **Tester**: Thomas Kwashnak
 - **Date of Test**: 11/7/2021 (Late, done during copy)
 - **Test Result**: P (Only fails were not game-breaking)

Team A2/Test Cases/Test Case SCP-06.md

@@ -1,4 +1,5 @@
 ### Test Case Information
+
 | TEST CASE ID | SCP-6 |
 | :--- | :--- |
 | Owner of Test | Nicholas Tourony |
@@ -15,8 +16,8 @@
 |3|Restart the game and use the level selection in the main menu to select level 5|The player is loaded into the fifth level|P|
 |4|Play and beat the 5th level|The player can beat the fifth level, and it has a noticeable difference from the first level|P|
 
-
 ### Test Completion
+
 - **Tester**: Thomas Kwashnak
 - **Date of Test**: 10/27/2021
 - **Test Result**: Pass

Team A2/Test Cases/Test Case SCP-07.md

@@ -1,4 +1,5 @@
 ### Test Case Information
+
 | TEST CASE ID | SCP-7 |
 | :--- | :--- |
 | Owner of Test | Jack Handy |
@@ -17,6 +18,7 @@
 |5|Repeat actions 1 through 4 for each additional level|Tasks 1-4 have the correct expected result for each level|Pass for levels 6 and 7|
 
 ### Test Completion
+
 - **Tester**: Thomas Kwashnak
 - **Date of Test**: 10/27/2021
 - **Test Result**: Pass (*Levels 6-7*)

Team A2/Test Cases/Test Case SCP-08.md

@@ -1,4 +1,5 @@
 ### Test Case Information
+
 | TEST CASE ID | SCP-8 |
 | :--- | :--- |
 | Owner of Test | Jacob Conrad |
@@ -12,8 +13,8 @@
 |:---:| :---        |    :----  | :---: |
 |1|Navigate to the Resources folder and open Dog.png | The Dog.png file is inside the resources folder and has the boss design sprite sheet inside it|Pass|
 
-
 ### Test Completion
+
 - **Tester**: Thomas Kwashnak
 - **Date of Test**: 10/27/2021
 - **Test Result**: Pass

Team A2/Test Cases/Test Case SCP-09.md

@@ -19,6 +19,7 @@
 |6| The player touches the boss | The player dies |Pass|
 
 ### Test Completion
+
 - **Tester**: Thomas Kwashnak
 - **Date of Test**: 11/10/2021
 - **Test Result**: Passed

Team A2/Test Cases/Test Case SCP-10.md

@@ -1,4 +1,5 @@
 ### Test Case Information
+
 | TEST CASE ID | SCP-10|
 | :--- | :--- |
 | Owner of Test | Ty Hutchison|
@@ -15,8 +16,8 @@
 |3| User will read the Narrative Screen | User will read the narrative backstory and understand the games background | Pass |
 |4| User will complete the rest of the game | The User will be able to complete the rest of the game and complete the backstory | Pass (inferred) |
 
-
 ### Test Completion
+
 - **Tester**: Thomas Kwashnak
 - **Date of Test**: 11/9/2021
 - **Test Result**: Passed

Team A2/Test Cases/Test Case SCP-11.md

@@ -1,4 +1,5 @@
 ### Test Case Information
+
 | TEST CASE ID | SCP-11 |
 | :--- | :--- |
 | Owner of Test | Thomas Kwashnak |
@@ -18,6 +19,7 @@
 |6|Click on the "Start Game"|Clicking on "start game" begins the game|P|
 
 ### Test Completion
+
 - **Tester**: Thomas Kwashnak
 - **Date of Test**: 11/7/2021 (Completed during copying)
 - **Test Result**: Fail (Clicking back arrow does not navigate user back to the main menu)

Team A2/Test Cases/Test Case SCP-15.md

@@ -1,4 +1,5 @@
 ### Test Case Information
+
 | TEST CASE ID | SCP-15|
 | :--- | :--- |
 | Owner of Test | Ty Hutchison|
@@ -17,6 +18,7 @@
 |5| Check base volume | The User will be able to comfortable play the game without having the music too loud | Pass |
 
 ### Test Completion
+
 - **Tester**: Thomas Kwashnak
 - **Date of Test**: 11/9/2021
 - **Test Result**: Passed

Team A2/Test Cases/Test Case SCP-16.md

@@ -1,4 +1,5 @@
 ### Test Case Information
+
 | TEST CASE ID | SCP-16 |
 | :--- | :--- |
 | Owner of Test | Nicholas Tourony |
@@ -16,6 +17,7 @@
 |4|Play the game|The user is able to play the game successfully without any sound|Pass|
 
 ### Test Completion
+
 - **Tester**: Thomas Kwashnak
 - **Date of Test**: 10/27/2021
 - **Test Result**: Pass

Team A2/Test Cases/Test Case SCP-20.md

@@ -1,4 +1,5 @@
 ### Test Case Information
+
 | TEST CASE ID | SCP-20 |
 | :--- | :--- |
 | Owner of Test | Thomas Kwashnak |
@@ -20,6 +21,7 @@
 |4|Press escape|The options menu is closed and the main menu is showing again|P|
 
 ### Test Completion
+
 - **Tester**: Thomas Kwashnak
 - **Date of Test**: 11/7/2021 (Late, filled during copy of new format)
 - **Test Result**: Passed

Team A2/Test Cases/Test Case SCP-30.md

@@ -1,12 +1,7 @@
 ### Test Case Information
 
 \
-| TEST CASE ID | SCP-30 |
-| :--- | :--- |
-| Owner of Test | JACOB CONRAD |
-| Test Name | ADD CHARACTER PREVIEW |
-| Date of Last Revision | 11/9/2021 |
-| Test Objective | Verify that a preview for the user to see when changing their character is in the options screen  |
+| TEST CASE ID | SCP-30 | | :--- | :--- | | Owner of Test | JACOB CONRAD | | Test Name | ADD CHARACTER PREVIEW | | Date of Last Revision | 11/9/2021 | | Test Objective | Verify that a preview for the user to see when changing their character is in the options screen |
 
 ### Procedure
 
@@ -18,8 +13,8 @@
 |4| Press "Green" | The green cat is displayed |Pass|
 |5| Press "Orange" | The orange cat is displayed |Pass|
 
-
 ### Test Completion
+
 - **Tester**: Thomas Kwashnak
 - **Date of Test**: 11/10/2021
 - **Test Result**: Passed (Adding backlog item for finalizing)

Team A2/Test Cases/Test Case SCP-31.md

@@ -1,4 +1,5 @@
 ### Test Case Information
+
 | TEST CASE ID | SCP-31 |
 | :--- | :--- |
 | Owner of Test | Jacob Conrad |
@@ -20,6 +21,7 @@
 |8|Restart the tutorial level|Health should be visible again and be at three hearts (not the previous zero hearts from losing and going to the menu)|Pass
 
 ### Test Completion
+
 - **Tester**: Thomas Kwashnak
 - **Date of Test**: 10/27/2021
 - **Test Result**: Pass

Team A2/Test Cases/Test Case SCP-32.md

@@ -1,4 +1,5 @@
 ### Test Case Information
+
 | TEST CASE ID | SCP-32|
 | :--- | :--- |
 | Owner of Test | Ty Hutchison|
@@ -17,6 +18,7 @@
 |5| Check in game instructions | The User will be able to press 'x' to see in game instructions | Pass |
 
 ### Test Completion
+
 - **Tester**: Thomas Kwashnak
 - **Date of Test**: 11/9/2021
 - **Test Result**: Passed

Team A2/Test Cases/Test Case SCP-33.md

@@ -1,4 +1,5 @@
 ### Test Case Information
+
 | TEST CASE ID | SCP-33 |
 | :--- | :--- |
 | Owner of Test | Nicholas Tourony |
@@ -17,8 +18,8 @@
 |5|Tap the E key really fast while facing left|The fireball attack starts from the character.|P
 |6|Tap the E key really fast while facing right|The fireball attack starts from the character|P
 
-
 ### Test Completion
+
 - **Tester**: Thomas Kwashnak
 - **Date of Test**: 10/27/2021
 - **Test Result**: Passed

Team A2/Test Cases/Test Case SCP-34.md

@@ -1,4 +1,5 @@
 ### Test Case Information
+
 | TEST CASE ID | SCP-34|
 | :--- | :--- |
 | Owner of Test | Ty Hutchison |
@@ -15,8 +16,8 @@
 |3| Find new map tile next to water tile | User will find the new map tile, sand, next to water tiles in game |Passed|
 |4| User will exit the game | The User will properly exit the game |Passed|
 
-
 ### Test Completion
+
 - **Tester**: Thomas Kwashnak
 - **Date of Test**: 11/29/2021
 - **Test Result**: Passed

Team A2/Test Cases/Test Case SCP-35.md

@@ -1,4 +1,5 @@
 ### Test Case Information
+
 | TEST CASE ID | SCP-35 |
 | :--- | :--- |
 | Owner of Test | Thomas Kwashnak |
@@ -44,6 +45,7 @@
 |34|Navigate and run into the bug to die, and hit escape to go back to the main menu|The player dies, and then the main menu is displayed after the player hits escape|P|
 
 ### Test Completion
+
 - **Tester**: Nicholas Tourony
 - **Date of Test**: 11/7/2021
 - **Test Result**: Passed

Team A2/Test Cases/Test Case SCP-41.md

@@ -1,4 +1,5 @@
 ### Test Case Information
+
 | TEST CASE ID | SCP-41 |
 | :--- | :--- |
 | Owner of Test | Thomas Kwashnak |
@@ -18,6 +19,7 @@
 |6|Beat the first level|The first level is beatable, the "level complete" dialogue displays, and after a few seconds the user is taken to the next level|P|
 
 ### Test Completion
+
 - **Tester**: Nicholas Tourony
 - **Date of Test**: 11/7/2021
 - **Test Result**: Passed

Team A2/Test Cases/Test Case SCP-44.md

@@ -1,4 +1,5 @@
 ### Test Case Information
+
 | TEST CASE ID | SCP-44 |
 | :--- | :--- |
 | Owner of Test | Thomas Kwashnak |
@@ -23,6 +24,7 @@
 |11|Attempt to walk off the edge on the right of the map|The player hits an invisible barrier preventing them from leaving the screen|Pass|
 
 ### Test Completion
+
 - **Tester**: Nicholas Tourony
 - **Date of Test**: 11/8/2021
 - **Test Result**: Passed

Team A2/Test Cases/Test Case SCP-45.md

@@ -1,4 +1,5 @@
 ### Test Case Information
+
 | TEST CASE ID | Test Case SCP-45 |
 | :--- | :--- |
 | Owner of Test | Thomas Kwashnak |
@@ -20,6 +21,7 @@
 |8|Navigate to the platform and aim to land on the left edge of the moving platform|Player does not die when hitting the corner/size of the moving platform|P|
 
 ### Test Completion
+
 - **Tester**: Nicholas Tourony
 - **Date of Test**: 11/7/2021
 - **Test Result**: Passed