R-Type

Description

The R-Type is an Epitech project whose goal is to replicate the famous r-type game with online multi-player capability.

More information about the project can be found here.

Documentation

The documentation for this project can be generated with Doxygen by using the following commands:

cd server
doxygen ./Doxyfile
cd ../client
doxygen ./Doxyfile
cd ..

You can then open the client documentation by opening client/docs/html/index.html and the server documentation by opening server/docs/html/index.html.

The rfc for the r-type binary protocol can be found here.

Install and run

Dependencies

• conan: for c++ dependencies
• cmake: to build the project

Windows

• msvc: compiler and linker (version Visual Studio 15 2017 used for this project)

Linux

• g++: compiler and linker

Install

Add the required conan remotes:

conan remote add conan-center https://api.bintray.com/conan/conan/conan-center -f
conan remote add epitech https://api.bintray.com/conan/epitech/public-conan -f
conan remote add bincrafters https://api.bintray.com/conan/bincrafters/public-conan -f

Then make a build folder and go into it:

mkdir build
cd build

Run conan to install all dependencies to your computer:

conan install .. --build missing

Then run CMake:

# Windows ONLY
cmake .. -G "Visual Studio 15 2017 Win64"
cmake --build . --config Release

# Linux ONLY
cmake .. -G "Unix Makefiles"
cmake --build . --config Release

To change the configuration change between Debug and Release

Build RFC

To build the RFC as HTMl or TXT you must use the script generate_rfc.sh

FAQ

CLion fails to load CMakeList.txt, why?

You need to go into your cmake-build-* folder and run conan install .. --build missing before using CLion.

Contributing

See CONTRIBUTING.md to get involved.

Authors

• Lilian Arago
• Titouan Pautier
• Etienne Guillet
• Julian Fräbel