A JavaFX UI (2D + 3D) for Pac-Man and Ms. Pac-Man

About this project

A JavaFX user interface for my UI-agnostic Pac-Man / Ms. Pac-Man game implementations.

Both games can be played either in 2D-only or in 2D and 3D (full version). In the full version, you can switch during the game between 2D and 3D view by pressing the key combination Alt+3.

How to run the released version

With Java runtime 18+ installed on your computer (Windows):

Download the executable jar file pacman-ui-fx-3d-1.0-shaded.jar from the release folder. Start the application by double-clicking this file in the file explorer.

Without locally installed Java runtime (Windows):

Download the zip file pacman-ui-fx-3d-jlink-1.0-jlink.zip from the release folder. Extract it somewhere and execute file run.cmd in folder bin.

To build the executable by yourself on non-Windows systems, run the steps in the build script manually or create a shell script or whatever. Any help in creating executables for Mac-OS and Linux is appreciated!

How to build locally

Clone repository pacman-basic.
Clone repository pacman-javafx.
cd \path\to\git\pacman-javafx
build.bat

This will

run a Maven build of the pacman-core project (game logic and model),
run a Maven build of the pacman-ui-fx project (2D-only),
run a Maven build of the pacman-ui-fx-3d project (2D+3D),
create an executable jar-file pacman-ui-fx-1.0-shaded.jar (folder pacman-javafx\pacman-ui-fx\target),
create an executable jar-file pacman-ui-fx-3d-1.0-shaded.jar (folder pacman-javafx\pacman-ui-fx-3d\target),
create a zip file pacman-ui-fx-jlink.1.0-jlink.zip (folder pacman-javafx\pacman-ui-fx\target).
create a zip file pacman-ui-fx-3d-jlink-1.0-jlink.zip (folder pacman-javafx\pacman-ui-fx-3d\target).

How to run the locally built versions

If Java runtime 18+ is installed, start the executables jar-files by double-click.
Alternatively, extract the zip-file and execute the run.cmd file as described above.
Or just execute the run.bat / run2d.bat scripts located in the repository root folder.

How to use (full version)

Starting the game and switching game variant:

V Switch between Pac-Man and Ms. Pac-Man (only possible on intro screen)
5 Add credit ("insert coin")
1 Start game

Pac-Man steering:

Pac-Man is steered using the cursor keys. When the dashboard is open, these keys are taken away by the JavaFX widgets. In that case, you can steer Pac-Man using key combination CTRL+cursor key.

General shortcuts: