👽 R-Type 🚀

A horizontally scrolling shooter made with ECS

📋 Table of Contents

Click to reveal

• About
• Requirements
• Building
• Usage
• Documentation
• Authors

🔍 About

R-Type is a 3rd year Epitech project where a group of 4-6 students have to code an ersatz of the original horizontally scrolling shooter arcade video game from 1987 of the same name.

In the span of 2 months, the goal is to learn the ECS architectural pattern to code the game in C++ with an additional 2-4 players coop.

💻 Requirements

Supported operating systems:

• Windows (tested on Windows 10 Home 21H1 x64)
• Linux (tested on Ubuntu 2204 and Fedora 32)
• MacOS

Dependencies:

• Cmake 3.24+
• OpenGL

🔧 Building

Launch r-type.sh (linux/MacOS) or r-type.bat (Windows) to start the building of the project. It will automatically:

• Download/build the SFML
• Download/build Boost
• Build the r-type_client and r-type_server executables (.exe on Windows) using those libraries

You can also just download the installer from the release tab in github (created by running cpack in build/).

🎮 Usage

One person has to start r-type_server to be the server host and can also start r-type_client to be a player. The other players just have to start r-type_client on their end aswell.

📝 Documentation

A local html-based code documentation is available in the root doc/html folder (start with the index.html file).

A network protocol documentation is available in the root doc/networkProtocol folder.

A documentation for the map loader is available in the root doc/mapLoader folder.

🤝 Authors

Pierre HAMEL • Dorian AYOUL • Jean-Baptiste BROCHERIE • Pierre MAUGER • Xavier TONNELLIER