Software Maintenance Coursework

Name: Japhia Loo Hyean-Shyn
ID: 20129351
Note: MacOS user, therefore there will be extra files when you unzip a file that was compressed by MacOS device. They will be named _MACOSX, please ignore them.

How to compile and run code

1. Have IntelliJ installed on your device.
2. Unzip the file named LooJaphia_IntelliJ_19.zip in the project folder located in the same directory as this README.md file.
3. Launch IntelliJ and on the menu screen, click on open and select the file named LooJaphia_IntelliJ_19 in the same directory as this README.md file.
4. After you select it, the project will appear.
5. There will be two directories in the project, one being a _MACOSX folder, you can ignore that file.
6. Click into the directory with the name LooJaphia_IntelliJ_19 and build the project.
7. An error will pop up if you do not have the proper language level for the project but IntelliJ will resolve the error itself.
8. Click on the run program button.
9. Click load maven build files pop up on the bottom right of the screen.
10. Run the game again.
11. Enjoy the game!

JavaDocs path

"/COMP2042LooJaphia/javadocs/index.html"

Features implemented and working properly

1. Added a menu scene to the game where user can set background color, choose difficulty and enter their name and button to log in and move to game scene.
2. Difficulty levels to the game.
3. Added permanent high-score list stored in file that the program will retrieve according to user playing.
4. Added retry and menu button at the end of the game.
5. Bug fixes for random values spawning when no cells have moved or merged.
6. Bug fixes for values double merging values in a single move.
7. Pop-up window for score when player runs out of moves in game.
8. Bug fixes for cell overflowing out of the cell after hitting value 1024 and above.
9. Added a logo to the game that will be visible when user launches the program.

Features implemented and not working properly

All new features implemented are working properly to my knowledge.

Features not implemented

1. JUnit Testing : I did not have enough time to fully understand and implement JUnit test to my project as well as not being able to find meaningful tests to be done for this particular program as most of the methods require the game to be launched and tested logically.

New classes

1. Move
2. Check
3. StartGame
4. User

Modified classes

1. Account
2. Cell
3. EndGame
4. GameScene
5. Main
6. TextMaker

Problems faced

1. Took a very long time to understand the code before being able to change or refactor anything.
2. Was not able to run the program due to outdated version of intellij.
3. Faced issues with writing user's name and high-score to file due to uncontrolled use of static variables.
4. Had issues with compiling certain classes for JavaDocs as I did not know that non-public methods will not be generated by JavaDocs.