R-Type Project

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Versions
5. Technical documentation
6. Contact

About The Project

The R-Type project is a project of the 5th semester of the Programme Grande Ecole in Epitech.

Goal of the project

The goal of this project is to recreate the retro game of the same name, the R-Type.

The original part of the project is to create a cross-platform multiplayer game of the original R-Type game. It means that multiple players can connect and play together on the same level, regarding of their OS.

With this project, the goal is to make a real video game project : with an ECS structure, a professional organization...

(back to top)

Built With

The project is built with the following libraries :

• Boost Asio [1.83.0]
• SFML [2.6.1]

(back to top)

Getting Started

To start the project, you will need to install the project, build it and execute this. To do that, you will need to follow the below commands :

Prerequisites

Install the following dependencies

• vcpkg - vcpkg installation guide
• ninja - ninja installation guide
• cmake - cmake installation guide
• Visual Studio (if you are on windows) - Visual Studio installation guide

Installation

To install the project, you need to execute the following commands.

1. Clone the repo

   git clone https://github.com/Corent1P/R-Type.git

2. If you are on windows, exec the install.exe file

   .\build.bat

3. If you are on Linux, you need to exec the build.sh file

   ./build.sh

Once you've done all the previous steps, you should have if you are on windows a folder application where you will find two binaries (one for the server and one for the client). And if you are on Linux, you should have two executables files at the root of the project: r-type_server and r-type_client

(back to top)

Usage

To use our program, you will need to execute the binaries.

r-type_server

To have help for the server, you can execute the following command:

./r-type_server -h

or

./r-type_server --help

To start the server, you only have to execute the following command:

./r-type_server <portNumber>

portNumber is the port of your machine where the server will listen for client connections (by default 4242).

r-type_client

To have help for the client, you can execute the following command:

./r-type_client -h

or

./r-type_client --help

To start the client, you only have to execute the following command:

./r-type_client <serverAdress> <serverPort>

serverAdress and serverPort are respectively the adress (by default localhost) and the port (by default 4242) of the server where your client will connect.

(back to top)

Versions

• 1.0: Position and movement handling in server side
• 2.0: Shoot and ennemy spawn handling in server side
• 3.0: Implementation of levels and boss
• 4.0: Final release - Multiplayer game with items and powerups

(back to top)

Release (Windows only)

You can find the release of the project here.

• For Windows, you can execute the R-Type-Setup.exe file to install the project.
• For Linux, you can unzip the r-type.zip file to have the release repository.

(back to top)

Technical documentation

You can find the technical documentation of the project here.

(back to top)

Contact

Piqueto Corentin - corentin.piquet@epitech.eu

Rognon Xavier - xavier.rognon@epitech.eu

Ramstein Sacha - sacha.ramstein@epitech.eu

Grand Antoine - antoine.grand@epitech.eu

Jonathan Bantzhaffen - jonathan.bantzhaffen@epitech.eu

Project Link: https://github.com/Corent1P/R-Type.git

(back to top)