Due: Sunday 27 October 2024, 11:59PM AEST

This assignment is worth 20% of your final assessment

IMPORTANT: You are only allowed to implement Assignment 3 Requirements in this assignment. Do not include any other features, otherwise mark deductions will be applied.

IMPORTANT: You must use the template we have provided and only the JavaFX library for your GUI. You may not use any other GUI library.

Task Overview

In assignment 3, you will extend and review a given codebase for the Pac-Man game. Please note that your goal is to extend and maintain this implementation.  This means that you will add features to the existing implementation by using OO design principles and appropriate design patterns that you have learned throughout this UoS. Please ensure that you do this without breaking the existing implementation or using unnecessary ’hacks’ .

You are not required to correct the existing design of the implementation - you must retain the existing design wherever changes are not required and you will be penalised for making changes without cause (for example, replacing the given implementation with your own assignment 2 code).  The idea here is that you work with the existing design rather than against it, and minimise required changes to the existing structure (reasonable, limited-scope refactoring to support extensions is encouraged). To be clear, this means that you are not required to correct the given codebase to align with A2 requirements. You must provide the following features in your implementation with at least 3 design patterns (that have not been used in the given scaffold/Assignment 2). You will find a detailed description of each feature in a later section.

• Additional Ghost Types: There are now 4 ghost types, each with their own pre-assigned corner of the map for SCATTER mode and a different strategy for chasing Pac-Man in CHASE mode.

• Power Pellet: When Pac-Man eats a power pellet, Pac-Man will temporarily gain the ability to eat ghosts and can earn additional points from eating them.

• FRIGHTENED mode: When Pac-Man eats a power pellet, the ghosts temporarily enter into FRIGHTENED mode, where they will become slower and move randomly through the maze. If Pac-Man collides with a ghost in FRIGHTENED mode, the ghost will die and be re-spawn in SCATTER mode.

What we provide to you

In the code scaffold given to you, you will be able to find:

• JSON file: A configuration file (config . json).

• Map files:  A map text file (map.txt) for ASM2 and a map text file (new-map.txt) for ASM3.

• Code Scaffold: A scaffold codebase that you must use to extend with the requested features.

– You must use this scaffold for Assignment 3. You are only allowed to make changes to it necessary for the implementation of the requested features.

– The scaffold is runnable in its current state. Do not break it in your implementation.

– You must use JavaFX for your GUI - no other GUI library is allowed.

– You will need to update the scaffold codebase to use the new-map.txt file, once you have implemented the relevant features (e.g. the different ghost types, power pellets).

– Please do not modify the configuration and map text files.

• Sprites: You will be using these to render the game entities. These can be found in src/main/resources.

• Font: The font used to display the game messages and score. This can be found in src/main/resources.

Note, to download the scaffold, open the File Explorer on the EdStem code submission page, and right-click to Download all files.

IMPORTANT: You can only implement the above features in your assignment and you should not include any other features. Mark deductions will be applied otherwise.

Report Task (10 marks)

For your report, you must include the following sections:

1. Code Review Complete a code review of the existing codebase provided to you, which in- cludes:

•  discussion on the use of OOP or design principles (be specific to the given code, a UML snippet needs to be provided)

– NOTE: You do not have to discuss all design principles, only the ones you find rele- vant to the scaffold.

•  discussion on the use of design patterns (be specific to the given code, a UML snippet needs to be provided)

– You should discuss all design patterns that have been implemented in the scaffold codebase, excluding the use of the Builder pattern.

– Please provide a UML snippet for each design pattern you discuss, including its par- ticipants

• discussion on the documentation (e.g., comments, etc.)

•  discussion on how easy or difficult the given codebase was to extend.  In particular, take into account how the above points affected your ability to achieve the required function-

ality in this assignment.

2. Feature Extension.  Discuss your extension of the codebase and implementation of the re- quested features.

•  Describe the actual changes (including extensions) you have made in your code and ratio- nalise that the changes are necessary.

•  Document at least three different GoF design patterns used in your assignment, ensuring they are among those covered in the course.  Justify their use based on SOLID and/or GRASP principles specific to your code, and include a UML diagram for each pattern showing the corresponding participants.

- While you may include patterns from Assignment 2 (Factory, Singleton, Observer, Command) as part of your implementation, they do not count toward the required three patterns.

- Ensure the new features utilise different design patterns from those in A2. (i.e. none of the features require the use of design patterns from A2)

•  Reflect on your extension design, highlighting any outstanding issues or improvements or discussing your impact on the extensibility of the code

3.  Any acknowledgement/reference required.

Notes:

•  When creating your UML diagrams, includeonly the classes/interfaces and relationships that are directly relevant to your discussion. Additionally,  you may omit methods/attributes in classes that are unrelated to your current discussion point. For example, when explaining how a design pattern is used to implement a feature, display only the methods and attributes that are essential to that particular implementation.

•  You must ensure your diagrams are readable/understandable to the marker (e.g. avoid crossing lines where possible). If your marker cannot understand your diagram, zero marks will be given for the corresponding section.

•  Your marker will not download your PDF locally, so please ensure your diagrams are readable in Canvas.  Please note the maximum amount you can zoom in on Canvas is 200%. If your diagrams are not clearly readable at 200% zoom, please use a higher screen quality when ex- porting it from your UML tool of choice, or export it as a PDF and combine it with your report PDF.