MPG-MPC-PacMan

Jakub Lepik | 239122

A simple 3D Pac-Man-style game built fully from scratch in modern C++ and raw OpenGL 💻🔥. The game uses the stb_image.h library for image loading 📸, SDL3_mixer for basic sound effects 🔊, and a custom font rendering library, glfreetype, which I modified to render TrueType fonts using FreeType in 3D 🎨.

This repository provides compiled binary for Windows, which you can download from the latest release, or you can follow the Build Instructions to build the game from source! 😎

💥 Features:

• 🧱 Tile-based world
  • Smooth, rounded corners for cleaner-looking walls 😎
• 👻 Basic ghost AI: Random movement with an A* algorithm for pathfinding
• 🔊 Simple sounds powered by SDL3_mixer
• 🎮 Custom game loop, comprehensive input handling & game logic
• 🟡 Core Pac-Man mechanics: Implements all essential gameplay elements like pellet collection, ghost collisions, and score tracking — except for power pellets.
• 💀 Eating and death animations: Includes visual effects for eating pellets and the player's death sequence.
• 🅰️ FreeType font rendering: Renders fonts both in 3D and 2D, allowing for dynamic and detailed text presentation in the game.
• 📷 Dynamic camera system with options to switch to:
  • Free movement
  • Chasing player
  • Full animated board overview
• 📜 Simple menu UI: Allows pausing and game mode selection (Sandbox or Normal)
• 🌍 World sphere texture based on image taken by ESA Euclid satellite
• ⚡ Increasing difficulty: The speed of the game and ghosts increases with each level, adding more challenge as you progress! 🎮

🎥 Video Showcase

Check out a gameplay video showcasing the core mechanics and features of PacMan3D in action if you are not going to try the game yourself! 🎥✨

🚀 Release

If you're using a Windows machine, you can try out PacMan3D right away! The latest release version is available in the releases section of the repository. You can download either the compiled binaries or the source code it was built on. Follow the instructions in the Build Instructions section to build the game from source.

▶️ To run the game:

1. Download the binary or source from the releases section.
2. If you downloaded the binary, simply extract the ZIP file 📂.
3. Inside the extracted folder, run the MPG-PacMan.exe to start the game! 🎮😎

🎮 Controls:

• ⬆️ W: Move up
• ⬅️ A: Move left
• ⬇️ S: Move down
• ➡️ D: Move right
• 🎥 C: Change camera mode (free movement, chasing player, or overview)
• 🖱️💫 Mouse Movement: Navigate the menu and interact with the game
• 🖱️✨ Mouse Click: Select menu options
• 🖱️🔄 Left Mouse Click + Drag: Adjust camera position
• 🖱️🔁 Right Mouse Click + Drag: Adjust camera rotation
• 🖱️🎯 Mouse Wheel: Zoom in and out

🏗️ Build Instructions

The recommended way to build the project is by using Visual Studio on a Windows machine:

The build process has been simplified using custom CMake configurations and LFS. All build and runtime dependencies, including core assets like fonts, textures, and libraries such as NupenGL and SDL3_mixer, are stored in LFS. By simply cloning the repository, these assets will automatically be downloaded, extracted, and linked during the CMake configuration, making the process seamless with minimal setup required. 🚀

1. Clone the repository:
   • Either download the source from releases section or get the latest source by cloning this repository:

     git clone https://github.com/kubikulek231/MPC-MPG-PacMan

2. Open the project in Visual Studio:
   • Open Visual Studio and use the "Open Local Folder" option to open the cloned repository directory.
   • Visual Studio will automatically detect the CMake configuration and generate the necessary build files using Ninja 🛠️.
3. Choose the configuration and build:
   • Once CMake is done, select your build configuration (e.g., Debug or Release) in Visual Studio.
   • Click Build to compile the game.
4. Run the game:
   • After the build is complete, run the game directly from Visual Studio or locate the executable in the output directory.

📂 Repository Structure:

• assets - Contains all the external resources used in the game.
  • Fonts, maps, sounds, and textures are included in this directory.
• cmake - CMake configuration files to build the project.
• deps - Dependencies and external libraries required for the project.
  • Includes SDL3_mixer and freetype in Zip archives which are automatically extracted by CMake.
• include - Header files defining the project's interface.
• lib - Third-party libraries used in the project, including glft2 and stb.
• readme_assets - Assets used specifically in the README, such as images or diagrams.
• resources - Miscellaneous resources used in the game, namely game icon.
• src - Main source code for the game, including game logic, rendering, and more.
• texture_enhance - Python utils for enhancing and manipulating space textures.

📄 License

📝 Disclaimer: This project is a educational exercise inspired by the classic Pac-Man game. It is not affiliated with or endorsed by Bandai Namco. All original Pac-Man names, characters, and designs are the property of their respective owners.

• All my own code in this repository is released under the MIT License.
• The game icon is in the public domain.
• The world texture is based on an image by ESA Euclid — may be subject to ESA image use policy.
• Three sound effects used in this project are sourced from ClassicGaming.cc — please verify their usage terms before redistribution.
• Third-party libraries (like nupengl, SDL3_mixer, stb_image.h, and glfreetype) are included — please check their individual licenses before distribution.