README.md

Project Sokoban

Authors:

• Arthur BARRAUX
• Dorian HAMDANI

The goal of this project is to recreate the game Sokoban using the C programming language.

Dependancies

You will need SDL2, python 3 and PIL installed to use the project.

Installation

To get the project, simply download the zip file, or clone the project using

cd existing_folder
git clone --recurse-submodules https://gitlab.isima.fr/dohamdani/project-sokoban.git

Running

To run the project, use the bash command make run to build and launch the program.

Other commands can be used to clean, build only and profile the project, as well as its documentation, and the project report :

Command	Description
make run	Run the project executable
make build	Build the executable
make textures	Convert PNG textures in Binary
make clean	Remove the executable and object files
make perf	Use valgrind to profile the project
make doc	Build the Doxygen documentation
make pdf	Build the LaTeX pdf report

Documentation

The Doxygen documentation can be found in the doc folder, and can be made using the make doc bash command.

Report

The report of this project is present in the report folder, and built using the make pdf command.

Optimisation

To decrease compilation time, you should use clang instead of gcc. To do so, just modify the Makefile and replace gcc by clang in the first variable CC.