R-TYPE

==========

Game Video Example:

Contributing Guidelines

- Documentation is mandatory for all new features and bug fixes.
- All new features and bug fixes must be covered by tests.
- Code must be formatted with clang-format with the provided .clang-format file.
- Commit messages must be formatted as well possible.
- UML diagrams are mandatory for all big changes.
- Documentation is generated with Doxygen.

Documentation about server development can be found in the documentation RFC can be found in the RFC docs Documentation about client development can be found in the documentation Documentation about the game engine can be found in the documentation

Building

- All dependencies must be downloaded with conan
- The project is built with cmake
- Minimum C++ standard is C++17
- The project is built with g++ on Linux and MSVC on Windows

Note: The binaries are built in the ${BUILD_FOLDER}/target directory.

Easy build (Unix)

Debug

./build.sh

You can add --fast to skip the cmake refresh.

Release

./build.sh --release

Easy build (Windows)

Debug

.\build.bat

You can add /fast to skip the cmake refresh.

Release

.\build.bat /release

Build the project (Unix):

mkdir build
cd build
cmake ..
cmake --build .

Note: The binaries are built in the build/target directory.

Build the project (Windows):

Generate the Visual Studio Solution with the provided CMAKE.