R-Type Documentation

The R-Type project aims at developing a clone of the classic side-scrolling shoot 'em up arcade game called "R-Type." The project involves creating a server that will start the game, and a client that will be able to display the game. This version of R-Type is multiplayer and the game is developed using a custom engine of our own called Haze.

Prerequisites

Before you begin, ensure you have met the following requirements:

• cmake
• git

🚀 Getting Started

To install and launch R-Type, follow these steps:

1. Clone the github project

git clone https://github.com/votre-utilisateur/haze-engine.git

1. Download the dependenties

Linux/MacOS

git clone https://github.com/Microsoft/vcpkg.git
./vcpkg/bootstrap-vcpkg.sh
./vcpkg/vcpkg install

Windows

git clone https://github.com/Microsoft/vcpkg.git
.\vcpkg\bootstrap-vcpkg.bat
.\vcpkg\vcpkg install

[!warning] These commands must be executed at the root of this project

1. Create the build directory

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

1. Compile the project

cmake --build build

1. Execute the binaries

   ./build/r-type-server
   

   ./build/r-type-client [sfml/sdl]
   

📋 Documentation

Haze introduction

Game Engine

Protocol

Rtype

👤 Credits

Click on the images below to visit the GitHub profiles of our awesome contributors:

🛠️ Tools