Livl Pacman

Livl Pac-Man is a free, open source Pacman clone written in C using SDL2 and SDL_mixer.

Table of Contents

• 📦 Prerequisites
  • ⚙️ Installation of SDL2 and SDL2 mixer
    • Linux / WSL
    • MacOS
• 🚀 Usage
• 🎮 How to Play
  • 📝 Pac-Man Rules
  • ⚠️ Potential sound latency issues
• 🧍🏽Project team
• 📝 License

📦 Prerequisites

• CMake
• C compiler (gcc, clang, etc.)
• SDL2 and SDL2_mixer

⚙️ Installation of SDL and SDL Mixer

Please find the SDL2 repository here and the SDL2_mixer repository here. You can also have a look to the official SDL2 documentation.

Linux / WSL

• Using apt

sudo apt-get update
sudo apt-get install -y libsdl2-dev
sudo apt-get install -y libsdl2-mixer-dev

MacOS

• Using homebrew

brew install sdl2 sdl_mixer 

💭 If you use Cocoa framework on macOS, please uncomment the line 276 to 278 in FindSDL2.cmake file to use it.

🚀 Usage

Run the following commands in your terminal to be able to compile and run the game :

git clone git@github.com:Livl-Corporation/livl-pacman.git
cd livl-pacman
mkdir build
cd build
cmake ..
make
./Pacman

🎮 How to Play

• ⬆️ Move Up
• ⬇️ Move Down
• ⬅️ Move Left
• ➡️ Move Right
• P Pause

📝 Pac-Man Rules

• Eat all the dots to win
• Avoid the ghosts
• Eat the big dots to eat the ghosts
• Eat the fruits to get more points
• Eat the ghosts to get more points
• You have 3 lives
• When you eat all the dots, you go to the next round

⚠️ Potential sound latency issues

If you’re running this game on Windows Subsystem for Linux (WSL), you may experience some latency issues with the sounds. This is due to the fact that WSL is an emulation layer for running Linux applications on Windows, and as such, it may not provide the same level of performance as running natively on Linux or Windows. If you’re experiencing latency issues, you might want to restart the game one few more times, or try running the game natively on Linux or Windows to see if that improves the latency.

🧍🏽Project team

@FranckG28	@jvondermarck
Franck Gutmann	Julien Von Der Marck

📝 License

This project is licensed under the MIT License - see the LICENSE.md file for details. © 2023 Livl Corporation.