R-Type: Reborn

R-Type: Reborn is a modern reimagining of the classic arcade shoot 'em up, combining nostalgic gameplay with new features and enhancements.

This project is divided into two key components:

• Stellar Forge : The game engine powering R-Type: Reborn.
• Orion Editor: The game editor used to create and modify game levels and assets.

Table of Contents

• Project Purpose
• Dependencies & Requirements
• Supported Platforms
• Build Instructions
• Documentation
• Authors & Contact
• Useful Links
• Quick Start

Project Purpose

Welcome to R-Type: Reborn, a project developed as part of the Advanced C++ knowledge unit at EPITECH. This initiative introduces networked video game development while pushing the boundaries of advanced programming techniques and promoting best practices in software engineering.

Our goal is to create a multithreaded server and a graphical client for the iconic R-Type game, using a game engine designed entirely by us.

Through R-Type: Reborn, we aim to offer a modern take on a classic game while applying cutting-edge C++ techniques in a networked gaming environment.

The purpose of R-Type: Reborn is also to modernize the classic R-Type experience, bringing new graphics, levels, and game mechanics while maintaining the core gameplay that made the original famous. This project also serves as a demonstration of the Stellar Forge engine and Orion Editor.

Dependencies & Requirements

To build and run the project, you will need:

• C++ compiler supporting C++17 or later
• SFML (Simple and Fast Multimedia Library) for graphics, audio and input handling
• CMake for building the project
• GLM (OpenGL Mathematics) for vector and matrix operations
• Conan for managing dependencies

Install the dependencies using the package manager for your platform, or refer to the official documentation for each tool.

Supported Platforms

• Windows 10+
• Linux (Fedora, Ubuntu, etc.)

Build Instructions

To build R-Type: Reborn, follow these steps:

Note: These instructions are used to recompile the project from source. If you just want to run the game without compiling it see the Quick Start section.

Windows

1. Clone the repository to your local machine.
2. Open a terminal and navigate to the project directory.
3. Launch the following commands:

./build-windows.ps1

4. Accept the installation of the dependencies.
5. You can run the project by launching the executable in the build directory or by running the r-type_client and r-type_server executables at the root of the project.

Linux

1. Clone the repository to your local machine.
2. Open a terminal and navigate to the project directory.
3. Launch the following commands: (You need to have sudo rights)

sudo ./build-linux.sh

4. Accept the installation of the dependencies.
5. You can run the project by launching the executable in the build directory or by running the r-type_client and r-type_server executables at the root of the project.

Make release Instructions

To build R-Type: Reborn, follow these steps:

windows

1. Clone the repository to your local machine.
2. folow the build instructions how to build
3. Launch the following commands:

./release-windows.ps1

4. The release will be in the build directory.
5. You can run the project by launching the executable in the build directory or by running the R-type-Reborn-version-Linux.rpm executable at the root of the project.

Linux

1. Clone the repository to your local machine.
2. folow the build instructions how to build
3. Launch the following commands:

sudo ./release-linux.sh

4. The release will be in the build directory.
5. You can run the project by launching the executable in the build directory or by running the R-type-Reborn-version-win64.exe executable at the root of the project.

Documentation

You can find the documentation for Stellar Forge in the R-Type: Reborn repository or in the Documentation repository. You can also find the documentation on the following website: Stellar Forge Documentation. If you have any questions or need help, feel free to reach out to the authors.

Authors & Contact

Marius PAIN

Aubane NOURRY

Simon GANIER-LOMBARD

Axel ECKENBERG

Landry GIGANT

Useful Links

• EPITECH
• Stellar Forge
• Orion Editor
• R-Type: Reborn
• R-Type: Reborn Wiki

Quick Start

Windows

1. Download the release package from the Releases page.
2. Launch the r-type-"release_version"-win64.exe file.
3. Follow the on-screen instructions to install the game.
4. Once installed, you can start the game by double-clicking the r-type_client.exe or r-type_server.exe files on your desktop.

Linux (Fedora)

1. Download the release package from the Releases page.
2. Launch the 'r-type-reborn.rpm' file.
3. Follow the on-screen instructions to install the game.
4. Once installed, you can start the game by launching the r-type_client or r-type_server executables in the folder where the game was installed. The installation path is usually /usr/local/bin/.
5. The server need the following arguments to run:

r-type_server <port_TCP> <port_UDP>

6. The client does not need any arguments to run.