Prison Break

A final game project for CMPT 276 Fall 2025. A 2D-grid maze game where the player must escape from a prison by collecting keys. The player must avoid guards and security cameras to avoid a negative score or losing the game.

Credits:

The following members contributed to the development of this project:

• Samuel Ye (sya191)
• Kyle Wong (kkw29)
• Kirstin Horvat (kbph05/kbh5)

Please see the Documents folder for more information about the project's development.

Phase 3 Testing & Coverage Guide

This README provides complete instructions for compiling the game, running it, executing tests, generating code coverage, and producing required artifacts (JAR file + Javadocs).

The project uses:

• Java 17
• Maven 3.9+
• JUnit 5
• TestFX (UI tests)
• JaCoCo 0.8.12 (coverage)
• JavaFX 23 SDK

1. Prerequisites

Ensure the following are installed and available on your PATH:

Run: java -version mvn -version

2. How to Compile the Project

First, ensure you are in the correct directory location:

CMPT276F25_Group18\prison_break

To compile the game source code:

Run: mvn clean compile

This compiles main sources only (does not run any tests).

3. How to Run the Full Test Suite

Functional (black-box) + structural (white-box) tests:

Run: mvn test

This executes the JUnit unit tests, TestFX UI tests and the JaCoCo coverage tool

4. Generate the JaCoCo Coverage Report

After running tests:

Run: mvn jacoco:report target/site/jacoco/index.html

The Jacoco coverage report should then automatically open within a browser.

5. How to Run the Game

After a successful compile:

Run: mvn exec:java -Dexec.mainClass=group18.Main

This launches the JavaFX application.

6. How to Generate the Executable JAR

To build the game’s JAR file:

Run: mvn package

The JAR will be located in: prison_break\target\

7. How to Generate Javadocs

Generate project documentation with:

Run: mvn javadoc:javadoc

The Javadoc HTML files will appear in: prison_break\target\reports\apidocs

8. How to Execute the JAR file

After generating the JAR file:

Run: java -jar target/prison_break-1.0.jar

NOTE: JavaFX 23 SDK MUST BE INSTALLED FOR YOUR PLATFORM (link: https://gluonhq.com/products/javafx/)

If the first command does not work, try pointing path directly to the JavaFX SDK folder:

Run: java --module-path [INSERT PATH HERE]/javafx-sdk/lib --add-modules javafx.controls,javafx.fxml -jar target/prison_break-1.0.jar

9. How to Open the Javadocs

After generating the javadoc files:

Run: start target/reports/apidocs/index.html

The javadocs should open automatically in a browser