R-TYPE Documentation

R-Type

This project aims to recreate the R-Type game and add a multiplayer mode to it. We had to implement a multi-threaded server using SFML::Network and a graphical client in SFML.

Made by : Romanie DE MEYER - Théo MILLASSEAU - Kevin ZILLIOX - Nykyta KUDRYA - Sylvian BURN

Dependencies

vcpkg is a submodule of this repository. If you wish to use vcpkg and did not clone this repository with –recurse-submodules, please run:

git submodule update --init

before continuing.

OR

Clone our repository with:

git clone --recurse-submodule https://github.com/EpitechPromo2025/B-CPP-500-STG-5-1-rtype-romanie.de-meyer.git

You will need to install vcpkg to build our game.

To install vcpkg, you will need to clone the repository somewhere on your computer using this command:

git clone https://github.com/Microsoft/vcpkg.git
cd vcpkg/

Then execute the following command:

./bootstrap-vcpkg.sh

Lastly, execute this command:

./vcpkg integrate install

Building

This project uses CMake, allowing it to be built with a large range of compilers.

This is an explanation of how you should build on Linux or Windows.

Linux:

You just have to execute this build.sh script, from the top directory of this repository (i.e. the folder containing this README file):

./build.sh

Windows:

There are several ways to build under windows

1. Launch with visual studio 2022

• On the top bar of visual studio 2022, click on Project then on Configure cache.
• Then on the top bar, click on Build then on Build all _(if this isn't available close and re-open VS then you should be able to build)_
• You will now find our binaries in the file explorer.

1. If you are using vcpkg (this will automatically install all necessary dependencies).

   cmake -B build "-DCMAKE_TOOLCHAIN_FILE=./vcpkg/scripts/buildsystems/vcpkg.cmake"

   You can then compile the project with this command (again, from the top directory of this repository):

   cmake --build build

2. Other

cd build
nmake

UML

ECS\ Network\ Doxygen

You can find more informations about the rtype in the wiki.

Have fun !