zordzman-plus-plus
Dependencies
The client uses SDL and other SDL libraries. The server requires none of those dependencies to be present.
It uses json11 for parsing JSON, cppformat for formatting, and hash-library for hashing and base64 for base64 encoding & decoding.
All of the above libraries are located in common/extlib/<libname>/.
Our own written libraries are in common/<libname>.
SDL: https://libsdl.org/download-2.0.php (Required: 2.0.0 or greater)
SDL_Image: https://libsdl.org/projects/SDL_image/ (Required: 2.0.0 or greater)
SDL_Mixer: http://libsdl.org/projects/SDL_mixer/ (Required: 2.0.0 or greater)
SDL_TTF: http://libsdl.org/projects/SDL_ttf/ (Required: 2.0.0 or greater)
Building
There are build instructions for Mac and Linux below.
The networking layer as well as some build scripts use Python, and so Python 3 is required.
Mac OS X
Will be written soon.
Linux
Requirements: Python3, Pip, CMake
After cloning the repository, enter the root directory of the project and install formencode by executing the following:
pip install --user formencodeAfter formencode has been successfully installed, install zordzman's python packages by executing the following:
pip install --user -e .If installation of these packages was successful, you can now build zordzman. It is, however, recommended that you create an external build-zordzman-plus-plus directory.
mkdir ../build-zordzman-plus-plus
cd ../build-zordzman-plus-plus
cmake ../zordzman-plus-plus
makeTo run the game however, a resources.tar resource package is required, which
is created at build time. It will be found inside
build-zordzman-plus-plus/resources assuming you followed the steps above.
cp resources/resources.tar ../zordzman-plus-plus/resources.tarThe above line will copy the resource package into the correct location.
Windows
We are currently working towards windows support. See PR #24 and https://github.com/Holiverh/zordzman-plus-plus
Contributing
Anyone is welcome to contribute! Just make sure to read CONTRIBUTING.md before doing so!