Skip to content

Latest commit

 

History

History
55 lines (46 loc) · 1.48 KB

README.md

File metadata and controls

55 lines (46 loc) · 1.48 KB

Pacman

About

A turn-based game inspired by the original Pacman implemented in C++11 using ncurses. I encourage you to read the documentation before playing.

This project was a part of the Programming and Algorithmics 2 course at FIT CTU in Prague (English site here).

Getting started

Requirements

Setup

Clone the repository.

git clone https://github.com/hajekjiri/pacman.git

Building the project

Use

make compile

to compile and link all files.

Running the project

./pacman /path/to/config

An example configuration file can be found at examples/settings.cfg. You can run the game with this example using

make run

which is equivalent to

./pacman ./examples/settings.cfg

Documentation

Documentation can be generated using Doxygen and then accessed at doc/index.html.

make doc

Examples

Examples are located in the examples folder. Currently, there is one config file and a couple of maps that should give you an idea on how to build maps. Refer to the Doxygen-generated documentation for more information.

Cleaning up

Use

make clean

to clean up all unnecessary files, e.g. objects files, documentation, binaries etc.