Dungeon Battle 🦄

Software engineering project.

It is a small rogue-like game.

Configuration

If you need to change generation options or some in-game options, you can create or modify the files ./config.ini and data/game.ini. Their most accurate doc can be find on doxygen: config.ini, game.ini.

If you installed the game from the releases, theses files will be located at /usr/share/dungeon-battle/game.ini and ~/.dungeon-battle/config.ini.

Compiling

The project is written in C++14, in order to compile it you need:

• A C++ STL that supports at least C++14.
• The SFML library version 2.3.2 or more recent.

The project can be built on most Linux distributions and macOS. Building on Windows is not supported, though building in cygwin or bash on Windows should work fine.

Dependencies

You can install SFML on Debian distributions with the command:

apt-get install libsfml-dev

The supported compilers are g++ 5 and clang++ 4, or any later version.

On Ubuntu 16.04, g++ 5 can be installed with the command:

apt-get install g++

LLVM binaries for Debian and Ubuntu which include clang++ can also be found on their website.

You should also install GNU Make:

apt-get install make

Optional dependencies

Documentation is generated with doxygen and is required to make doc:

apt-get install doxygen

Some extra tests can be done by running make test and it requires cppcheck and cxxgen:

apt-get install cppcheck cxxgen

To execute the tests use make test:

make test     # Build tester and runs it
tests/test -v # Run the test again with extra informations

If you want to build packages you will need gzip, dpkg or fakeroot depending on which package you want to build:

apt-get install gzip dpkg fakeroot

then you can use make package-debian to make a debian package, make package-arch to make an ArchLinux package or make package-tar to make a gzip compressed archive.

Compilation

In order to compile the project, assuming you have all the dependencies mentioned above, you have to run the command:

make release

If the flag DPACKAGE is set, the program will be compiled to find its ressources in /usr/var/dungeon-battle

Publication

To publish the release, you need to add a tag on current commit:

git tag -a v1.4 -m "short title for version 1.4"
git push --tag

Documentation

An automatically generated documentation can be found on github pages.

You can also generate the documentation by running make doc, which requires doxygen.

Other informations

We explain how to start contributing to the project in CONTRIBUTING.md.

Some warning from the linter are listed on github pages.

Made by Jean-Baptiste Daval, Rémi Dupré, Garance Gourdel, Benjamin Graillot and Lucas Gréaux.

We thank gratefully Syia, tokiri and the Stradew valley community for their beautiful sprites : https://community.playstarbound.com/threads/syias-sprites-cats-pigs-chickens-bunnies-and-goats-3-14-update.108846/ https://community.playstarbound.com/threads/tokiris-pet-replacements-fox-wolf-red-panda-update-red-panda-finished.110263/