Skip to content

Latest commit

 

History

History
156 lines (103 loc) · 7.44 KB

README.md

File metadata and controls

156 lines (103 loc) · 7.44 KB

R-Type

Linux Windows

C++ CMake GitHub Actions CodeCov


Table of Contents


Introduction

The goal of the Epitech R-Type project is to implement a multithreaded server and a graphical client for a game called R-Type, using an engine of our own design.

The project is composed of two parts: the server and the client, both in C++.

It uses three libraries:

  • SFML: The library used to display.
  • Boost: The library used to manage communication, threads and processes.
  • SQLite3: The library used to manage the storage.

Supported Platforms

The R-Type project is supported on Windows AND Linux !!


The Game

Story

...And that’s why we are there.

This story begins in 2442, at a time when humans successfully survived the 4th world war. But the consequences were terrible, every place on Earth was radioactive. To save humanity, geniuses from all over the world started to think together, to agree at the same point: they need to move.

After several studies about various places in space, every tiny bit of ground was hostile to earthlings. When the light of hope started to decline, five geniuses came out of nowhere to bring a new future for humanity. We called them by their team's name: “On est que 4 ;)”.

First, we have Lucas, a genius of networking, followed by Quentin master of ECS (Engine for Cruise Ship). Thomas is the team protector and Tom is the team’s pathfinder. Last one but not least, Nathan the... the one who is telling this story for you, dear reader.

Together they found a new planet, a new home, a place to live for humanity, the only one who was welcoming for weakened humans: Zelta. After spending weeks building the best ships for the team, they were ready to go. But none of them were expecting what was about to happen.


While making their way to Zelta, our team started to cross a new specie, like an alien who is shooting at a regular frequency but moving randomly. Beating them was not the hard part, learning that there are potentially others forms of intelligence in the space was.

All the members of the team gather to be prepared for the aliens. Each one of them started to feel fear, but they managed to stay focused until a new alien appeared. A huge form, blazing into space was rushing to them. Tom spaceship successfully takes the first damage but could not take all the others. Every member started crying in their ships with the first loss of the mission.

But they did not have time to cry, another wave was coming. Two groups of four mobs, shooting ice spikes through the space were aiming for the team. The only way of beating them was to shoot back but a shield was necessary. Thanks to Thomas, the other members could rest for a bit. Even if the team eliminated every alien, they could not celebrate because only three of them were left.

The following minutes were horribly calm, until the ECS master could not control his ship anymore. He was falling into void for no reason. Suddenly, huge flashes were coming from everywhere, with electrics alien attacking and rushing the team. We were hiding behind our falling mate to take down every piece of the worst species we have found.

From 5 strong men, they were reduced to 2 survivors, who were hoping to find a land somewhere. Making their way through space, hoping that every dangerous species has been killed.

And that is why we are there. In front of our survivors, at our despair, a boss appears. You need to help them, tell them how to move and when to shoot. You need to beat this boss for the sake of humanity! Good luck!


How to play ?

Prerequisites

To build our R-Type project, you will need CMake 3.17.0 Compiler, C++ 20 and Conan.

Launch the game


For developers

Build the program

On Linux :

  • You may execute the script build.sh or the following commands :
    cmake -B ./build -DCMAKE_BUILD_TYPE=Release
    cmake --build ./build

On Windows :

  • You may execute the script build.bat or the following commands :
    mkdir build
    cd build
    conan install .. --build=missing  -c tools.system.package_manager:mode=install -c tools.system.package_manager:sudo=True
    cd ..
    cmake -B ./build -DCMAKE_BUILD_TYPE=Release
    cmake --build ./build
    copy ".\Debug\r-type_server.exe" .
    copy ".\Debug\r-type_client.exe" .
    copy ".\Debug\r-type_room.exe" .
    copy ".\Debug\r-type_admin_panel.exe" .

Testing program

The tests are available on Linux. You may can test the code executing the script build_tests.sh or using with the following commands.

    rm -rf ./build
    cmake -B ./build -DCMAKE_BUILD_TYPE=Debug -DTESTING=ON
    cmake --build ./build
    cd ./build
    ctest --ouput-on-failure

Documentation

The code documentation is available here.
Additional documentation such as the protocols used or the database can be found here.


Thank for reading

Feel free to read the CONTRIBUTING.md.

Do not hesitate to contact any member for any questions or remarks. You can click on each following name.

Authors

Tom Duval-Mahe
Tom Duval-Mahe

ZQUEMA
Quentin Camilleri

osvegn
Thomas Prud'homme

31Nathan
Nathan Rousseau

LucasTesnier
Lucas Tesnier